X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=bindings%2Fpython%2Fnotmuch%2Fmessage.py;h=763d2c6827b6f6e3243c98a9af4ca25ee9aaf254;hp=68de555248082efd58f0f7d8554652204c9124d6;hb=76399e5f7340e2fefccbd294227976b06ae36e17;hpb=dd544f5dc6b9fd8b034db2d1bc266edc553097c2 diff --git a/bindings/python/notmuch/message.py b/bindings/python/notmuch/message.py index 68de5552..763d2c68 100644 --- a/bindings/python/notmuch/message.py +++ b/bindings/python/notmuch/message.py @@ -470,7 +470,7 @@ class Message(object): raise NotmuchError(STATUS.NULL_POINTER) return Tags(tags_p, self) - def add_tag(self, tag, sync_maildir_flags=True): + def add_tag(self, tag, sync_maildir_flags=False): """Adds a tag to the given message Adds a tag to the current message. The maximal tag length is defined in @@ -480,11 +480,11 @@ class Message(object): :param sync_maildir_flags: If notmuch configuration is set to do this, add maildir flags corresponding to notmuch tags. See - :meth:`tags_to_maildir_flags`. Use False if you want to - add/remove many tags on a message without having to - physically rename the file every time. Do note, that this - will do nothing when a message is frozen, as tag changes - will not be committed to the database yet. + underlying method :meth:`tags_to_maildir_flags`. Use False + if you want to add/remove many tags on a message without + having to physically rename the file every time. Do note, + that this will do nothing when a message is frozen, as tag + changes will not be committed to the database yet. :returns: STATUS.SUCCESS if the tag was successfully added. Raises an exception otherwise. @@ -514,7 +514,7 @@ class Message(object): self.tags_to_maildir_flags() return STATUS.SUCCESS - def remove_tag(self, tag, sync_maildir_flags=True): + def remove_tag(self, tag, sync_maildir_flags=False): """Removes a tag from the given message If the message has no such tag, this is a non-operation and @@ -523,11 +523,11 @@ class Message(object): :param tag: String with a 'tag' to be removed. :param sync_maildir_flags: If notmuch configuration is set to do this, add maildir flags corresponding to notmuch tags. See - :meth:`tags_to_maildir_flags`. Use False if you want to - add/remove many tags on a message without having to - physically rename the file every time. Do note, that this - will do nothing when a message is frozen, as tag changes - will not be committed to the database yet. + underlying method :meth:`tags_to_maildir_flags`. Use False + if you want to add/remove many tags on a message without + having to physically rename the file every time. Do note, + that this will do nothing when a message is frozen, as tag + changes will not be committed to the database yet. :returns: STATUS.SUCCESS if the tag was successfully removed or if the message had no such tag. @@ -559,12 +559,13 @@ class Message(object): - def remove_all_tags(self, sync_maildir_flags=True): + def remove_all_tags(self, sync_maildir_flags=False): """Removes all tags from the given message. See :meth:`freeze` for an example showing how to safely replace tag values. + :param sync_maildir_flags: If notmuch configuration is set to do this, add maildir flags corresponding to notmuch tags. See :meth:`tags_to_maildir_flags`. Use False if you want to @@ -703,8 +704,9 @@ class Message(object): Also, if this filename is in a directory named "new", rename it to be within the neighboring directory named "cur". - Usually, you do not need to call this manually as - tag changing methods should be implicitly calling it. + Do note that calling this method while a message is frozen might + not work yet, as the modified tags have not been committed yet + to the database. :returns: a :class:`STATUS`. In short, you want to see notmuch.STATUS.SUCCESS here. See there for details.""" @@ -730,8 +732,8 @@ class Message(object): is, the flags from the multiple filenames are combined with the logical OR operator.) - Usually, you do not need to call this manually as - :meth:`Database.add_message` implicitly calls it. + As a convenience, you can set the sync_maildir_flags parameter in + :meth:`Database.add_message` to implicitly call this. :returns: a :class:`STATUS`. In short, you want to see notmuch.STATUS.SUCCESS here. See there for details."""