2 from ctypes import c_int, c_char_p, c_void_p, c_uint, c_uint64, c_bool, byref
3 from cnotmuch.globals import nmlib, STATUS, NotmuchError, Enum
5 from datetime import date
7 class Database(object):
8 """Represents a notmuch database (wraps notmuch_database_t)
10 .. note:: Do remember that as soon as we tear down this object,
11 all underlying derived objects such as queries, threads,
12 messages, tags etc will be freed by the underlying library
13 as well. Accessing these objects will lead to segfaults and
14 other unexpected behavior. See above for more details.
17 """Class attribute to cache user's default database"""
19 MODE = Enum(['READ_ONLY','READ_WRITE'])
20 """Constants: Mode in which to open the database"""
22 """notmuch_database_get_path (notmuch_database_t *database)"""
23 _get_path = nmlib.notmuch_database_get_path
24 _get_path.restype = c_char_p
26 """notmuch_database_get_version"""
27 _get_version = nmlib.notmuch_database_get_version
28 _get_version.restype = c_uint
30 """notmuch_database_open (const char *path, notmuch_database_mode_t mode)"""
31 _open = nmlib.notmuch_database_open
32 _open.restype = c_void_p
34 """ notmuch_database_find_message """
35 _find_message = nmlib.notmuch_database_find_message
36 _find_message.restype = c_void_p
38 """notmuch_database_get_all_tags (notmuch_database_t *database)"""
39 _get_all_tags = nmlib.notmuch_database_get_all_tags
40 _get_all_tags.restype = c_void_p
42 """ notmuch_database_create(const char *path):"""
43 _create = nmlib.notmuch_database_create
44 _create.restype = c_void_p
46 def __init__(self, path=None, create=False, mode= 0):
47 """If *path* is *None*, we will try to read a users notmuch
48 configuration and use his configured database. The location of the
49 configuration file can be specified through the environment variable
50 *NOTMUCH_CONFIG*, falling back to the default `~/.notmuch-config`.
52 If *create* is `True`, the database will always be created in
53 :attr:`MODE`.READ_WRITE mode. Default mode for opening is READ_ONLY.
55 :param path: Directory to open/create the database in (see
56 above for behavior if `None`)
57 :type path: `str` or `None`
58 :param create: Pass `False` to open an existing, `True` to create a new
61 :param mode: Mode to open a database in. Is always
62 :attr:`MODE`.READ_WRITE when creating a new one.
63 :type mode: :attr:`MODE`
65 :exception: :exc:`NotmuchError` in case of failure.
69 # no path specified. use a user's default database
70 if Database._std_db_path is None:
71 #the following line throws a NotmuchError if it fails
72 Database._std_db_path = self._get_user_default_db()
73 path = Database._std_db_path
80 def _verify_initialized_db(self):
81 """Raises a NotmuchError in case self._db is still None"""
83 raise NotmuchError(STATUS.NOT_INITIALIZED)
85 def create(self, path):
86 """Creates a new notmuch database
88 This function is used by __init__() and usually does not need
89 to be called directly. It wraps the underlying
90 *notmuch_database_create* function and creates a new notmuch
91 database at *path*. It will always return a database in
92 :attr:`MODE`.READ_WRITE mode as creating an empty database for
93 reading only does not make a great deal of sense.
95 :param path: A directory in which we should create the database.
98 :exception: :exc:`NotmuchError` in case of any failure
99 (after printing an error message on stderr).
101 if self._db is not None:
103 message="Cannot create db, this Database() already has an open one.")
105 res = Database._create(path, Database.MODE.READ_WRITE)
109 message="Could not create the specified database")
112 def open(self, path, mode= 0):
113 """Opens an existing database
115 This function is used by __init__() and usually does not need
116 to be called directly. It wraps the underlying
117 *notmuch_database_open* function.
119 :param status: Open the database in read-only or read-write mode
120 :type status: :attr:`MODE`
122 :exception: Raises :exc:`NotmuchError` in case
123 of any failure (after printing an error message on stderr).
126 res = Database._open(path, mode)
130 message="Could not open the specified database")
134 """Returns the file path of an open database
136 Wraps notmuch_database_get_path"""
137 # Raise a NotmuchError if not initialized
138 self._verify_initialized_db()
140 return Database._get_path(self._db)
142 def get_version(self):
143 """Returns the database format version
145 :returns: The database version as positive integer
146 :exception: :exc:`NotmuchError` with STATUS.NOT_INITIALIZED if
147 the database was not intitialized.
149 # Raise a NotmuchError if not initialized
150 self._verify_initialized_db()
152 return Database._get_version (self._db)
154 def needs_upgrade(self):
155 """Does this database need to be upgraded before writing to it?
157 If this function returns True then no functions that modify the
158 database (:meth:`add_message`, :meth:`add_tag`,
159 :meth:`Directory.set_mtime`, etc.) will work unless :meth:`upgrade`
160 is called successfully first.
162 :returns: `True` or `False`
163 :exception: :exc:`NotmuchError` with STATUS.NOT_INITIALIZED if
164 the database was not intitialized.
166 # Raise a NotmuchError if not initialized
167 self._verify_initialized_db()
169 return notmuch_database_needs_upgrade(self.db)
171 def add_message(self, filename):
172 """Adds a new message to the database
174 `filename` should be a path relative to the path of the open
175 database (see :meth:`get_path`), or else should be an absolute
176 filename with initial components that match the path of the
179 The file should be a single mail message (not a multi-message mbox)
180 that is expected to remain at its current location, since the
181 notmuch database will reference the filename, and will not copy the
182 entire contents of the file.
184 :returns: On success, we return
186 1) a :class:`Message` object that can be used for things
187 such as adding tags to the just-added message.
188 2) one of the following STATUS values:
191 Message successfully added to database.
192 STATUS.DUPLICATE_MESSAGE_ID
193 Message has the same message ID as another message already
194 in the database. The new filename was successfully added
195 to the message in the database.
197 :rtype: 2-tuple(:class:`Message`, STATUS)
199 :exception: Raises a :exc:`NotmuchError` with the following meaning.
200 If such an exception occurs, nothing was added to the database.
203 An error occurred trying to open the file, (such as
204 permission denied, or file not found, etc.).
205 STATUS.FILE_NOT_EMAIL
206 The contents of filename don't look like an email message.
207 STATUS.READ_ONLY_DATABASE
208 Database was opened in read-only mode so no message can
210 STATUS.NOT_INITIALIZED
211 The database has not been initialized.
213 # Raise a NotmuchError if not initialized
214 self._verify_initialized_db()
217 status = nmlib.notmuch_database_add_message(self._db,
221 if not status in [STATUS.SUCCESS,STATUS.DUPLICATE_MESSAGE_ID]:
222 raise NotmuchError(status)
224 #construct Message() and return
225 msg = Message(msg_p, self)
228 def remove_message(self, filename):
229 """Removes a message from the given notmuch database
231 Note that only this particular filename association is removed from
232 the database. If the same message (as determined by the message ID)
233 is still available via other filenames, then the message will
234 persist in the database for those filenames. When the last filename
235 is removed for a particular message, the database content for that
236 message will be entirely removed.
238 :returns: A STATUS.* value with the following meaning:
241 The last filename was removed and the message was removed
243 STATUS.DUPLICATE_MESSAGE_ID
244 This filename was removed but the message persists in the
245 database with at least one other filename.
247 :exception: Raises a :exc:`NotmuchError` with the following meaning.
248 If such an exception occurs, nothing was removed from the database.
250 STATUS.READ_ONLY_DATABASE
251 Database was opened in read-only mode so no message can be
253 STATUS.NOT_INITIALIZED
254 The database has not been initialized.
256 # Raise a NotmuchError if not initialized
257 self._verify_initialized_db()
259 status = nmlib.notmuch_database_remove_message(self._db,
262 def find_message(self, msgid):
263 """Returns a :class:`Message` as identified by its message ID
265 Wraps the underlying *notmuch_database_find_message* function.
267 :param msgid: The message ID
269 :returns: :class:`Message` or `None` if no message is found or if an
270 out-of-memory situation occurs.
271 :exception: :exc:`NotmuchError` with STATUS.NOT_INITIALIZED if
272 the database was not intitialized.
274 # Raise a NotmuchError if not initialized
275 self._verify_initialized_db()
277 msg_p = Database._find_message(self._db, msgid)
280 return Message(msg_p, self)
282 def get_all_tags(self):
283 """Returns :class:`Tags` with a list of all tags found in the database
285 :returns: :class:`Tags`
286 :execption: :exc:`NotmuchError` with STATUS.NULL_POINTER on error
288 # Raise a NotmuchError if not initialized
289 self._verify_initialized_db()
291 tags_p = Database._get_all_tags (self._db)
293 raise NotmuchError(STATUS.NULL_POINTER)
294 return Tags(tags_p, self)
296 def create_query(self, querystring):
297 """Returns a :class:`Query` derived from this database
299 This is a shorthand method for doing::
301 # Automatically frees the Database() when 'q' is deleted
303 q = Database(dbpath).create_query('from:"Biene Maja"')
305 # long version, which is functionally equivalent but will keep the
306 # Database in the 'db' variable around after we delete 'q':
308 db = Database(dbpath)
309 q = Query(db,'from:"Biene Maja"')
311 This function is a python extension and not in the underlying C API.
313 # Raise a NotmuchError if not initialized
314 self._verify_initialized_db()
316 return Query(self._db, querystring)
319 return "'Notmuch DB " + self.get_path() + "'"
322 """Close and free the notmuch database if needed"""
323 if self._db is not None:
324 logging.debug("Freeing the database now")
325 nmlib.notmuch_database_close(self._db)
327 def _get_user_default_db(self):
328 """ Reads a user's notmuch config and returns his db location
330 Throws a NotmuchError if it cannot find it"""
331 from ConfigParser import SafeConfigParser
332 config = SafeConfigParser()
333 conf_f = os.getenv('NOTMUCH_CONFIG',
334 os.path.expanduser('~/.notmuch-config'))
336 if not config.has_option('database','path'):
337 raise NotmuchError(message=
338 "No DB path specified and no user default found")
339 return config.get('database','path')
343 """Property returning a pointer to `notmuch_database_t` or `None`
345 This should normally not be needed by a user (and is not yet
346 guaranteed to remain stable in future versions).
350 #------------------------------------------------------------------------------
352 """Represents a search query on an opened :class:`Database`.
354 A query selects and filters a subset of messages from the notmuch
355 database we derive from.
357 Technically, it wraps the underlying *notmuch_query_t* struct.
359 .. note:: Do remember that as soon as we tear down this object,
360 all underlying derived objects such as threads,
361 messages, tags etc will be freed by the underlying library
362 as well. Accessing these objects will lead to segfaults and
363 other unexpected behavior. See above for more details.
366 SORT = Enum(['OLDEST_FIRST','NEWEST_FIRST','MESSAGE_ID'])
367 """Constants: Sort order in which to return results"""
369 """notmuch_query_create"""
370 _create = nmlib.notmuch_query_create
371 _create.restype = c_void_p
373 """notmuch_query_search_messages"""
374 _search_messages = nmlib.notmuch_query_search_messages
375 _search_messages.restype = c_void_p
378 """notmuch_query_count_messages"""
379 _count_messages = nmlib.notmuch_query_count_messages
380 _count_messages.restype = c_uint
382 def __init__(self, db, querystr):
384 :param db: An open database which we derive the Query from.
385 :type db: :class:`Database`
386 :param querystr: The query string for the message.
391 self.create(db, querystr)
393 def create(self, db, querystr):
394 """Creates a new query derived from a Database
396 This function is utilized by __init__() and usually does not need to
399 :param db: Database to create the query from.
400 :type db: :class:`Database`
401 :param querystr: The query string
404 :exception: :exc:`NotmuchError`
406 * STATUS.NOT_INITIALIZED if db is not inited
407 * STATUS.NULL_POINTER if the query creation failed
411 raise NotmuchError(STATUS.NOT_INITIALIZED)
412 # create reference to parent db to keep it alive
415 # create query, return None if too little mem available
416 query_p = Query._create(db.db_p, querystr)
418 NotmuchError(STATUS.NULL_POINTER)
419 self._query = query_p
421 def set_sort(self, sort):
422 """Set the sort order future results will be delivered in
424 Wraps the underlying *notmuch_query_set_sort* function.
426 :param sort: Sort order (see :attr:`Query.SORT`)
428 :exception: :exc:`NotmuchError` STATUS.NOT_INITIALIZED if query has not
431 if self._query is None:
432 raise NotmuchError(STATUS.NOT_INITIALIZED)
434 nmlib.notmuch_query_set_sort(self._query, sort)
436 def search_messages(self):
437 """Filter messages according to the query and return
438 :class:`Messages` in the defined sort order
440 Technically, it wraps the underlying
441 *notmuch_query_search_messages* function.
443 :returns: :class:`Messages`
444 :exception: :exc:`NotmuchError`
446 * STATUS.NOT_INITIALIZED if query is not inited
447 * STATUS.NULL_POINTER if search_messages failed
449 if self._query is None:
450 raise NotmuchError(STATUS.NOT_INITIALIZED)
452 msgs_p = Query._search_messages(self._query)
455 NotmuchError(STATUS.NULL_POINTER)
457 return Messages(msgs_p,self)
459 def count_messages(self):
460 """Estimate the number of messages matching the query
462 This function performs a search and returns Xapian's best
463 guess as to the number of matching messages. It is much faster
464 than performing :meth:`search_messages` and counting the
465 result with `len()` (although it always returned the same
466 result in my tests). Technically, it wraps the underlying
467 *notmuch_query_count_messages* function.
469 :returns: :class:`Messages`
470 :exception: :exc:`NotmuchError`
472 * STATUS.NOT_INITIALIZED if query is not inited
474 if self._query is None:
475 raise NotmuchError(STATUS.NOT_INITIALIZED)
477 return Query._count_messages(self._query)
480 """Close and free the Query"""
481 if self._query is not None:
482 logging.debug("Freeing the Query now")
483 nmlib.notmuch_query_destroy (self._query)
485 #------------------------------------------------------------------------------
487 """Represents a list of notmuch tags
489 This object provides an iterator over a list of notmuch tags. Do
490 note that the underlying library only provides a one-time iterator
491 (it cannot reset the iterator to the start). Thus iterating over
492 the function will "exhaust" the list of tags, and a subsequent
493 iteration attempt will raise a :exc:`NotmuchError`
494 STATUS.NOT_INITIALIZED. Also note, that any function that uses
495 iteration (nearly all) will also exhaust the tags. So both::
497 for tag in tags: print tag
501 number_of_tags = len(tags)
505 #str() iterates over all tags to construct a space separated list
508 will "exhaust" the Tags. If you need to re-iterate over a list of
509 tags you will need to retrieve a new :class:`Tags` object.
513 _get = nmlib.notmuch_tags_get
514 _get.restype = c_char_p
516 def __init__(self, tags_p, parent=None):
518 :param tags_p: A pointer to an underlying *notmuch_tags_t*
519 structure. These are not publically exposed, so a user
520 will almost never instantiate a :class:`Tags` object
521 herself. They are usually handed back as a result,
522 e.g. in :meth:`Database.get_all_tags`. *tags_p* must be
523 valid, we will raise an :exc:`NotmuchError`
524 (STATUS.NULL_POINTER) if it is `None`.
525 :type tags_p: :class:`ctypes.c_void_p`
526 :param parent: The parent object (ie :class:`Database` or
527 :class:`Message` these tags are derived from, and saves a
528 reference to it, so we can automatically delete the db object
529 once all derived objects are dead.
530 :TODO: Make the iterator optionally work more than once by
531 cache the tags in the Python object(?)
534 NotmuchError(STATUS.NULL_POINTER)
537 #save reference to parent object so we keep it alive
538 self._parent = parent
539 logging.debug("Inited Tags derived from %s" %(repr(parent)))
542 """ Make Tags an iterator """
546 if self._tags is None:
547 raise NotmuchError(STATUS.NOT_INITIALIZED)
549 if not nmlib.notmuch_tags_valid(self._tags):
553 tag = Tags._get (self._tags)
554 nmlib.notmuch_tags_move_to_next(self._tags)
558 """len(:class:`Tags`) returns the number of contained tags
560 .. note:: As this iterates over the tags, we will not be able
561 to iterate over them again (as in retrieve them)! If
562 the tags have been exhausted already, this will raise a
563 :exc:`NotmuchError` STATUS.NOT_INITIALIZED on
566 if self._tags is None:
567 raise NotmuchError(STATUS.NOT_INITIALIZED)
570 while nmlib.notmuch_tags_valid(self._msgs):
571 nmlib.notmuch_tags_move_to_next(self._msgs)
577 """The str() representation of Tags() is a space separated list of tags
579 .. note:: As this iterates over the tags, we will not be able
580 to iterate over them again (as in retrieve them)! If
581 the tags have been exhausted already, this will raise a
582 :exc:`NotmuchError` STATUS.NOT_INITIALIZED on
585 return " ".join(self)
588 """Close and free the notmuch tags"""
589 if self._tags is not None:
590 logging.debug("Freeing the Tags now")
591 nmlib.notmuch_tags_destroy (self._tags)
594 #------------------------------------------------------------------------------
595 class Messages(object):
596 """Represents a list of notmuch messages
598 This object provides an iterator over a list of notmuch messages
599 (Technically, it provides a wrapper for the underlying
600 *notmuch_messages_t* structure). Do note that the underlying
601 library only provides a one-time iterator (it cannot reset the
602 iterator to the start). Thus iterating over the function will
603 "exhaust" the list of messages, and a subsequent iteration attempt
604 will raise a :exc:`NotmuchError` STATUS.NOT_INITIALIZED. Also
605 note, that any function that uses iteration will also
606 exhaust the messages. So both::
608 for msg in msgs: print msg
612 number_of_msgs = len(msgs)
614 will "exhaust" the Messages. If you need to re-iterate over a list of
615 messages you will need to retrieve a new :class:`Messages` object.
617 Things are not as bad as it seems though, you can store and reuse
618 the single Message objects as often as you want as long as you
619 keep the parent Messages object around. (Recall that due to
620 hierarchical memory allocation, all derived Message objects will
621 be invalid when we delete the parent Messages() object, even if it
622 was already "exhausted".) So this works::
625 msgs = Query(db,'').search_messages() #get a Messages() object
630 # msgs is "exhausted" now and even len(msgs) will raise an exception.
631 # However it will be kept around until all retrieved Message() objects are
632 # also deleted. If you did e.g. an explicit del(msgs) here, the
633 # following lines would fail.
635 # You can reiterate over *msglist* however as often as you want.
636 # It is simply a list with Message objects.
638 print (msglist[0].get_filename())
639 print (msglist[1].get_filename())
640 print (msglist[0].get_message_id())
644 _get = nmlib.notmuch_messages_get
645 _get.restype = c_void_p
647 _collect_tags = nmlib.notmuch_messages_collect_tags
648 _collect_tags.restype = c_void_p
650 def __init__(self, msgs_p, parent=None):
652 :param msgs_p: A pointer to an underlying *notmuch_messages_t*
653 structure. These are not publically exposed, so a user
654 will almost never instantiate a :class:`Messages` object
655 herself. They are usually handed back as a result,
656 e.g. in :meth:`Query.search_messages`. *msgs_p* must be
657 valid, we will raise an :exc:`NotmuchError`
658 (STATUS.NULL_POINTER) if it is `None`.
659 :type msgs_p: :class:`ctypes.c_void_p`
660 :param parent: The parent object
661 (ie :class:`Query`) these tags are derived from. It saves
662 a reference to it, so we can automatically delete the db
663 object once all derived objects are dead.
664 :TODO: Make the iterator work more than once and cache the tags in
665 the Python object.(?)
668 NotmuchError(STATUS.NULL_POINTER)
671 #store parent, so we keep them alive as long as self is alive
672 self._parent = parent
673 logging.debug("Inited Messages derived from %s" %(str(parent)))
675 def collect_tags(self):
676 """Return the unique :class:`Tags` in the contained messages
678 :returns: :class:`Tags`
679 :exceptions: :exc:`NotmuchError` STATUS.NOT_INITIALIZED if not inited
681 .. note:: :meth:`collect_tags` will iterate over the messages and
682 therefore will not allow further iterations.
684 if self._msgs is None:
685 raise NotmuchError(STATUS.NOT_INITIALIZED)
687 # collect all tags (returns NULL on error)
688 tags_p = Messages._collect_tags (self._msgs)
689 #reset _msgs as we iterated over it and can do so only once
693 raise NotmuchError(STATUS.NULL_POINTER)
694 return Tags(tags_p, self)
697 """ Make Messages an iterator """
701 if self._msgs is None:
702 raise NotmuchError(STATUS.NOT_INITIALIZED)
704 if not nmlib.notmuch_messages_valid(self._msgs):
708 msg = Message(Messages._get (self._msgs), self)
709 nmlib.notmuch_messages_move_to_next(self._msgs)
713 """len(:class:`Messages`) returns the number of contained messages
715 .. note:: As this iterates over the messages, we will not be able to
716 iterate over them again (as in retrieve them)!
718 if self._msgs is None:
719 raise NotmuchError(STATUS.NOT_INITIALIZED)
722 while nmlib.notmuch_messages_valid(self._msgs):
723 nmlib.notmuch_messages_move_to_next(self._msgs)
731 """Close and free the notmuch Messages"""
732 if self._msgs is not None:
733 logging.debug("Freeing the Messages now")
734 nmlib.notmuch_messages_destroy (self._msgs)
737 #------------------------------------------------------------------------------
738 class Message(object):
739 """Represents a single Email message
741 Technically, this wraps the underlying *notmuch_message_t* structure.
744 """notmuch_message_get_filename (notmuch_message_t *message)"""
745 _get_filename = nmlib.notmuch_message_get_filename
746 _get_filename.restype = c_char_p
748 """notmuch_message_get_message_id (notmuch_message_t *message)"""
749 _get_message_id = nmlib.notmuch_message_get_message_id
750 _get_message_id.restype = c_char_p
752 """notmuch_message_get_thread_id"""
753 _get_thread_id = nmlib.notmuch_message_get_thread_id
754 _get_thread_id.restype = c_char_p
756 """notmuch_message_get_tags (notmuch_message_t *message)"""
757 _get_tags = nmlib.notmuch_message_get_tags
758 _get_tags.restype = c_void_p
760 _get_date = nmlib.notmuch_message_get_date
761 _get_date.restype = c_uint64
763 _get_header = nmlib.notmuch_message_get_header
764 _get_header.restype = c_char_p
766 def __init__(self, msg_p, parent=None):
768 :param msg_p: A pointer to an internal notmuch_message_t
769 Structure. If it is `None`, we will raise an :exc:`NotmuchError`
771 :param parent: A 'parent' object is passed which this message is
772 derived from. We save a reference to it, so we can
773 automatically delete the parent object once all derived
777 NotmuchError(STATUS.NULL_POINTER)
779 #keep reference to parent, so we keep it alive
780 self._parent = parent
781 logging.debug("Inited Message derived from %s" %(str(parent)))
784 def get_message_id(self):
785 """Returns the message ID
787 :returns: String with a message ID
788 :exception: :exc:`NotmuchError` STATUS.NOT_INITIALIZED if the message
791 if self._msg is None:
792 raise NotmuchError(STATUS.NOT_INITIALIZED)
793 return Message._get_message_id(self._msg)
795 def get_thread_id(self):
796 """Returns the thread ID
798 The returned string belongs to 'message' will only be valid for as
799 long as the message is valid.
801 This function will not return None since Notmuch ensures that every
802 message belongs to a single thread.
804 :returns: String with a thread ID
805 :exception: :exc:`NotmuchError` STATUS.NOT_INITIALIZED if the message
808 if self._msg is None:
809 raise NotmuchError(STATUS.NOT_INITIALIZED)
811 return Message._get_thread_id (self._msg);
814 """Returns time_t of the message date
816 For the original textual representation of the Date header from the
817 message call notmuch_message_get_header() with a header value of
820 :returns: a time_t timestamp
822 :exception: :exc:`NotmuchError` STATUS.NOT_INITIALIZED if the message
825 if self._msg is None:
826 raise NotmuchError(STATUS.NOT_INITIALIZED)
827 return Message._get_date(self._msg)
829 def get_header(self, header):
830 """Returns a message header
832 This returns any message header that is stored in the notmuch database.
833 This is only a selected subset of headers, which is currently:
835 TODO: add stored headers
837 :param header: The name of the header to be retrieved.
838 It is not case-sensitive (TODO: confirm).
840 :returns: The header value as string
841 :exception: :exc:`NotmuchError`
843 * STATUS.NOT_INITIALIZED if the message
845 * STATUS.NULL_POINTER, if no header was found
847 if self._msg is None:
848 raise NotmuchError(STATUS.NOT_INITIALIZED)
850 #Returns NULL if any error occurs.
851 header = Message._get_header (self._msg, header)
853 raise NotmuchError(STATUS.NULL_POINTER)
856 def get_filename(self):
857 """Return the file path of the message file
859 :returns: Absolute file path & name of the message file
860 :exception: :exc:`NotmuchError` STATUS.NOT_INITIALIZED if the message
863 if self._msg is None:
864 raise NotmuchError(STATUS.NOT_INITIALIZED)
865 return Message._get_filename(self._msg)
868 """ Return the message tags
870 :returns: Message tags
871 :rtype: :class:`Tags`
872 :exception: :exc:`NotmuchError`
874 * STATUS.NOT_INITIALIZED if the message
876 * STATUS.NULL_POINTER, on error
878 if self._msg is None:
879 raise NotmuchError(STATUS.NOT_INITIALIZED)
881 tags_p = Message._get_tags(self._msg)
883 raise NotmuchError(STATUS.NULL_POINTER)
884 return Tags(tags_p, self)
886 def add_tag(self, tag):
887 """Add a tag to the given message
889 Adds a tag to the current message. The maximal tag length is defined in
890 the notmuch library and is currently 200 bytes.
892 :param tag: String with a 'tag' to be added.
893 :returns: STATUS.SUCCESS if the tag was successfully added.
894 Raises an exception otherwise.
895 :exception: :exc:`NotmuchError`. They have the following meaning:
898 The 'tag' argument is NULL
900 The length of 'tag' is too long
901 (exceeds Message.NOTMUCH_TAG_MAX)
902 STATUS.READ_ONLY_DATABASE
903 Database was opened in read-only mode so message cannot be
905 STATUS.NOT_INITIALIZED
906 The message has not been initialized.
908 if self._msg is None:
909 raise NotmuchError(STATUS.NOT_INITIALIZED)
911 status = nmlib.notmuch_message_add_tag (self._msg, tag)
913 if STATUS.SUCCESS == status:
917 raise NotmuchError(status)
919 def remove_tag(self, tag):
920 """Removes a tag from the given message
922 If the message has no such tag, this is a non-operation and
923 will report success anyway.
925 :param tag: String with a 'tag' to be removed.
926 :returns: STATUS.SUCCESS if the tag was successfully removed or if
927 the message had no such tag.
928 Raises an exception otherwise.
929 :exception: :exc:`NotmuchError`. They have the following meaning:
932 The 'tag' argument is NULL
934 The length of 'tag' is too long
935 (exceeds NOTMUCH_TAG_MAX)
936 STATUS.READ_ONLY_DATABASE
937 Database was opened in read-only mode so message cannot
939 STATUS.NOT_INITIALIZED
940 The message has not been initialized.
942 if self._msg is None:
943 raise NotmuchError(STATUS.NOT_INITIALIZED)
945 status = nmlib.notmuch_message_remove_tag(self._msg, tag)
947 if STATUS.SUCCESS == status:
951 raise NotmuchError(status)
953 def remove_all_tags(self):
954 """Removes all tags from the given message.
956 See :meth:`freeze` for an example showing how to safely
959 :returns: STATUS.SUCCESS if the tags were successfully removed.
960 Raises an exception otherwise.
961 :exception: :exc:`NotmuchError`. They have the following meaning:
963 STATUS.READ_ONLY_DATABASE
964 Database was opened in read-only mode so message cannot
966 STATUS.NOT_INITIALIZED
967 The message has not been initialized.
969 if self._msg is None:
970 raise NotmuchError(STATUS.NOT_INITIALIZED)
972 status = nmlib.notmuch_message_remove_all_tags(self._msg)
974 if STATUS.SUCCESS == status:
978 raise NotmuchError(status)
981 """Freezes the current state of 'message' within the database
983 This means that changes to the message state, (via :meth:`add_tag`,
984 :meth:`remove_tag`, and :meth:`remove_all_tags`), will not be
985 committed to the database until the message is :meth:`thaw`ed.
987 Multiple calls to freeze/thaw are valid and these calls will
988 "stack". That is there must be as many calls to thaw as to freeze
989 before a message is actually thawed.
991 The ability to do freeze/thaw allows for safe transactions to
992 change tag values. For example, explicitly setting a message to
993 have a given set of tags might look like this::
996 msg.remove_all_tags()
1001 With freeze/thaw used like this, the message in the database is
1002 guaranteed to have either the full set of original tag values, or
1003 the full set of new tag values, but nothing in between.
1005 Imagine the example above without freeze/thaw and the operation
1006 somehow getting interrupted. This could result in the message being
1007 left with no tags if the interruption happened after
1008 :meth:`remove_all_tags` but before :meth:`add_tag`.
1010 :returns: STATUS.SUCCESS if the message was successfully frozen.
1011 Raises an exception otherwise.
1012 :exception: :exc:`NotmuchError`. They have the following meaning:
1014 STATUS.READ_ONLY_DATABASE
1015 Database was opened in read-only mode so message cannot
1017 STATUS.NOT_INITIALIZED
1018 The message has not been initialized.
1020 if self._msg is None:
1021 raise NotmuchError(STATUS.NOT_INITIALIZED)
1023 status = nmlib.notmuch_message_freeze(self._msg)
1025 if STATUS.SUCCESS == status:
1029 raise NotmuchError(status)
1032 """Thaws the current 'message'
1034 Thaw the current 'message', synchronizing any changes that may have
1035 occurred while 'message' was frozen into the notmuch database.
1037 See :meth:`freeze` for an example of how to use this
1038 function to safely provide tag changes.
1040 Multiple calls to freeze/thaw are valid and these calls with
1041 "stack". That is there must be as many calls to thaw as to freeze
1042 before a message is actually thawed.
1044 :returns: STATUS.SUCCESS if the message was successfully frozen.
1045 Raises an exception otherwise.
1046 :exception: :exc:`NotmuchError`. They have the following meaning:
1048 STATUS.UNBALANCED_FREEZE_THAW
1049 An attempt was made to thaw an unfrozen message.
1050 That is, there have been an unbalanced number of calls
1051 to :meth:`freeze` and :meth:`thaw`.
1052 STATUS.NOT_INITIALIZED
1053 The message has not been initialized.
1055 if self._msg is None:
1056 raise NotmuchError(STATUS.NOT_INITIALIZED)
1058 status = nmlib.notmuch_message_thaw(self._msg)
1060 if STATUS.SUCCESS == status:
1064 raise NotmuchError(status)
1068 """A message() is represented by a 1-line summary"""
1070 msg['from'] = self.get_header('from')
1071 msg['tags'] = str(self.get_tags())
1072 msg['date'] = date.fromtimestamp(self.get_date())
1073 return "%(from)s (%(date)s) (%(tags)s)" % (msg)
1075 def format_as_text(self):
1076 """Output like notmuch show (Not implemented)"""
1080 """Close and free the notmuch Message"""
1081 if self._msg is not None:
1082 logging.debug("Freeing the Message now")
1083 nmlib.notmuch_message_destroy (self._msg)