+
+
+#------------------------------------------------------------------------------
+class Messages(object):
+ """Wrapper around notmuch_messages_t"""
+
+ #notmuch_tags_get
+ _get = nmlib.notmuch_messages_get
+ _get.restype = c_void_p
+
+ _collect_tags = nmlib.notmuch_messages_collect_tags
+ _collect_tags.restype = c_void_p
+
+ def __init__(self, msgs_p, parent=None):
+ """
+ msg_p is a pointer to an notmuch_messages_t Structure. If it is None,
+ we will raise an NotmuchError(STATUS.NULL_POINTER).
+
+ If passed the parent query this Messages() is derived from, it saves a
+ reference to it, so we can automatically delete the parent query object
+ once all derived objects are dead.
+
+ Messages() provides an iterator over all contained Message()s.
+ However, you will only be able to iterate over it once,
+ because the underlying C function only allows iterating once.
+ #TODO: make the iterator work more than once and cache the tags in
+ the Python object.
+ """
+ if msgs_p is None:
+ NotmuchError(STATUS.NULL_POINTER)
+
+ self._msgs = msgs_p
+ #store parent, so we keep them alive as long as self is alive
+ self._parent = parent
+ logging.debug("Inited Messages derived from %s" %(str(parent)))
+
+ def collect_tags(self):
+ """ return the Tags() belonging to the messages
+
+ Do note that collect_tags will iterate over the messages and
+ therefore will not allow further iterationsl
+ Raises NotmuchError(STATUS.NOT_INITIALIZED) if not inited
+ """
+ if self._msgs is None:
+ raise NotmuchError(STATUS.NOT_INITIALIZED)
+
+ # collect all tags (returns NULL on error)
+ tags_p = Messages._collect_tags (self._msgs)
+ #reset _msgs as we iterated over it and can do so only once
+ self._msgs = None
+
+ if tags_p == None:
+ raise NotmuchError(STATUS.NULL_POINTER)
+ return Tags(tags_p, self)
+
+ def __iter__(self):
+ """ Make Messages an iterator """
+ return self
+
+ def next(self):
+ if self._msgs is None:
+ raise NotmuchError(STATUS.NOT_INITIALIZED)
+
+ if not nmlib.notmuch_messages_valid(self._msgs):
+ self._msgs = None
+ raise StopIteration
+
+ msg = Message(Messages._get (self._msgs), self)
+ nmlib.notmuch_messages_move_to_next(self._msgs)
+ return msg
+
+ def __len__(self):
+ """ Returns the number of contained messages
+
+ :note: As this iterates over the messages, we will not be able to
+ iterate over them again (as in retrieve them)!
+ """
+ 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
+
+
+
+ def __del__(self):
+ """Close and free the notmuch Messages"""
+ if self._msgs is not None:
+ logging.debug("Freeing the Messages now")
+ nmlib.notmuch_messages_destroy (self._msgs)
+
+
+#------------------------------------------------------------------------------
+class Message(object):
+ """Wrapper around notmuch_message_t"""
+
+ """notmuch_message_get_filename (notmuch_message_t *message)"""
+ _get_filename = nmlib.notmuch_message_get_filename
+ _get_filename.restype = c_char_p
+ """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
+
+ """notmuch_message_get_tags (notmuch_message_t *message)"""
+ _get_tags = nmlib.notmuch_message_get_tags
+ _get_tags.restype = c_void_p
+
+ _get_date = nmlib.notmuch_message_get_date
+ _get_date.restype = c_uint64
+
+ _get_header = nmlib.notmuch_message_get_header
+ _get_header.restype = c_char_p
+
+ def __init__(self, msg_p, parent=None):
+ """
+ msg_p is a pointer to an notmuch_message_t Structure. If it is None,
+ we will raise an NotmuchError(STATUS.NULL_POINTER).
+
+ Is 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 objects are dead.
+ """
+ if msg_p is None:
+ NotmuchError(STATUS.NULL_POINTER)
+ self._msg = msg_p
+ #keep reference to parent, so we keep it alive
+ self._parent = parent
+ logging.debug("Inited Message derived from %s" %(str(parent)))
+
+
+ def get_message_id(self):
+ """ return the msg id
+
+ Raises NotmuchError(STATUS.NOT_INITIALIZED) if not inited
+ """
+ if self._msg is None:
+ raise NotmuchError(STATUS.NOT_INITIALIZED)
+ return Message._get_message_id(self._msg)
+
+ def get_date(self):
+ """returns time_t of the message date
+
+ For the original textual representation of the Date header from the
+ message call notmuch_message_get_header() with a header value of
+ "date".
+ Raises NotmuchError(STATUS.NOT_INITIALIZED) if not inited
+ """
+ if self._msg is None:
+ raise NotmuchError(STATUS.NOT_INITIALIZED)
+ return Message._get_date(self._msg)
+
+ def get_header(self, header):
+ """ TODO document me"""
+ if self._msg is None:
+ raise NotmuchError(STATUS.NOT_INITIALIZED)
+
+ #Returns NULL if any error occurs.
+ header = Message._get_header (self._msg, header)
+ if header == None:
+ raise NotmuchError(STATUS.NULL_POINTER)
+ return header
+
+ def get_filename(self):
+ """ return the msg filename
+
+ Raises NotmuchError(STATUS.NOT_INITIALIZED) if not inited
+ """
+ if self._msg is None:
+ raise NotmuchError(STATUS.NOT_INITIALIZED)
+ return Message._get_filename(self._msg)
+
+ def get_tags(self):
+ """ return the msg tags
+
+ Raises NotmuchError(STATUS.NOT_INITIALIZED) if not inited
+ Raises NotmuchError(STATUS.NULL_POINTER) on error.
+ """
+ if self._msg is None:
+ raise NotmuchError(STATUS.NOT_INITIALIZED)
+
+ tags_p = Message._get_tags(self._msg)
+ if tags_p == None:
+ raise NotmuchError(STATUS.NULL_POINTER)
+ return Tags(tags_p, self)
+
+ 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())
+ return "%(from)s (%(date)s) (%(tags)s)" % (msg)
+
+ def format_as_text(self):
+ """ Output like notmuch show """
+ return str(self)
+
+ def __del__(self):
+ """Close and free the notmuch Message"""
+ if self._msg is not None:
+ logging.debug("Freeing the Message now")
+ nmlib.notmuch_message_destroy (self._msg)
projects / notmuch / blobdiff