2 from ctypes import c_int, c_char_p, c_void_p, c_uint, c_uint64, c_bool
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 find_message(self, msgid):
172 """Returns a :class:`Message` as identified by its message ID
174 Wraps the underlying *notmuch_database_find_message* function.
176 :param msgid: The message ID
178 :returns: :class:`Message` or `None` if no message is found or if an
179 out-of-memory situation occurs.
180 :exception: :exc:`NotmuchError` with STATUS.NOT_INITIALIZED if
181 the database was not intitialized.
183 # Raise a NotmuchError if not initialized
184 self._verify_initialized_db()
186 msg_p = Database._find_message(self._db, msgid)
189 return Message(msg_p, self)
191 def get_all_tags(self):
192 """Returns :class:`Tags` with a list of all tags found in the database
194 :returns: :class:`Tags`
195 :execption: :exc:`NotmuchError` with STATUS.NULL_POINTER on error
197 # Raise a NotmuchError if not initialized
198 self._verify_initialized_db()
200 tags_p = Database._get_all_tags (self._db)
202 raise NotmuchError(STATUS.NULL_POINTER)
203 return Tags(tags_p, self)
206 return "'Notmuch DB " + self.get_path() + "'"
209 """Close and free the notmuch database if needed"""
210 if self._db is not None:
211 logging.debug("Freeing the database now")
212 nmlib.notmuch_database_close(self._db)
214 def _get_user_default_db(self):
215 """ Reads a user's notmuch config and returns his db location
217 Throws a NotmuchError if it cannot find it"""
218 from ConfigParser import SafeConfigParser
219 config = SafeConfigParser()
220 conf_f = os.getenv('NOTMUCH_CONFIG',
221 os.path.expanduser('~/.notmuch-config'))
223 if not config.has_option('database','path'):
224 raise NotmuchError(message=
225 "No DB path specified and no user default found")
226 return config.get('database','path')
230 """Property returning a pointer to the notmuch_database_t or `None`
232 This should normally not be needed by a user."""
235 #------------------------------------------------------------------------------
237 """ Represents a search query on an opened :class:`Database`.
239 A query selects and filters a subset of messages from the notmuch
240 database we derive from.
242 Technically, it wraps the underlying *notmuch_query_t* struct.
244 .. note:: Do remember that as soon as we tear down this object,
245 all underlying derived objects such as threads,
246 messages, tags etc will be freed by the underlying library
247 as well. Accessing these objects will lead to segfaults and
248 other unexpected behavior. See above for more details.
251 SORT = Enum(['OLDEST_FIRST','NEWEST_FIRST','MESSAGE_ID'])
252 """Constants: Sort order in which to return results"""
254 """notmuch_query_create"""
255 _create = nmlib.notmuch_query_create
256 _create.restype = c_void_p
258 """notmuch_query_search_messages"""
259 _search_messages = nmlib.notmuch_query_search_messages
260 _search_messages.restype = c_void_p
263 """notmuch_query_count_messages"""
264 _count_messages = nmlib.notmuch_query_count_messages
265 _count_messages.restype = c_uint
267 def __init__(self, db, querystr):
269 :param db: An open database which we derive the Query from.
270 :type db: :class:`Database`
271 :param querystr: The query string for the message.
276 self.create(db, querystr)
278 def create(self, db, querystr):
279 """Creates a new query derived from a Database.
281 This function is utilized by __init__() and usually does not need to
284 :param db: Database to create the query from.
285 :type db: :class:`Database`
286 :param querystr: The query string
289 :exception: :exc:`NotmuchError`
291 * STATUS.NOT_INITIALIZED if db is not inited
292 * STATUS.NULL_POINTER if the query creation failed
296 raise NotmuchError(STATUS.NOT_INITIALIZED)
297 # create reference to parent db to keep it alive
300 # create query, return None if too little mem available
301 query_p = Query._create(db.db_p, querystr)
303 NotmuchError(STATUS.NULL_POINTER)
304 self._query = query_p
306 def set_sort(self, sort):
307 """Set the sort order future results will be delivered in
309 Wraps the underlying *notmuch_query_set_sort* function.
311 :param sort: Sort order (see :attr:`Query.SORT`)
313 :exception: :exc:`NotmuchError` STATUS.NOT_INITIALIZED if query has not
316 if self._query is None:
317 raise NotmuchError(STATUS.NOT_INITIALIZED)
319 nmlib.notmuch_query_set_sort(self._query, sort)
321 def search_messages(self):
322 """Filter messages according to the query and return
323 :class:`Messages` in the defined sort order
325 Technically, it wraps the underlying
326 *notmuch_query_search_messages* function.
328 :returns: :class:`Messages`
329 :exception: :exc:`NotmuchError`
331 * STATUS.NOT_INITIALIZED if query is not inited
332 * STATUS.NULL_POINTER if search_messages failed
334 if self._query is None:
335 raise NotmuchError(STATUS.NOT_INITIALIZED)
337 msgs_p = Query._search_messages(self._query)
340 NotmuchError(STATUS.NULL_POINTER)
342 return Messages(msgs_p,self)
344 def count_messages(self):
345 """Estimate the number of messages matching the query
347 This function performs a search and returns Xapian's best
348 guess as to the number of matching messages. It is much faster
349 than performing :meth:`search_messages` and counting the
350 result with `len()` (although it always returned the same
351 result in my tests). Technically, it wraps the underlying
352 *notmuch_query_count_messages* function.
354 :returns: :class:`Messages`
355 :exception: :exc:`NotmuchError`
357 * STATUS.NOT_INITIALIZED if query is not inited
359 if self._query is None:
360 raise NotmuchError(STATUS.NOT_INITIALIZED)
362 return Query._count_messages(self._query)
365 """Close and free the Query"""
366 if self._query is not None:
367 logging.debug("Freeing the Query now")
368 nmlib.notmuch_query_destroy (self._query)
370 #------------------------------------------------------------------------------
372 """Represents a list of notmuch tags
374 This object provides an iterator over a list of notmuch tags. Do
375 note that the underlying library only provides a one-time iterator
376 (it cannot reset the iterator to the start). Thus iterating over
377 the function will "exhaust" the list of tags, and a subsequent
378 iteration attempt will raise a :exc:`NotmuchError`
379 STATUS.NOT_INITIALIZED. Also note, that any function that uses
380 iteration (nearly all) will also exhaust the tags. So both::
382 for tag in tags: print tag
386 number_of_tags = len(tags)
390 #str() iterates over all tags to construct a space separated list
393 will "exhaust" the Tags. If you need to re-iterate over a list of
394 tags you will need to retrieve a new :class:`Tags` object.
398 _get = nmlib.notmuch_tags_get
399 _get.restype = c_char_p
401 def __init__(self, tags_p, parent=None):
403 :param tags_p: A pointer to an underlying *notmuch_tags_t*
404 structure. These are not publically exposed, so a user
405 will almost never instantiate a :class:`Tags` object
406 herself. They are usually handed back as a result,
407 e.g. in :meth:`Database.get_all_tags`. *tags_p* must be
408 valid, we will raise an :exc:`NotmuchError`
409 (STATUS.NULL_POINTER) if it is `None`.
410 :type tags_p: :class:`ctypes.c_void_p`
411 :param parent: The parent object (ie :class:`Database` or
412 :class:`Message` these tags are derived from, and saves a
413 reference to it, so we can automatically delete the db object
414 once all derived objects are dead.
415 :TODO: Make the iterator optionally work more than once by
416 cache the tags in the Python object(?)
419 NotmuchError(STATUS.NULL_POINTER)
422 #save reference to parent object so we keep it alive
423 self._parent = parent
424 logging.debug("Inited Tags derived from %s" %(repr(parent)))
427 """ Make Tags an iterator """
431 if self._tags is None:
432 raise NotmuchError(STATUS.NOT_INITIALIZED)
434 if not nmlib.notmuch_tags_valid(self._tags):
438 tag = Tags._get (self._tags)
439 nmlib.notmuch_tags_move_to_next(self._tags)
443 """len(:class:`Tags`) returns the number of contained tags
445 .. note:: As this iterates over the tags, we will not be able
446 to iterate over them again (as in retrieve them)! If
447 the tags have been exhausted already, this will raise a
448 :exc:`NotmuchError` STATUS.NOT_INITIALIZED on
451 if self._tags is None:
452 raise NotmuchError(STATUS.NOT_INITIALIZED)
455 while nmlib.notmuch_tags_valid(self._msgs):
456 nmlib.notmuch_tags_move_to_next(self._msgs)
462 """The str() representation of Tags() is a space separated list of tags
464 .. note:: As this iterates over the tags, we will not be able
465 to iterate over them again (as in retrieve them)! If
466 the tags have been exhausted already, this will raise a
467 :exc:`NotmuchError` STATUS.NOT_INITIALIZED on
470 return " ".join(self)
473 """Close and free the notmuch tags"""
474 if self._tags is not None:
475 logging.debug("Freeing the Tags now")
476 nmlib.notmuch_tags_destroy (self._tags)
479 #------------------------------------------------------------------------------
480 class Messages(object):
481 """Represents a list of notmuch messages
483 This object provides an iterator over a list of notmuch messages
484 (Technically, it provides a wrapper for the underlying
485 *notmuch_messages_t* structure). Do note that the underlying
486 library only provides a one-time iterator (it cannot reset the
487 iterator to the start). Thus iterating over the function will
488 "exhaust" the list of messages, and a subsequent iteration attempt
489 will raise a :exc:`NotmuchError` STATUS.NOT_INITIALIZED. Also
490 note, that any function that uses iteration will also
491 exhaust the messages. So both::
493 for msg in msgs: print msg
497 number_of_msgs = len(msgs)
499 will "exhaust" the Messages. If you need to re-iterate over a list of
500 messages you will need to retrieve a new :class:`Messages` object.
502 Things are not as bad as it seems though, you can store and reuse
503 the single Message objects as often as you want as long as you
504 keep the parent Messages object around. (Recall that due to
505 hierarchical memory allocation, all derived Message objects will
506 be invalid when we delete the parent Messages() object, even if it
507 was already "exhausted".) So this works::
510 msgs = Query(db,'').search_messages() #get a Messages() object
515 # msgs is "exhausted" now and even len(msgs) will raise an exception.
516 # However it will be kept around until all retrieved Message() objects are
517 # also deleted. If you did e.g. an explicit del(msgs) here, the
518 # following lines would fail.
520 # You can reiterate over *msglist* however as often as you want.
521 # It is simply a list with Message objects.
523 print (msglist[0].get_filename())
524 print (msglist[1].get_filename())
525 print (msglist[0].get_message_id())
529 _get = nmlib.notmuch_messages_get
530 _get.restype = c_void_p
532 _collect_tags = nmlib.notmuch_messages_collect_tags
533 _collect_tags.restype = c_void_p
535 def __init__(self, msgs_p, parent=None):
537 :param msgs_p: A pointer to an underlying *notmuch_messages_t*
538 structure. These are not publically exposed, so a user
539 will almost never instantiate a :class:`Messages` object
540 herself. They are usually handed back as a result,
541 e.g. in :meth:`Query.search_messages`. *msgs_p* must be
542 valid, we will raise an :exc:`NotmuchError`
543 (STATUS.NULL_POINTER) if it is `None`.
544 :type msgs_p: :class:`ctypes.c_void_p`
545 :param parent: The parent object
546 (ie :class:`Query`) these tags are derived from. It saves
547 a reference to it, so we can automatically delete the db
548 object once all derived objects are dead.
549 :TODO: Make the iterator work more than once and cache the tags in
550 the Python object.(?)
553 NotmuchError(STATUS.NULL_POINTER)
556 #store parent, so we keep them alive as long as self is alive
557 self._parent = parent
558 logging.debug("Inited Messages derived from %s" %(str(parent)))
560 def collect_tags(self):
561 """Return the unique :class:`Tags` in the contained messages
563 :returns: :class:`Tags`
564 :exceptions: :exc:`NotmuchError` STATUS.NOT_INITIALIZED if not inited
566 .. note:: :meth:`collect_tags` will iterate over the messages and
567 therefore will not allow further iterations.
569 if self._msgs is None:
570 raise NotmuchError(STATUS.NOT_INITIALIZED)
572 # collect all tags (returns NULL on error)
573 tags_p = Messages._collect_tags (self._msgs)
574 #reset _msgs as we iterated over it and can do so only once
578 raise NotmuchError(STATUS.NULL_POINTER)
579 return Tags(tags_p, self)
582 """ Make Messages an iterator """
586 if self._msgs is None:
587 raise NotmuchError(STATUS.NOT_INITIALIZED)
589 if not nmlib.notmuch_messages_valid(self._msgs):
593 msg = Message(Messages._get (self._msgs), self)
594 nmlib.notmuch_messages_move_to_next(self._msgs)
598 """len(:class:`Messages`) returns the number of contained messages
600 .. note:: As this iterates over the messages, we will not be able to
601 iterate over them again (as in retrieve them)!
603 if self._msgs is None:
604 raise NotmuchError(STATUS.NOT_INITIALIZED)
607 while nmlib.notmuch_messages_valid(self._msgs):
608 nmlib.notmuch_messages_move_to_next(self._msgs)
616 """Close and free the notmuch Messages"""
617 if self._msgs is not None:
618 logging.debug("Freeing the Messages now")
619 nmlib.notmuch_messages_destroy (self._msgs)
622 #------------------------------------------------------------------------------
623 class Message(object):
624 """Represents a single Email message
626 Technically, this wraps the underlying *notmuch_message_t* structure.
629 """notmuch_message_get_filename (notmuch_message_t *message)"""
630 _get_filename = nmlib.notmuch_message_get_filename
631 _get_filename.restype = c_char_p
633 """notmuch_message_get_message_id (notmuch_message_t *message)"""
634 _get_message_id = nmlib.notmuch_message_get_message_id
635 _get_message_id.restype = c_char_p
637 """notmuch_message_get_thread_id"""
638 _get_thread_id = nmlib.notmuch_message_get_thread_id
639 _get_thread_id.restype = c_char_p
641 """notmuch_message_get_tags (notmuch_message_t *message)"""
642 _get_tags = nmlib.notmuch_message_get_tags
643 _get_tags.restype = c_void_p
645 _get_date = nmlib.notmuch_message_get_date
646 _get_date.restype = c_uint64
648 _get_header = nmlib.notmuch_message_get_header
649 _get_header.restype = c_char_p
651 def __init__(self, msg_p, parent=None):
653 :param msg_p: A pointer to an internal notmuch_message_t
654 Structure. If it is `None`, we will raise an :exc:`NotmuchError`
656 :param parent: A 'parent' object is passed which this message is
657 derived from. We save a reference to it, so we can
658 automatically delete the parent object once all derived
662 NotmuchError(STATUS.NULL_POINTER)
664 #keep reference to parent, so we keep it alive
665 self._parent = parent
666 logging.debug("Inited Message derived from %s" %(str(parent)))
669 def get_message_id(self):
670 """Returns the message ID
672 :returns: String with a message ID
673 :exception: :exc:`NotmuchError` STATUS.NOT_INITIALIZED if the message
676 if self._msg is None:
677 raise NotmuchError(STATUS.NOT_INITIALIZED)
678 return Message._get_message_id(self._msg)
680 def get_thread_id(self):
681 """Returns the thread ID
683 The returned string belongs to 'message' will only be valid for as
684 long as the message is valid.
686 This function will not return None since Notmuch ensures that every
687 message belongs to a single thread.
689 :returns: String with a thread ID
690 :exception: :exc:`NotmuchError` STATUS.NOT_INITIALIZED if the message
693 if self._msg is None:
694 raise NotmuchError(STATUS.NOT_INITIALIZED)
696 return Message._get_thread_id (self._msg);
699 """Returns time_t of the message date
701 For the original textual representation of the Date header from the
702 message call notmuch_message_get_header() with a header value of
705 :returns: a time_t timestamp
707 :exception: :exc:`NotmuchError` STATUS.NOT_INITIALIZED if the message
710 if self._msg is None:
711 raise NotmuchError(STATUS.NOT_INITIALIZED)
712 return Message._get_date(self._msg)
714 def get_header(self, header):
715 """Returns a message header
717 This returns any message header that is stored in the notmuch database.
718 This is only a selected subset of headers, which is currently:
720 TODO: add stored headers
722 :param header: The name of the header to be retrieved.
723 It is not case-sensitive (TODO: confirm).
725 :returns: The header value as string
726 :exception: :exc:`NotmuchError`
728 * STATUS.NOT_INITIALIZED if the message
730 * STATUS.NULL_POINTER, if no header was found
732 if self._msg is None:
733 raise NotmuchError(STATUS.NOT_INITIALIZED)
735 #Returns NULL if any error occurs.
736 header = Message._get_header (self._msg, header)
738 raise NotmuchError(STATUS.NULL_POINTER)
741 def get_filename(self):
742 """Return the file path of the message file
744 :returns: Absolute file path & name of the message file
745 :exception: :exc:`NotmuchError` STATUS.NOT_INITIALIZED if the message
748 if self._msg is None:
749 raise NotmuchError(STATUS.NOT_INITIALIZED)
750 return Message._get_filename(self._msg)
753 """ Return the message tags
755 :returns: Message tags
756 :rtype: :class:`Tags`
757 :exception: :exc:`NotmuchError`
759 * STATUS.NOT_INITIALIZED if the message
761 * STATUS.NULL_POINTER, on error
763 if self._msg is None:
764 raise NotmuchError(STATUS.NOT_INITIALIZED)
766 tags_p = Message._get_tags(self._msg)
768 raise NotmuchError(STATUS.NULL_POINTER)
769 return Tags(tags_p, self)
771 def add_tag(self, tag):
772 """Add a tag to the given message
774 Adds a tag to the current message. The maximal tag length is defined in
775 the notmuch library and is currently 200 bytes.
777 :param tag: String with a 'tag' to be added.
778 :returns: STATUS.SUCCESS if the tag was successfully added.
779 Raises an exception otherwise.
780 :exception: :exc:`NotmuchError`. They have the following meaning:
783 The 'tag' argument is NULL
785 The length of 'tag' is too long
786 (exceeds Message.NOTMUCH_TAG_MAX)
787 STATUS.READ_ONLY_DATABASE
788 Database was opened in read-only mode so message cannot be
790 STATUS.NOT_INITIALIZED
791 The message has not been initialized.
793 if self._msg is None:
794 raise NotmuchError(STATUS.NOT_INITIALIZED)
796 status = nmlib.notmuch_message_add_tag (self._msg, tag)
798 if STATUS.SUCCESS == status:
802 raise NotmuchError(status)
804 def remove_tag(self, tag):
805 """Removes a tag from the given message
807 If the message has no such tag, this is a non-operation and
808 will report success anyway.
810 :param tag: String with a 'tag' to be removed.
811 :returns: STATUS.SUCCESS if the tag was successfully removed or if
812 the message had no such tag.
813 Raises an exception otherwise.
814 :exception: :exc:`NotmuchError`. They have the following meaning:
817 The 'tag' argument is NULL
819 The length of 'tag' is too long
820 (exceeds NOTMUCH_TAG_MAX)
821 STATUS.READ_ONLY_DATABASE
822 Database was opened in read-only mode so message cannot
824 STATUS.NOT_INITIALIZED
825 The message has not been initialized.
827 if self._msg is None:
828 raise NotmuchError(STATUS.NOT_INITIALIZED)
830 status = nmlib.notmuch_message_remove_tag(self._msg, tag)
832 if STATUS.SUCCESS == status:
836 raise NotmuchError(status)
838 def remove_all_tags(self):
839 """Removes all tags from the given message.
841 See :meth:`freeze` for an example showing how to safely
844 :returns: STATUS.SUCCESS if the tags were successfully removed.
845 Raises an exception otherwise.
846 :exception: :exc:`NotmuchError`. They have the following meaning:
848 STATUS.READ_ONLY_DATABASE
849 Database was opened in read-only mode so message cannot
851 STATUS.NOT_INITIALIZED
852 The message has not been initialized.
854 if self._msg is None:
855 raise NotmuchError(STATUS.NOT_INITIALIZED)
857 status = nmlib.notmuch_message_remove_all_tags(self._msg)
859 if STATUS.SUCCESS == status:
863 raise NotmuchError(status)
866 """Freezes the current state of 'message' within the database
868 This means that changes to the message state, (via :meth:`add_tag`,
869 :meth:`remove_tag`, and :meth:`remove_all_tags`), will not be
870 committed to the database until the message is :meth:`thaw`ed.
872 Multiple calls to freeze/thaw are valid and these calls will
873 "stack". That is there must be as many calls to thaw as to freeze
874 before a message is actually thawed.
876 The ability to do freeze/thaw allows for safe transactions to
877 change tag values. For example, explicitly setting a message to
878 have a given set of tags might look like this::
881 msg.remove_all_tags()
886 With freeze/thaw used like this, the message in the database is
887 guaranteed to have either the full set of original tag values, or
888 the full set of new tag values, but nothing in between.
890 Imagine the example above without freeze/thaw and the operation
891 somehow getting interrupted. This could result in the message being
892 left with no tags if the interruption happened after
893 :meth:`remove_all_tags` but before :meth:`add_tag`.
895 :returns: STATUS.SUCCESS if the message was successfully frozen.
896 Raises an exception otherwise.
897 :exception: :exc:`NotmuchError`. They have the following meaning:
899 STATUS.READ_ONLY_DATABASE
900 Database was opened in read-only mode so message cannot
902 STATUS.NOT_INITIALIZED
903 The message has not been initialized.
905 if self._msg is None:
906 raise NotmuchError(STATUS.NOT_INITIALIZED)
908 status = nmlib.notmuch_message_freeze(self._msg)
910 if STATUS.SUCCESS == status:
914 raise NotmuchError(status)
917 """Thaws the current 'message'
919 Thaw the current 'message', synchronizing any changes that may have
920 occurred while 'message' was frozen into the notmuch database.
922 See :meth:`freeze` for an example of how to use this
923 function to safely provide tag changes.
925 Multiple calls to freeze/thaw are valid and these calls with
926 "stack". That is there must be as many calls to thaw as to freeze
927 before a message is actually thawed.
929 :returns: STATUS.SUCCESS if the message was successfully frozen.
930 Raises an exception otherwise.
931 :exception: :exc:`NotmuchError`. They have the following meaning:
933 STATUS.UNBALANCED_FREEZE_THAW
934 An attempt was made to thaw an unfrozen message.
935 That is, there have been an unbalanced number of calls
936 to :meth:`freeze` and :meth:`thaw`.
937 STATUS.NOT_INITIALIZED
938 The message has not been initialized.
940 if self._msg is None:
941 raise NotmuchError(STATUS.NOT_INITIALIZED)
943 status = nmlib.notmuch_message_thaw(self._msg)
945 if STATUS.SUCCESS == status:
949 raise NotmuchError(status)
953 """A message() is represented by a 1-line summary"""
955 msg['from'] = self.get_header('from')
956 msg['tags'] = str(self.get_tags())
957 msg['date'] = date.fromtimestamp(self.get_date())
958 return "%(from)s (%(date)s) (%(tags)s)" % (msg)
960 def format_as_text(self):
961 """Output like notmuch show (Not implemented)"""
965 """Close and free the notmuch Message"""
966 if self._msg is not None:
967 logging.debug("Freeing the Message now")
968 nmlib.notmuch_message_destroy (self._msg)