python: Do explicitly check if the next tag exists

[notmuch] / bindings / python / notmuch / message.py

diff --git a/bindings/python/notmuch/message.py b/bindings/python/notmuch/message.py
index 340c0b8b742be49dcd1123e7e22f66be8ad29cd3..435a05db3400225fa143c60b9ab9919c9a0f30ac 100644 (file)
--- a/bindings/python/notmuch/message.py
+++ b/bindings/python/notmuch/message.py
@@ -18,8 +18,8 @@ Copyright 2010 Sebastian Spaeth <Sebastian@SSpaeth.de>'
                Jesse Rosenthal <jrosenthal@jhu.edu>
 """
 
                Jesse Rosenthal <jrosenthal@jhu.edu>
 """
 

-        
-from ctypes import c_char_p, c_void_p, c_long, c_uint
+
+from ctypes import c_char_p, c_void_p, c_long, c_uint, c_int

 from datetime import date
 from notmuch.globals import nmlib, STATUS, NotmuchError, Enum
 from notmuch.tag import Tags
 from datetime import date
 from notmuch.globals import nmlib, STATUS, NotmuchError, Enum
 from notmuch.tag import Tags


@@ -31,56 +31,66 @@ try:
     import simplejson as json
 except ImportError:
     import json
     import simplejson as json
 except ImportError:
     import json

-#------------------------------------------------------------------------------
+
+

 class Messages(object):
     """Represents a list of notmuch messages
 
     This object provides an iterator over a list of notmuch messages
     (Technically, it provides a wrapper for the underlying
 class Messages(object):
     """Represents a list of notmuch messages
 
     This object provides an iterator over a list of notmuch messages
     (Technically, it provides a wrapper for the underlying

-    *notmuch_messages_t* structure). Do note that the underlying
-    library only provides a one-time iterator (it cannot reset the
-    iterator to the start). Thus iterating over the function will
-    "exhaust" the list of messages, and a subsequent iteration attempt
-    will raise a :exc:`NotmuchError` STATUS.NOT_INITIALIZED. Also
-    note, that any function that uses iteration will also
-    exhaust the messages. So both::
-
-      for msg in msgs: print msg 
-
-    as well as::
-
-       number_of_msgs = len(msgs)
-
-    will "exhaust" the Messages. If you need to re-iterate over a list of
-    messages you will need to retrieve a new :class:`Messages` object.
-
-    Things are not as bad as it seems though, you can store and reuse
-    the single Message objects as often as you want as long as you
-    keep the parent Messages object around. (Recall that due to
-    hierarchical memory allocation, all derived Message objects will
-    be invalid when we delete the parent Messages() object, even if it
-    was already "exhausted".) So this works::
+    *notmuch_messages_t* structure). Do note that the underlying library
+    only provides a one-time iterator (it cannot reset the iterator to
+    the start). Thus iterating over the function will "exhaust" the list
+    of messages, and a subsequent iteration attempt will raise a
+    :exc:`NotmuchError` STATUS.NOT_INITIALIZED. If you need to
+    re-iterate over a list of messages you will need to retrieve a new
+    :class:`Messages` object or cache your :class:`Message`\s in a list
+    via::
+
+       msglist = list(msgs)
+
+    You can store and reuse the single :class:`Message` objects as often
+    as you want as long as you keep the parent :class:`Messages` object
+    around. (Due to hierarchical memory allocation, all derived
+    :class:`Message` objects will be invalid when we delete the parent
+    :class:`Messages` object, even if it was already exhausted.) So
+    this works::

 
       db   = Database()
       msgs = Query(db,'').search_messages() #get a Messages() object
 
       db   = Database()
       msgs = Query(db,'').search_messages() #get a Messages() object

-      msglist = []
-      for m in msgs:
-         msglist.append(m)
-
-      # msgs is "exhausted" now and even len(msgs) will raise an exception.
-      # However it will be kept around until all retrieved Message() objects are
-      # also deleted. If you did e.g. an explicit del(msgs) here, the 
-      # following lines would fail.
-      
-      # You can reiterate over *msglist* however as often as you want. 
-      # It is simply a list with Message objects.
+      msglist = list(msgs)
+
+      # msgs is "exhausted" now and msgs.next() will raise an exception.
+      # However it will be kept alive until all retrieved Message()
+      # objects are also deleted. If you do e.g. an explicit del(msgs)
+      # here, the following lines would fail.
+
+      # You can reiterate over *msglist* however as often as you want.
+      # It is simply a list with :class:`Message`s.

 
       print (msglist[0].get_filename())
       print (msglist[1].get_filename())
       print (msglist[0].get_message_id())
 
       print (msglist[0].get_filename())
       print (msglist[1].get_filename())
       print (msglist[0].get_message_id())

+
+
+    As :class:`Message` implements both __hash__() and __cmp__(), it is
+    possible to make sets out of :class:`Messages` and use set
+    arithmetic (this happens in python and will of course be *much*
+    slower than redoing a proper query with the appropriate filters::
+
+        s1, s2 = set(msgs1), set(msgs2)
+        s.union(s2)
+        s1 -= s2
+        ...
+
+    Be careful when using set arithmetic between message sets derived
+    from different Databases (ie the same database reopened after
+    messages have changed). If messages have added or removed associated
+    files in the meantime, it is possible that the same message would be
+    considered as a different object (as it points to a different file).

     """
 
     """
 

-    #notmuch_tags_get
+    #notmuch_messages_get

     _get = nmlib.notmuch_messages_get
     _get.restype = c_void_p
 
     _get = nmlib.notmuch_messages_get
     _get.restype = c_void_p
 


@@ -101,7 +111,7 @@ class Messages(object):
              (ie :class:`Query`) these tags are derived from. It saves
              a reference to it, so we can automatically delete the db
              object once all derived objects are dead.
              (ie :class:`Query`) these tags are derived from. It saves
              a reference to it, so we can automatically delete the db
              object once all derived objects are dead.

-        :TODO: Make the iterator work more than once and cache the tags in 
+        :TODO: Make the iterator work more than once and cache the tags in

                the Python object.(?)
         """
         if msgs_p is None:
                the Python object.(?)
         """
         if msgs_p is None:


@@ -124,7 +134,7 @@ class Messages(object):
             raise NotmuchError(STATUS.NOT_INITIALIZED)
 
         # collect all tags (returns NULL on error)
             raise NotmuchError(STATUS.NOT_INITIALIZED)
 
         # collect all tags (returns NULL on error)

-        tags_p = Messages._collect_tags (self._msgs)
+        tags_p = Messages._collect_tags(self._msgs)

         #reset _msgs as we iterated over it and can do so only once
         self._msgs = None
 
         #reset _msgs as we iterated over it and can do so only once
         self._msgs = None
 


@@ -144,49 +154,28 @@ class Messages(object):
             self._msgs = None
             raise StopIteration
 
             self._msgs = None
             raise StopIteration
 

-        msg = Message(Messages._get (self._msgs), self)
+        msg = Message(Messages._get(self._msgs), self)

         nmlib.notmuch_messages_move_to_next(self._msgs)
         return msg
 
         nmlib.notmuch_messages_move_to_next(self._msgs)
         return msg
 

-    def __len__(self):
-        """len(:class:`Messages`) returns the number of contained messages
-
-        .. note:: As this iterates over the messages, we will not be able to 
-               iterate over them again! So this will fail::
-
-                 #THIS FAILS
-                 msgs = Database().create_query('').search_message()
-                 if len(msgs) > 0:              #this 'exhausts' msgs
-                     # next line raises NotmuchError(STATUS.NOT_INITIALIZED)!!!
-                     for msg in msgs: print msg
-
-               Most of the time, using the
-               :meth:`Query.count_messages` is therefore more
-               appropriate (and much faster). While not guaranteeing
-               that it will return the exact same number than len(),
-               in my tests it effectively always did so.
+    def __nonzero__(self):

         """
         """

-        if self._msgs is None:
-            raise NotmuchError(STATUS.NOT_INITIALIZED)
-
-        i=0
-        while nmlib.notmuch_messages_valid(self._msgs):
-            nmlib.notmuch_messages_move_to_next(self._msgs)
-            i += 1
-        self._msgs = None
-        return i
+        :return: True if there is at least one more thread in the
+            Iterator, False if not."""
+        return self._msgs is not None and \
+            nmlib.notmuch_messages_valid(self._msgs) > 0

 
     def __del__(self):
         """Close and free the notmuch Messages"""
         if self._msgs is not None:
 
     def __del__(self):
         """Close and free the notmuch Messages"""
         if self._msgs is not None:

-            nmlib.notmuch_messages_destroy (self._msgs)
+            nmlib.notmuch_messages_destroy(self._msgs)

 
     def print_messages(self, format, indent=0, entire_thread=False):
         """Outputs messages as needed for 'notmuch show' to sys.stdout
 
         :param format: A string of either 'text' or 'json'.
         :param indent: A number indicating the reply depth of these messages.
 
     def print_messages(self, format, indent=0, entire_thread=False):
         """Outputs messages as needed for 'notmuch show' to sys.stdout
 
         :param format: A string of either 'text' or 'json'.
         :param indent: A number indicating the reply depth of these messages.

-        :param entire_thread: A bool, indicating whether we want to output 
+        :param entire_thread: A bool, indicating whether we want to output

                        whole threads or only the matching messages.
         """
         if format.lower() == "text":
                        whole threads or only the matching messages.
         """
         if format.lower() == "text":


@@ -207,7 +196,7 @@ class Messages(object):
         # iterate through all toplevel messages in this thread
         for msg in self:
             # if not msg:
         # iterate through all toplevel messages in this thread
         for msg in self:
             # if not msg:

-            #     break 
+            #     break

             if not first_set:
                 sys.stdout.write(set_sep)
             first_set = False
             if not first_set:
                 sys.stdout.write(set_sep)
             first_set = False


@@ -234,16 +223,21 @@ class Messages(object):
             sys.stdout.write(set_end)
         sys.stdout.write(set_end)
 
             sys.stdout.write(set_end)
         sys.stdout.write(set_end)
 

-#------------------------------------------------------------------------------
+

 class Message(object):
     """Represents a single Email message
 
 class Message(object):
     """Represents a single Email message
 

-    Technically, this wraps the underlying *notmuch_message_t* structure.
+    Technically, this wraps the underlying *notmuch_message_t*
+    structure. A user will usually not create these objects themselves
+    but get them as search results.
+
+    As it implements :meth:`__cmp__`, it is possible to compare two
+    :class:`Message`\s using `if msg1 == msg2: ...`.

     """
 
     """notmuch_message_get_filename (notmuch_message_t *message)"""
     _get_filename = nmlib.notmuch_message_get_filename
     """
 
     """notmuch_message_get_filename (notmuch_message_t *message)"""
     _get_filename = nmlib.notmuch_message_get_filename

-    _get_filename.restype = c_char_p 
+    _get_filename.restype = c_char_p

 
     """return all filenames for a message"""
     _get_filenames = nmlib.notmuch_message_get_filenames
 
     """return all filenames for a message"""
     _get_filenames = nmlib.notmuch_message_get_filenames


@@ -255,7 +249,7 @@ class Message(object):
 
     """notmuch_message_get_message_id (notmuch_message_t *message)"""
     _get_message_id = nmlib.notmuch_message_get_message_id
 
     """notmuch_message_get_message_id (notmuch_message_t *message)"""
     _get_message_id = nmlib.notmuch_message_get_message_id

-    _get_message_id.restype = c_char_p 
+    _get_message_id.restype = c_char_p

 
     """notmuch_message_get_thread_id"""
     _get_thread_id = nmlib.notmuch_message_get_thread_id
 
     """notmuch_message_get_thread_id"""
     _get_thread_id = nmlib.notmuch_message_get_thread_id


@@ -275,6 +269,14 @@ class Message(object):
     _get_header = nmlib.notmuch_message_get_header
     _get_header.restype = c_char_p
 
     _get_header = nmlib.notmuch_message_get_header
     _get_header.restype = c_char_p
 

+    """notmuch_status_t ..._maildir_flags_to_tags (notmuch_message_t *)"""
+    _tags_to_maildir_flags = nmlib.notmuch_message_tags_to_maildir_flags
+    _tags_to_maildir_flags.restype = c_int
+
+    """notmuch_status_t ..._tags_to_maildir_flags (notmuch_message_t *)"""
+    _maildir_flags_to_tags = nmlib.notmuch_message_maildir_flags_to_tags
+    _maildir_flags_to_tags.restype = c_int
+

     #Constants: Flags that can be set/get with set_flag
     FLAG = Enum(['MATCH'])
 
     #Constants: Flags that can be set/get with set_flag
     FLAG = Enum(['MATCH'])
 


@@ -283,6 +285,7 @@ class Message(object):
         :param msg_p: A pointer to an internal notmuch_message_t
             Structure.  If it is `None`, we will raise an :exc:`NotmuchError`
             STATUS.NULL_POINTER.
         :param msg_p: A pointer to an internal notmuch_message_t
             Structure.  If it is `None`, we will raise an :exc:`NotmuchError`
             STATUS.NULL_POINTER.

+

         :param parent: A 'parent' object is passed which this message is
               derived from. We save a reference to it, so we can
               automatically delete the parent object once all derived
         :param parent: A 'parent' object is passed which this message is
               derived from. We save a reference to it, so we can
               automatically delete the parent object once all derived


@@ -294,12 +297,11 @@ class Message(object):
         #keep reference to parent, so we keep it alive
         self._parent = parent
 
         #keep reference to parent, so we keep it alive
         self._parent = parent
 

-

     def get_message_id(self):
         """Returns the message ID
     def get_message_id(self):
         """Returns the message ID

-        
+

         :returns: String with a message ID
         :returns: String with a message ID

-        :exception: :exc:`NotmuchError` STATUS.NOT_INITIALIZED if the message 
+        :exception: :exc:`NotmuchError` STATUS.NOT_INITIALIZED if the message

                     is not initialized.
         """
         if self._msg is None:
                     is not initialized.
         """
         if self._msg is None:


@@ -309,23 +311,24 @@ class Message(object):
     def get_thread_id(self):
         """Returns the thread ID
 
     def get_thread_id(self):
         """Returns the thread ID
 

-        The returned string belongs to 'message' will only be valid for as 
+        The returned string belongs to 'message' will only be valid for as

         long as the message is valid.
 
         long as the message is valid.
 

-        This function will not return None since Notmuch ensures that every
+        This function will not return `None` since Notmuch ensures that every

         message belongs to a single thread.
 
         :returns: String with a thread ID
         message belongs to a single thread.
 
         :returns: String with a thread ID

-        :exception: :exc:`NotmuchError` STATUS.NOT_INITIALIZED if the message 
+        :exception: :exc:`NotmuchError` STATUS.NOT_INITIALIZED if the message

                     is not initialized.
         """
         if self._msg is None:
             raise NotmuchError(STATUS.NOT_INITIALIZED)
 
                     is not initialized.
         """
         if self._msg is None:
             raise NotmuchError(STATUS.NOT_INITIALIZED)
 

-        return Message._get_thread_id (self._msg);
+        return Message._get_thread_id(self._msg)

 
     def get_replies(self):
 
     def get_replies(self):

-        """Gets all direct replies to this message as :class:`Messages` iterator
+        """Gets all direct replies to this message as :class:`Messages`
+        iterator

 
         .. note:: This call only makes sense if 'message' was
           ultimately obtained from a :class:`Thread` object, (such as
 
         .. note:: This call only makes sense if 'message' was
           ultimately obtained from a :class:`Thread` object, (such as


@@ -336,20 +339,20 @@ class Message(object):
           to :meth:`Query.search_messages`), then this function will
           return `None`.
 
           to :meth:`Query.search_messages`), then this function will
           return `None`.
 

-        :returns: :class:`Messages` or `None` if there are no replies to 
+        :returns: :class:`Messages` or `None` if there are no replies to

             this message.
             this message.

-        :exception: :exc:`NotmuchError` STATUS.NOT_INITIALIZED if the message 
+        :exception: :exc:`NotmuchError` STATUS.NOT_INITIALIZED if the message

                     is not initialized.
         """
         if self._msg is None:
             raise NotmuchError(STATUS.NOT_INITIALIZED)
 
                     is not initialized.
         """
         if self._msg is None:
             raise NotmuchError(STATUS.NOT_INITIALIZED)
 

-        msgs_p = Message._get_replies(self._msg);
+        msgs_p = Message._get_replies(self._msg)

 
         if msgs_p is None:
             return None
 
 
         if msgs_p is None:
             return None
 

-        return Messages(msgs_p,self)
+        return Messages(msgs_p, self)

 
     def get_date(self):
         """Returns time_t of the message date
 
     def get_date(self):
         """Returns time_t of the message date


@@ -360,7 +363,7 @@ class Message(object):
 
         :returns: A time_t timestamp.
         :rtype: c_unit64
 
         :returns: A time_t timestamp.
         :rtype: c_unit64

-        :exception: :exc:`NotmuchError` STATUS.NOT_INITIALIZED if the message 
+        :exception: :exc:`NotmuchError` STATUS.NOT_INITIALIZED if the message

                     is not initialized.
         """
         if self._msg is None:
                     is not initialized.
         """
         if self._msg is None:


@@ -369,7 +372,7 @@ class Message(object):
 
     def get_header(self, header):
         """Returns a message header
 
     def get_header(self, header):
         """Returns a message header

-        
+

         This returns any message header that is stored in the notmuch database.
         This is only a selected subset of headers, which is currently:
 
         This returns any message header that is stored in the notmuch database.
         This is only a selected subset of headers, which is currently:
 


@@ -381,7 +384,7 @@ class Message(object):
         :returns: The header value as string
         :exception: :exc:`NotmuchError`
 
         :returns: The header value as string
         :exception: :exc:`NotmuchError`
 

-                    * STATUS.NOT_INITIALIZED if the message 
+                    * STATUS.NOT_INITIALIZED if the message

                       is not initialized.
                     * STATUS.NULL_POINTER, if no header was found
         """
                       is not initialized.
                     * STATUS.NULL_POINTER, if no header was found
         """


@@ -389,7 +392,7 @@ class Message(object):
             raise NotmuchError(STATUS.NOT_INITIALIZED)
 
         #Returns NULL if any error occurs.
             raise NotmuchError(STATUS.NOT_INITIALIZED)
 
         #Returns NULL if any error occurs.

-        header = Message._get_header (self._msg, header)
+        header = Message._get_header(self._msg, header)

         if header == None:
             raise NotmuchError(STATUS.NULL_POINTER)
         return header
         if header == None:
             raise NotmuchError(STATUS.NULL_POINTER)
         return header


@@ -398,7 +401,7 @@ class Message(object):
         """Returns the file path of the message file
 
         :returns: Absolute file path & name of the message file
         """Returns the file path of the message file
 
         :returns: Absolute file path & name of the message file

-        :exception: :exc:`NotmuchError` STATUS.NOT_INITIALIZED if the message 
+        :exception: :exc:`NotmuchError` STATUS.NOT_INITIALIZED if the message

               is not initialized.
         """
         if self._msg is None:
               is not initialized.
         """
         if self._msg is None:


@@ -413,7 +416,7 @@ class Message(object):
         not necessarily have identical content."""
         if self._msg is None:
             raise NotmuchError(STATUS.NOT_INITIALIZED)
         not necessarily have identical content."""
         if self._msg is None:
             raise NotmuchError(STATUS.NOT_INITIALIZED)

-        
+

         files_p = Message._get_filenames(self._msg)
 
         return Filenames(files_p, self).as_generator()
         files_p = Message._get_filenames(self._msg)
 
         return Filenames(files_p, self).as_generator()


@@ -425,10 +428,10 @@ class Message(object):
         *Message.FLAG.MATCH* for those messages that match the
         query. This method allows us to get the value of this flag.
 
         *Message.FLAG.MATCH* for those messages that match the
         query. This method allows us to get the value of this flag.
 

-        :param flag: One of the :attr:`Message.FLAG` values (currently only 
+        :param flag: One of the :attr:`Message.FLAG` values (currently only

                      *Message.FLAG.MATCH*
         :returns: An unsigned int (0/1), indicating whether the flag is set.
                      *Message.FLAG.MATCH*
         :returns: An unsigned int (0/1), indicating whether the flag is set.

-        :exception: :exc:`NotmuchError` STATUS.NOT_INITIALIZED if the message 
+        :exception: :exc:`NotmuchError` STATUS.NOT_INITIALIZED if the message

               is not initialized.
         """
         if self._msg is None:
               is not initialized.
         """
         if self._msg is None:


@@ -438,12 +441,12 @@ class Message(object):
     def set_flag(self, flag, value):
         """Sets/Unsets a specific flag for this message
 
     def set_flag(self, flag, value):
         """Sets/Unsets a specific flag for this message
 

-        :param flag: One of the :attr:`Message.FLAG` values (currently only 
+        :param flag: One of the :attr:`Message.FLAG` values (currently only

                      *Message.FLAG.MATCH*
         :param value: A bool indicating whether to set or unset the flag.
 
         :returns: Nothing
                      *Message.FLAG.MATCH*
         :param value: A bool indicating whether to set or unset the flag.
 
         :returns: Nothing

-        :exception: :exc:`NotmuchError` STATUS.NOT_INITIALIZED if the message 
+        :exception: :exc:`NotmuchError` STATUS.NOT_INITIALIZED if the message

               is not initialized.
         """
         if self._msg is None:
               is not initialized.
         """
         if self._msg is None:


@@ -456,7 +459,7 @@ class Message(object):
         :returns: A :class:`Tags` iterator.
         :exception: :exc:`NotmuchError`
 
         :returns: A :class:`Tags` iterator.
         :exception: :exc:`NotmuchError`
 

-                      * STATUS.NOT_INITIALIZED if the message 
+                      * STATUS.NOT_INITIALIZED if the message

                         is not initialized.
                       * STATUS.NULL_POINTER, on error
         """
                         is not initialized.
                       * STATUS.NULL_POINTER, on error
         """


@@ -468,13 +471,22 @@ class Message(object):
             raise NotmuchError(STATUS.NULL_POINTER)
         return Tags(tags_p, self)
 
             raise NotmuchError(STATUS.NULL_POINTER)
         return Tags(tags_p, self)
 

-    def add_tag(self, tag):
+    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
         the notmuch library and is currently 200 bytes.
 
         :param tag: String with a 'tag' to be added.
         """Adds a tag to the given message
 
         Adds a tag to the current message. The maximal tag length is defined in
         the notmuch library and is currently 200 bytes.
 
         :param tag: String with a 'tag' to be added.

+
+        :param sync_maildir_flags: If notmuch configuration is set to do
+            this, add maildir flags corresponding to notmuch tags. See
+            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.
         :exception: :exc:`NotmuchError`. They have the following meaning:
         :returns: STATUS.SUCCESS if the tag was successfully added.
                   Raises an exception otherwise.
         :exception: :exc:`NotmuchError`. They have the following meaning:


@@ -482,10 +494,10 @@ class Message(object):
                   STATUS.NULL_POINTER
                     The 'tag' argument is NULL
                   STATUS.TAG_TOO_LONG
                   STATUS.NULL_POINTER
                     The 'tag' argument is NULL
                   STATUS.TAG_TOO_LONG

-                    The length of 'tag' is too long 
+                    The length of 'tag' is too long

                     (exceeds Message.NOTMUCH_TAG_MAX)
                   STATUS.READ_ONLY_DATABASE
                     (exceeds Message.NOTMUCH_TAG_MAX)
                   STATUS.READ_ONLY_DATABASE

-                    Database was opened in read-only mode so message cannot be 
+                    Database was opened in read-only mode so message cannot be

                     modified.
                   STATUS.NOT_INITIALIZED
                      The message has not been initialized.
                     modified.
                   STATUS.NOT_INITIALIZED
                      The message has not been initialized.


@@ -493,22 +505,32 @@ class Message(object):
         if self._msg is None:
             raise NotmuchError(STATUS.NOT_INITIALIZED)
 
         if self._msg is None:
             raise NotmuchError(STATUS.NOT_INITIALIZED)
 

-        status = nmlib.notmuch_message_add_tag (self._msg, tag)
+        status = nmlib.notmuch_message_add_tag(self._msg, tag)

 
 

-        if STATUS.SUCCESS == status:
-            # return on success
-            return status
+        # bail out on failure
+        if status != STATUS.SUCCESS:
+            raise NotmuchError(status)

 
 

-        raise NotmuchError(status)
+        if sync_maildir_flags:
+            self.tags_to_maildir_flags()
+        return STATUS.SUCCESS

 
 

-    def remove_tag(self, tag):
+    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
         will report success anyway.
 
         :param tag: String with a 'tag' to be removed.
         """Removes a tag from the given message
 
         If the message has no such tag, this is a non-operation and
         will report success anyway.
 
         :param tag: String with a 'tag' to be removed.

-        :returns: STATUS.SUCCESS if the tag was successfully removed or if 
+        :param sync_maildir_flags: If notmuch configuration is set to do
+            this, add maildir flags corresponding to notmuch tags. See
+            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.
                   Raises an exception otherwise.
         :exception: :exc:`NotmuchError`. They have the following meaning:
                   the message had no such tag.
                   Raises an exception otherwise.
         :exception: :exc:`NotmuchError`. They have the following meaning:


@@ -519,7 +541,7 @@ class Message(object):
                      The length of 'tag' is too long
                      (exceeds NOTMUCH_TAG_MAX)
                    STATUS.READ_ONLY_DATABASE
                      The length of 'tag' is too long
                      (exceeds NOTMUCH_TAG_MAX)
                    STATUS.READ_ONLY_DATABASE

-                     Database was opened in read-only mode so message cannot 
+                     Database was opened in read-only mode so message cannot

                      be modified.
                    STATUS.NOT_INITIALIZED
                      The message has not been initialized.
                      be modified.
                    STATUS.NOT_INITIALIZED
                      The message has not been initialized.


@@ -528,45 +550,57 @@ class Message(object):
             raise NotmuchError(STATUS.NOT_INITIALIZED)
 
         status = nmlib.notmuch_message_remove_tag(self._msg, tag)
             raise NotmuchError(STATUS.NOT_INITIALIZED)
 
         status = nmlib.notmuch_message_remove_tag(self._msg, tag)

+        # bail out on error
+        if status != STATUS.SUCCESS:
+            raise NotmuchError(status)

 
 

-        if STATUS.SUCCESS == status:
-            # return on success
-            return status
-
-        raise NotmuchError(status)
+        if sync_maildir_flags:
+            self.tags_to_maildir_flags()
+        return STATUS.SUCCESS

 
 

-    def remove_all_tags(self):
+    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.
 
         """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
+            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 tags were successfully removed.
                   Raises an exception otherwise.
         :exception: :exc:`NotmuchError`. They have the following meaning:
 
                    STATUS.READ_ONLY_DATABASE
         :returns: STATUS.SUCCESS if the tags were successfully removed.
                   Raises an exception otherwise.
         :exception: :exc:`NotmuchError`. They have the following meaning:
 
                    STATUS.READ_ONLY_DATABASE

-                     Database was opened in read-only mode so message cannot 
+                     Database was opened in read-only mode so message cannot

                      be modified.
                    STATUS.NOT_INITIALIZED
                      The message has not been initialized.
         """
         if self._msg is None:
             raise NotmuchError(STATUS.NOT_INITIALIZED)
                      be modified.
                    STATUS.NOT_INITIALIZED
                      The message has not been initialized.
         """
         if self._msg is None:
             raise NotmuchError(STATUS.NOT_INITIALIZED)

- 
+

         status = nmlib.notmuch_message_remove_all_tags(self._msg)
 
         status = nmlib.notmuch_message_remove_all_tags(self._msg)
 

-        if STATUS.SUCCESS == status:
-            # return on success
-            return status
+        # bail out on error
+        if status != STATUS.SUCCESS:
+            raise NotmuchError(status)

 
 

-        raise NotmuchError(status)
+        if sync_maildir_flags:
+            self.tags_to_maildir_flags()
+        return STATUS.SUCCESS

 
     def freeze(self):
         """Freezes the current state of 'message' within the database
 
 
     def freeze(self):
         """Freezes the current state of 'message' within the database
 

-        This means that changes to the message state, (via :meth:`add_tag`, 
-        :meth:`remove_tag`, and :meth:`remove_all_tags`), will not be 
+        This means that changes to the message state, (via :meth:`add_tag`,
+        :meth:`remove_tag`, and :meth:`remove_all_tags`), will not be

         committed to the database until the message is :meth:`thaw`ed.
 
         Multiple calls to freeze/thaw are valid and these calls will
         committed to the database until the message is :meth:`thaw`ed.
 
         Multiple calls to freeze/thaw are valid and these calls will


@@ -578,10 +612,11 @@ class Message(object):
         have a given set of tags might look like this::
 
           msg.freeze()
         have a given set of tags might look like this::
 
           msg.freeze()

-          msg.remove_all_tags()
+          msg.remove_all_tags(False)

           for tag in new_tags:
           for tag in new_tags:

-              msg.add_tag(tag)
+              msg.add_tag(tag, False)

           msg.thaw()
           msg.thaw()

+          msg.tags_to_maildir_flags()

 
         With freeze/thaw used like this, the message in the database is
         guaranteed to have either the full set of original tag values, or
 
         With freeze/thaw used like this, the message in the database is
         guaranteed to have either the full set of original tag values, or


@@ -597,14 +632,14 @@ class Message(object):
         :exception: :exc:`NotmuchError`. They have the following meaning:
 
                    STATUS.READ_ONLY_DATABASE
         :exception: :exc:`NotmuchError`. They have the following meaning:
 
                    STATUS.READ_ONLY_DATABASE

-                     Database was opened in read-only mode so message cannot 
+                     Database was opened in read-only mode so message cannot

                      be modified.
                    STATUS.NOT_INITIALIZED
                      The message has not been initialized.
         """
         if self._msg is None:
             raise NotmuchError(STATUS.NOT_INITIALIZED)
                      be modified.
                    STATUS.NOT_INITIALIZED
                      The message has not been initialized.
         """
         if self._msg is None:
             raise NotmuchError(STATUS.NOT_INITIALIZED)

- 
+

         status = nmlib.notmuch_message_freeze(self._msg)
 
         if STATUS.SUCCESS == status:
         status = nmlib.notmuch_message_freeze(self._msg)
 
         if STATUS.SUCCESS == status:


@@ -616,7 +651,7 @@ class Message(object):
     def thaw(self):
         """Thaws the current 'message'
 
     def thaw(self):
         """Thaws the current 'message'
 

-        Thaw the current 'message', synchronizing any changes that may have 
+        Thaw the current 'message', synchronizing any changes that may have

         occurred while 'message' was frozen into the notmuch database.
 
         See :meth:`freeze` for an example of how to use this
         occurred while 'message' was frozen into the notmuch database.
 
         See :meth:`freeze` for an example of how to use this


@@ -631,15 +666,15 @@ class Message(object):
         :exception: :exc:`NotmuchError`. They have the following meaning:
 
                    STATUS.UNBALANCED_FREEZE_THAW
         :exception: :exc:`NotmuchError`. They have the following meaning:
 
                    STATUS.UNBALANCED_FREEZE_THAW

-                     An attempt was made to thaw an unfrozen message. 
-                     That is, there have been an unbalanced number of calls 
+                     An attempt was made to thaw an unfrozen message.
+                     That is, there have been an unbalanced number of calls

                      to :meth:`freeze` and :meth:`thaw`.
                    STATUS.NOT_INITIALIZED
                      The message has not been initialized.
         """
         if self._msg is None:
             raise NotmuchError(STATUS.NOT_INITIALIZED)
                      to :meth:`freeze` and :meth:`thaw`.
                    STATUS.NOT_INITIALIZED
                      The message has not been initialized.
         """
         if self._msg is None:
             raise NotmuchError(STATUS.NOT_INITIALIZED)

- 
+

         status = nmlib.notmuch_message_thaw(self._msg)
 
         if STATUS.SUCCESS == status:
         status = nmlib.notmuch_message_thaw(self._msg)
 
         if STATUS.SUCCESS == status:


@@ -648,21 +683,73 @@ class Message(object):
 
         raise NotmuchError(status)
 
 
         raise NotmuchError(status)
 

-

     def is_match(self):
         """(Not implemented)"""
         return self.get_flag(Message.FLAG.MATCH)
 
     def is_match(self):
         """(Not implemented)"""
         return self.get_flag(Message.FLAG.MATCH)
 

+    def tags_to_maildir_flags(self):
+        """Synchronize notmuch tags to file Maildir flags
+
+              'D' if the message has the "draft" tag
+              'F' if the message has the "flagged" tag
+              'P' if the message has the "passed" tag
+              'R' if the message has the "replied" tag
+              'S' if the message does not have the "unread" tag
+
+        Any existing flags unmentioned in the list above will be
+        preserved in the renaming.
+
+        Also, if this filename is in a directory named "new", rename it
+        to be within the neighboring directory named "cur".
+
+        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."""
+        if self._msg is None:
+            raise NotmuchError(STATUS.NOT_INITIALIZED)
+        status = Message._tags_to_maildir_flags(self._msg)
+
+    def maildir_flags_to_tags(self):
+        """Synchronize file Maildir flags to notmuch tags
+
+            Flag    Action if present
+            ----    -----------------
+            'D'     Adds the "draft" tag to the message
+            'F'     Adds the "flagged" tag to the message
+            'P'     Adds the "passed" tag to the message
+            'R'     Adds the "replied" tag to the message
+            'S'     Removes the "unread" tag from the message
+
+        For each flag that is not present, the opposite action
+        (add/remove) is performed for the corresponding tags.  If there
+        are multiple filenames associated with this message, the flag is
+        considered present if it appears in one or more filenames. (That
+        is, the flags from the multiple filenames are combined with the
+        logical OR operator.)
+
+        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."""
+        if self._msg is None:
+            raise NotmuchError(STATUS.NOT_INITIALIZED)
+        status = Message._tags_to_maildir_flags(self._msg)
+
+    def __repr__(self):
+        """Represent a Message() object by str()"""
+        return self.__str__()
+

     def __str__(self):
         """A message() is represented by a 1-line summary"""
         msg = {}
         msg['from'] = self.get_header('from')
         msg['tags'] = str(self.get_tags())
         msg['date'] = date.fromtimestamp(self.get_date())
     def __str__(self):
         """A message() is represented by a 1-line summary"""
         msg = {}
         msg['from'] = self.get_header('from')
         msg['tags'] = str(self.get_tags())
         msg['date'] = date.fromtimestamp(self.get_date())

-        replies = self.get_replies()
-        msg['replies'] = len(replies) if replies is not None else -1
-        return "%(from)s (%(date)s) (%(tags)s) (%(replies)d) replies" % (msg)
-
+        return "%(from)s (%(date)s) (%(tags)s)" % (msg)

 
     def get_message_parts(self):
         """Output like notmuch show"""
 
     def get_message_parts(self):
         """Output like notmuch show"""


@@ -712,7 +799,7 @@ class Message(object):
             part_dict["content-type"] = cont_type
             # NOTE:
             # Now we emulate the current behaviour, where it ignores
             part_dict["content-type"] = cont_type
             # NOTE:
             # Now we emulate the current behaviour, where it ignores

-            # the html if there's a text representation. 
+            # the html if there's a text representation.

             #
             # This is being worked on, but it will be easier to fix
             # here in the future than to end up with another
             #
             # This is being worked on, but it will be easier to fix
             # here in the future than to end up with another


@@ -723,7 +810,7 @@ class Message(object):
             else:
                 if cont_type.lower() == "text/plain":
                     part_dict["content"] = msg.get_payload()
             else:
                 if cont_type.lower() == "text/plain":
                     part_dict["content"] = msg.get_payload()

-                elif (cont_type.lower() == "text/html" and 
+                elif (cont_type.lower() == "text/html" and

                       i == 0):
                     part_dict["content"] = msg.get_payload()
             body.append(part_dict)
                       i == 0):
                     part_dict["content"] = msg.get_payload()
             body.append(part_dict)


@@ -768,18 +855,18 @@ class Message(object):
         parts = format["body"]
         parts.sort(key=lambda x: x['id'])
         for p in parts:
         parts = format["body"]
         parts.sort(key=lambda x: x['id'])
         for p in parts:

-            if not p.has_key("filename"):
+            if not "filename" in p:

                 output += "\n\fpart{ "
                 output += "\n\fpart{ "

-                output += "ID: %d, Content-type: %s\n" % (p["id"], 
-                                                         p["content-type"])
-                if p.has_key("content"):
+                output += "ID: %d, Content-type: %s\n" % (p["id"],
+                                                          p["content-type"])
+                if "content" in p:

                     output += "\n%s\n" % p["content"]
                 else:
                     output += "Non-text part: %s\n" % p["content-type"]
                     output += "\n%s\n" % p["content"]
                 else:
                     output += "Non-text part: %s\n" % p["content-type"]

-                    output += "\n\fpart}"                    
+                    output += "\n\fpart}"

             else:
                 output += "\n\fattachment{ "
             else:
                 output += "\n\fattachment{ "

-                output += "ID: %d, Content-type:%s\n" % (p["id"], 
+                output += "ID: %d, Content-type:%s\n" % (p["id"],

                                                          p["content-type"])
                 output += "Attachment: %s\n" % p["filename"]
                 output += "\n\fattachment}\n"
                                                          p["content-type"])
                 output += "Attachment: %s\n" % p["filename"]
                 output += "\n\fattachment}\n"


@@ -789,7 +876,28 @@ class Message(object):
 
         return output
 
 
         return output
 

+    def __hash__(self):
+        """Implement hash(), so we can use Message() sets"""
+        file = self.get_filename()
+        if file is None:
+            return None
+        return hash(file)
+
+    def __cmp__(self, other):
+        """Implement cmp(), so we can compare Message()s
+
+        2 messages are considered equal if they point to the same
+        Message-Id and if they point to the same file names. If 2
+        Messages derive from different queries where some files have
+        been added or removed, the same messages would not be considered
+        equal (as they do not point to the same set of files
+        any more)."""
+        res = cmp(self.get_message_id(), other.get_message_id())
+        if res:
+            res = cmp(list(self.get_filenames()), list(other.get_filenames()))
+        return res
+

     def __del__(self):
         """Close and free the notmuch Message"""
         if self._msg is not None:
     def __del__(self):
         """Close and free the notmuch Message"""
         if self._msg is not None:

-            nmlib.notmuch_message_destroy (self._msg)
+            nmlib.notmuch_message_destroy(self._msg)