Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1 | :mod:`mailbox` --- Manipulate mailboxes in various formats |
| 2 | ========================================================== |
| 3 | |
| 4 | .. module:: mailbox |
| 5 | :synopsis: Manipulate mailboxes in various formats |
Terry Jan Reedy | fa089b9 | 2016-06-11 15:02:54 -0400 | [diff] [blame] | 6 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 7 | .. moduleauthor:: Gregory K. Johnson <gkj@gregorykjohnson.com> |
| 8 | .. sectionauthor:: Gregory K. Johnson <gkj@gregorykjohnson.com> |
| 9 | |
Terry Jan Reedy | fa089b9 | 2016-06-11 15:02:54 -0400 | [diff] [blame] | 10 | **Source code:** :source:`Lib/mailbox.py` |
| 11 | |
| 12 | -------------- |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 13 | |
| 14 | This module defines two classes, :class:`Mailbox` and :class:`Message`, for |
| 15 | accessing and manipulating on-disk mailboxes and the messages they contain. |
| 16 | :class:`Mailbox` offers a dictionary-like mapping from keys to messages. |
R David Murray | 5320250 | 2012-09-28 15:19:16 -0400 | [diff] [blame] | 17 | :class:`Message` extends the :mod:`email.message` module's |
| 18 | :class:`~email.message.Message` class with format-specific state and behavior. |
| 19 | Supported mailbox formats are Maildir, mbox, MH, Babyl, and MMDF. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 20 | |
| 21 | |
| 22 | .. seealso:: |
| 23 | |
| 24 | Module :mod:`email` |
| 25 | Represent and manipulate messages. |
| 26 | |
| 27 | |
| 28 | .. _mailbox-objects: |
| 29 | |
| 30 | :class:`Mailbox` objects |
| 31 | ------------------------ |
| 32 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 33 | .. class:: Mailbox |
| 34 | |
| 35 | A mailbox, which may be inspected and modified. |
| 36 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 37 | The :class:`Mailbox` class defines an interface and is not intended to be |
| 38 | instantiated. Instead, format-specific subclasses should inherit from |
| 39 | :class:`Mailbox` and your code should instantiate a particular subclass. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 40 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 41 | The :class:`Mailbox` interface is dictionary-like, with small keys |
| 42 | corresponding to messages. Keys are issued by the :class:`Mailbox` instance |
| 43 | with which they will be used and are only meaningful to that :class:`Mailbox` |
| 44 | instance. A key continues to identify a message even if the corresponding |
| 45 | message is modified, such as by replacing it with another message. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 46 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 47 | Messages may be added to a :class:`Mailbox` instance using the set-like |
| 48 | method :meth:`add` and removed using a ``del`` statement or the set-like |
| 49 | methods :meth:`remove` and :meth:`discard`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 50 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 51 | :class:`Mailbox` interface semantics differ from dictionary semantics in some |
| 52 | noteworthy ways. Each time a message is requested, a new representation |
| 53 | (typically a :class:`Message` instance) is generated based upon the current |
| 54 | state of the mailbox. Similarly, when a message is added to a |
| 55 | :class:`Mailbox` instance, the provided message representation's contents are |
| 56 | copied. In neither case is a reference to the message representation kept by |
| 57 | the :class:`Mailbox` instance. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 58 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 59 | The default :class:`Mailbox` iterator iterates over message representations, |
| 60 | not keys as the default dictionary iterator does. Moreover, modification of a |
| 61 | mailbox during iteration is safe and well-defined. Messages added to the |
| 62 | mailbox after an iterator is created will not be seen by the |
| 63 | iterator. Messages removed from the mailbox before the iterator yields them |
| 64 | will be silently skipped, though using a key from an iterator may result in a |
| 65 | :exc:`KeyError` exception if the corresponding message is subsequently |
| 66 | removed. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 67 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 68 | .. warning:: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 69 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 70 | Be very cautious when modifying mailboxes that might be simultaneously |
| 71 | changed by some other process. The safest mailbox format to use for such |
| 72 | tasks is Maildir; try to avoid using single-file formats such as mbox for |
| 73 | concurrent writing. If you're modifying a mailbox, you *must* lock it by |
| 74 | calling the :meth:`lock` and :meth:`unlock` methods *before* reading any |
| 75 | messages in the file or making any changes by adding or deleting a |
| 76 | message. Failing to lock the mailbox runs the risk of losing messages or |
| 77 | corrupting the entire mailbox. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 78 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 79 | :class:`Mailbox` instances have the following methods: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 80 | |
| 81 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 82 | .. method:: add(message) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 83 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 84 | Add *message* to the mailbox and return the key that has been assigned to |
| 85 | it. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 86 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 87 | Parameter *message* may be a :class:`Message` instance, an |
R David Murray | 5320250 | 2012-09-28 15:19:16 -0400 | [diff] [blame] | 88 | :class:`email.message.Message` instance, a string, a byte string, or a |
R. David Murray | b7deff1 | 2011-01-30 06:21:28 +0000 | [diff] [blame] | 89 | file-like object (which should be open in binary mode). If *message* is |
| 90 | an instance of the |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 91 | appropriate format-specific :class:`Message` subclass (e.g., if it's an |
| 92 | :class:`mboxMessage` instance and this is an :class:`mbox` instance), its |
| 93 | format-specific information is used. Otherwise, reasonable defaults for |
| 94 | format-specific information are used. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 95 | |
Georg Brandl | 33369cf | 2012-06-24 22:48:03 +0200 | [diff] [blame] | 96 | .. versionchanged:: 3.2 |
| 97 | Support for binary input was added. |
R. David Murray | b7deff1 | 2011-01-30 06:21:28 +0000 | [diff] [blame] | 98 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 99 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 100 | .. method:: remove(key) |
| 101 | __delitem__(key) |
| 102 | discard(key) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 103 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 104 | Delete the message corresponding to *key* from the mailbox. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 105 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 106 | If no such message exists, a :exc:`KeyError` exception is raised if the |
| 107 | method was called as :meth:`remove` or :meth:`__delitem__` but no |
| 108 | exception is raised if the method was called as :meth:`discard`. The |
| 109 | behavior of :meth:`discard` may be preferred if the underlying mailbox |
| 110 | format supports concurrent modification by other processes. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 111 | |
| 112 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 113 | .. method:: __setitem__(key, message) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 114 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 115 | Replace the message corresponding to *key* with *message*. Raise a |
| 116 | :exc:`KeyError` exception if no message already corresponds to *key*. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 117 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 118 | As with :meth:`add`, parameter *message* may be a :class:`Message` |
R David Murray | 5320250 | 2012-09-28 15:19:16 -0400 | [diff] [blame] | 119 | instance, an :class:`email.message.Message` instance, a string, a byte |
R. David Murray | b7deff1 | 2011-01-30 06:21:28 +0000 | [diff] [blame] | 120 | string, or a file-like object (which should be open in binary mode). If |
| 121 | *message* is an |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 122 | instance of the appropriate format-specific :class:`Message` subclass |
| 123 | (e.g., if it's an :class:`mboxMessage` instance and this is an |
| 124 | :class:`mbox` instance), its format-specific information is |
| 125 | used. Otherwise, the format-specific information of the message that |
| 126 | currently corresponds to *key* is left unchanged. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 127 | |
| 128 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 129 | .. method:: iterkeys() |
| 130 | keys() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 131 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 132 | Return an iterator over all keys if called as :meth:`iterkeys` or return a |
| 133 | list of keys if called as :meth:`keys`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 134 | |
| 135 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 136 | .. method:: itervalues() |
| 137 | __iter__() |
| 138 | values() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 139 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 140 | Return an iterator over representations of all messages if called as |
| 141 | :meth:`itervalues` or :meth:`__iter__` or return a list of such |
| 142 | representations if called as :meth:`values`. The messages are represented |
| 143 | as instances of the appropriate format-specific :class:`Message` subclass |
| 144 | unless a custom message factory was specified when the :class:`Mailbox` |
| 145 | instance was initialized. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 146 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 147 | .. note:: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 148 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 149 | The behavior of :meth:`__iter__` is unlike that of dictionaries, which |
| 150 | iterate over keys. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 151 | |
| 152 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 153 | .. method:: iteritems() |
| 154 | items() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 155 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 156 | Return an iterator over (*key*, *message*) pairs, where *key* is a key and |
| 157 | *message* is a message representation, if called as :meth:`iteritems` or |
| 158 | return a list of such pairs if called as :meth:`items`. The messages are |
| 159 | represented as instances of the appropriate format-specific |
| 160 | :class:`Message` subclass unless a custom message factory was specified |
| 161 | when the :class:`Mailbox` instance was initialized. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 162 | |
| 163 | |
Georg Brandl | cd7f32b | 2009-06-08 09:13:45 +0000 | [diff] [blame] | 164 | .. method:: get(key, default=None) |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 165 | __getitem__(key) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 166 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 167 | Return a representation of the message corresponding to *key*. If no such |
| 168 | message exists, *default* is returned if the method was called as |
| 169 | :meth:`get` and a :exc:`KeyError` exception is raised if the method was |
| 170 | called as :meth:`__getitem__`. The message is represented as an instance |
| 171 | of the appropriate format-specific :class:`Message` subclass unless a |
| 172 | custom message factory was specified when the :class:`Mailbox` instance |
| 173 | was initialized. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 174 | |
| 175 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 176 | .. method:: get_message(key) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 177 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 178 | Return a representation of the message corresponding to *key* as an |
| 179 | instance of the appropriate format-specific :class:`Message` subclass, or |
| 180 | raise a :exc:`KeyError` exception if no such message exists. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 181 | |
| 182 | |
R. David Murray | b7deff1 | 2011-01-30 06:21:28 +0000 | [diff] [blame] | 183 | .. method:: get_bytes(key) |
| 184 | |
| 185 | Return a byte representation of the message corresponding to *key*, or |
| 186 | raise a :exc:`KeyError` exception if no such message exists. |
| 187 | |
| 188 | .. versionadded:: 3.2 |
| 189 | |
| 190 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 191 | .. method:: get_string(key) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 192 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 193 | Return a string representation of the message corresponding to *key*, or |
R. David Murray | b7deff1 | 2011-01-30 06:21:28 +0000 | [diff] [blame] | 194 | raise a :exc:`KeyError` exception if no such message exists. The |
| 195 | message is processed through :class:`email.message.Message` to |
| 196 | convert it to a 7bit clean representation. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 197 | |
| 198 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 199 | .. method:: get_file(key) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 200 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 201 | Return a file-like representation of the message corresponding to *key*, |
Georg Brandl | 6ce29fa | 2010-10-30 14:33:28 +0000 | [diff] [blame] | 202 | or raise a :exc:`KeyError` exception if no such message exists. The |
| 203 | file-like object behaves as if open in binary mode. This file should be |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 204 | closed once it is no longer needed. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 205 | |
R. David Murray | b7deff1 | 2011-01-30 06:21:28 +0000 | [diff] [blame] | 206 | .. versionchanged:: 3.2 |
| 207 | The file object really is a binary file; previously it was incorrectly |
| 208 | returned in text mode. Also, the file-like object now supports the |
Serhiy Storchaka | 1486799 | 2014-09-10 23:43:41 +0300 | [diff] [blame] | 209 | context management protocol: you can use a :keyword:`with` statement to |
R. David Murray | b7deff1 | 2011-01-30 06:21:28 +0000 | [diff] [blame] | 210 | automatically close it. |
Georg Brandl | 6ce29fa | 2010-10-30 14:33:28 +0000 | [diff] [blame] | 211 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 212 | .. note:: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 213 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 214 | Unlike other representations of messages, file-like representations are |
| 215 | not necessarily independent of the :class:`Mailbox` instance that |
Georg Brandl | 6ce29fa | 2010-10-30 14:33:28 +0000 | [diff] [blame] | 216 | created them or of the underlying mailbox. More specific documentation |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 217 | is provided by each subclass. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 218 | |
| 219 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 220 | .. method:: __contains__(key) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 221 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 222 | Return ``True`` if *key* corresponds to a message, ``False`` otherwise. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 223 | |
| 224 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 225 | .. method:: __len__() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 226 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 227 | Return a count of messages in the mailbox. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 228 | |
| 229 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 230 | .. method:: clear() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 231 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 232 | Delete all messages from the mailbox. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 233 | |
| 234 | |
Georg Brandl | cd7f32b | 2009-06-08 09:13:45 +0000 | [diff] [blame] | 235 | .. method:: pop(key, default=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 236 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 237 | Return a representation of the message corresponding to *key* and delete |
Georg Brandl | cd7f32b | 2009-06-08 09:13:45 +0000 | [diff] [blame] | 238 | the message. If no such message exists, return *default*. The message is |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 239 | represented as an instance of the appropriate format-specific |
| 240 | :class:`Message` subclass unless a custom message factory was specified |
| 241 | when the :class:`Mailbox` instance was initialized. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 242 | |
| 243 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 244 | .. method:: popitem() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 245 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 246 | Return an arbitrary (*key*, *message*) pair, where *key* is a key and |
| 247 | *message* is a message representation, and delete the corresponding |
| 248 | message. If the mailbox is empty, raise a :exc:`KeyError` exception. The |
| 249 | message is represented as an instance of the appropriate format-specific |
| 250 | :class:`Message` subclass unless a custom message factory was specified |
| 251 | when the :class:`Mailbox` instance was initialized. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 252 | |
| 253 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 254 | .. method:: update(arg) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 255 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 256 | Parameter *arg* should be a *key*-to-*message* mapping or an iterable of |
| 257 | (*key*, *message*) pairs. Updates the mailbox so that, for each given |
| 258 | *key* and *message*, the message corresponding to *key* is set to |
| 259 | *message* as if by using :meth:`__setitem__`. As with :meth:`__setitem__`, |
| 260 | each *key* must already correspond to a message in the mailbox or else a |
| 261 | :exc:`KeyError` exception will be raised, so in general it is incorrect |
| 262 | for *arg* to be a :class:`Mailbox` instance. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 263 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 264 | .. note:: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 265 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 266 | Unlike with dictionaries, keyword arguments are not supported. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 267 | |
| 268 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 269 | .. method:: flush() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 270 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 271 | Write any pending changes to the filesystem. For some :class:`Mailbox` |
| 272 | subclasses, changes are always written immediately and :meth:`flush` does |
| 273 | nothing, but you should still make a habit of calling this method. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 274 | |
| 275 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 276 | .. method:: lock() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 277 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 278 | Acquire an exclusive advisory lock on the mailbox so that other processes |
| 279 | know not to modify it. An :exc:`ExternalClashError` is raised if the lock |
| 280 | is not available. The particular locking mechanisms used depend upon the |
| 281 | mailbox format. You should *always* lock the mailbox before making any |
| 282 | modifications to its contents. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 283 | |
| 284 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 285 | .. method:: unlock() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 286 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 287 | Release the lock on the mailbox, if any. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 288 | |
| 289 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 290 | .. method:: close() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 291 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 292 | Flush the mailbox, unlock it if necessary, and close any open files. For |
| 293 | some :class:`Mailbox` subclasses, this method does nothing. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 294 | |
| 295 | |
| 296 | .. _mailbox-maildir: |
| 297 | |
| 298 | :class:`Maildir` |
| 299 | ^^^^^^^^^^^^^^^^ |
| 300 | |
| 301 | |
Georg Brandl | cd7f32b | 2009-06-08 09:13:45 +0000 | [diff] [blame] | 302 | .. class:: Maildir(dirname, factory=None, create=True) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 303 | |
| 304 | A subclass of :class:`Mailbox` for mailboxes in Maildir format. Parameter |
| 305 | *factory* is a callable object that accepts a file-like message representation |
| 306 | (which behaves as if opened in binary mode) and returns a custom representation. |
| 307 | If *factory* is ``None``, :class:`MaildirMessage` is used as the default message |
| 308 | representation. If *create* is ``True``, the mailbox is created if it does not |
| 309 | exist. |
| 310 | |
Georg Brandl | aa5b411 | 2008-05-11 20:51:18 +0000 | [diff] [blame] | 311 | It is for historical reasons that *dirname* is named as such rather than *path*. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 312 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 313 | Maildir is a directory-based mailbox format invented for the qmail mail |
| 314 | transfer agent and now widely supported by other programs. Messages in a |
| 315 | Maildir mailbox are stored in separate files within a common directory |
| 316 | structure. This design allows Maildir mailboxes to be accessed and modified |
| 317 | by multiple unrelated programs without data corruption, so file locking is |
| 318 | unnecessary. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 319 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 320 | Maildir mailboxes contain three subdirectories, namely: :file:`tmp`, |
| 321 | :file:`new`, and :file:`cur`. Messages are created momentarily in the |
| 322 | :file:`tmp` subdirectory and then moved to the :file:`new` subdirectory to |
| 323 | finalize delivery. A mail user agent may subsequently move the message to the |
| 324 | :file:`cur` subdirectory and store information about the state of the message |
| 325 | in a special "info" section appended to its file name. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 326 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 327 | Folders of the style introduced by the Courier mail transfer agent are also |
| 328 | supported. Any subdirectory of the main mailbox is considered a folder if |
| 329 | ``'.'`` is the first character in its name. Folder names are represented by |
| 330 | :class:`Maildir` without the leading ``'.'``. Each folder is itself a Maildir |
| 331 | mailbox but should not contain other folders. Instead, a logical nesting is |
| 332 | indicated using ``'.'`` to delimit levels, e.g., "Archived.2005.07". |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 333 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 334 | .. note:: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 335 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 336 | The Maildir specification requires the use of a colon (``':'``) in certain |
| 337 | message file names. However, some operating systems do not permit this |
| 338 | character in file names, If you wish to use a Maildir-like format on such |
| 339 | an operating system, you should specify another character to use |
| 340 | instead. The exclamation point (``'!'``) is a popular choice. For |
| 341 | example:: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 342 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 343 | import mailbox |
| 344 | mailbox.Maildir.colon = '!' |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 345 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 346 | The :attr:`colon` attribute may also be set on a per-instance basis. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 347 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 348 | :class:`Maildir` instances have all of the methods of :class:`Mailbox` in |
| 349 | addition to the following: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 350 | |
| 351 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 352 | .. method:: list_folders() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 353 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 354 | Return a list of the names of all folders. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 355 | |
| 356 | |
Ezio Melotti | 2d352d0 | 2009-09-15 18:51:37 +0000 | [diff] [blame] | 357 | .. method:: get_folder(folder) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 358 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 359 | Return a :class:`Maildir` instance representing the folder whose name is |
| 360 | *folder*. A :exc:`NoSuchMailboxError` exception is raised if the folder |
| 361 | does not exist. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 362 | |
| 363 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 364 | .. method:: add_folder(folder) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 365 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 366 | Create a folder whose name is *folder* and return a :class:`Maildir` |
| 367 | instance representing it. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 368 | |
| 369 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 370 | .. method:: remove_folder(folder) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 371 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 372 | Delete the folder whose name is *folder*. If the folder contains any |
| 373 | messages, a :exc:`NotEmptyError` exception will be raised and the folder |
| 374 | will not be deleted. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 375 | |
| 376 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 377 | .. method:: clean() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 378 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 379 | Delete temporary files from the mailbox that have not been accessed in the |
| 380 | last 36 hours. The Maildir specification says that mail-reading programs |
| 381 | should do this occasionally. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 382 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 383 | Some :class:`Mailbox` methods implemented by :class:`Maildir` deserve special |
| 384 | remarks: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 385 | |
| 386 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 387 | .. method:: add(message) |
| 388 | __setitem__(key, message) |
| 389 | update(arg) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 390 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 391 | .. warning:: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 392 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 393 | These methods generate unique file names based upon the current process |
| 394 | ID. When using multiple threads, undetected name clashes may occur and |
| 395 | cause corruption of the mailbox unless threads are coordinated to avoid |
| 396 | using these methods to manipulate the same mailbox simultaneously. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 397 | |
| 398 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 399 | .. method:: flush() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 400 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 401 | All changes to Maildir mailboxes are immediately applied, so this method |
| 402 | does nothing. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 403 | |
| 404 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 405 | .. method:: lock() |
| 406 | unlock() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 407 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 408 | Maildir mailboxes do not support (or require) locking, so these methods do |
| 409 | nothing. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 410 | |
| 411 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 412 | .. method:: close() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 413 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 414 | :class:`Maildir` instances do not keep any open files and the underlying |
| 415 | mailboxes do not support locking, so this method does nothing. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 416 | |
| 417 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 418 | .. method:: get_file(key) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 419 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 420 | Depending upon the host platform, it may not be possible to modify or |
| 421 | remove the underlying message while the returned file remains open. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 422 | |
| 423 | |
| 424 | .. seealso:: |
| 425 | |
| 426 | `maildir man page from qmail <http://www.qmail.org/man/man5/maildir.html>`_ |
| 427 | The original specification of the format. |
| 428 | |
Serhiy Storchaka | 6dff020 | 2016-05-07 10:49:07 +0300 | [diff] [blame] | 429 | `Using maildir format <https://cr.yp.to/proto/maildir.html>`_ |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 430 | Notes on Maildir by its inventor. Includes an updated name-creation scheme and |
| 431 | details on "info" semantics. |
| 432 | |
Christian Heimes | dd15f6c | 2008-03-16 00:07:10 +0000 | [diff] [blame] | 433 | `maildir man page from Courier <http://www.courier-mta.org/maildir.html>`_ |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 434 | Another specification of the format. Describes a common extension for supporting |
| 435 | folders. |
| 436 | |
| 437 | |
| 438 | .. _mailbox-mbox: |
| 439 | |
| 440 | :class:`mbox` |
| 441 | ^^^^^^^^^^^^^ |
| 442 | |
| 443 | |
Georg Brandl | cd7f32b | 2009-06-08 09:13:45 +0000 | [diff] [blame] | 444 | .. class:: mbox(path, factory=None, create=True) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 445 | |
| 446 | A subclass of :class:`Mailbox` for mailboxes in mbox format. Parameter *factory* |
| 447 | is a callable object that accepts a file-like message representation (which |
| 448 | behaves as if opened in binary mode) and returns a custom representation. If |
| 449 | *factory* is ``None``, :class:`mboxMessage` is used as the default message |
| 450 | representation. If *create* is ``True``, the mailbox is created if it does not |
| 451 | exist. |
| 452 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 453 | The mbox format is the classic format for storing mail on Unix systems. All |
| 454 | messages in an mbox mailbox are stored in a single file with the beginning of |
| 455 | each message indicated by a line whose first five characters are "From ". |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 456 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 457 | Several variations of the mbox format exist to address perceived shortcomings in |
| 458 | the original. In the interest of compatibility, :class:`mbox` implements the |
| 459 | original format, which is sometimes referred to as :dfn:`mboxo`. This means that |
| 460 | the :mailheader:`Content-Length` header, if present, is ignored and that any |
| 461 | occurrences of "From " at the beginning of a line in a message body are |
| 462 | transformed to ">From " when storing the message, although occurrences of ">From |
| 463 | " are not transformed to "From " when reading the message. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 464 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 465 | Some :class:`Mailbox` methods implemented by :class:`mbox` deserve special |
| 466 | remarks: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 467 | |
| 468 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 469 | .. method:: get_file(key) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 470 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 471 | Using the file after calling :meth:`flush` or :meth:`close` on the |
| 472 | :class:`mbox` instance may yield unpredictable results or raise an |
| 473 | exception. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 474 | |
| 475 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 476 | .. method:: lock() |
| 477 | unlock() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 478 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 479 | Three locking mechanisms are used---dot locking and, if available, the |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 480 | :c:func:`flock` and :c:func:`lockf` system calls. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 481 | |
| 482 | |
| 483 | .. seealso:: |
| 484 | |
| 485 | `mbox man page from qmail <http://www.qmail.org/man/man5/mbox.html>`_ |
| 486 | A specification of the format and its variations. |
| 487 | |
| 488 | `mbox man page from tin <http://www.tin.org/bin/man.cgi?section=5&topic=mbox>`_ |
| 489 | Another specification of the format, with details on locking. |
| 490 | |
Georg Brandl | 5d94134 | 2016-02-26 19:37:12 +0100 | [diff] [blame] | 491 | `Configuring Netscape Mail on Unix: Why The Content-Length Format is Bad <https://www.jwz.org/doc/content-length.html>`_ |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 492 | An argument for using the original mbox format rather than a variation. |
| 493 | |
Georg Brandl | 525d355 | 2014-10-29 10:26:56 +0100 | [diff] [blame] | 494 | `"mbox" is a family of several mutually incompatible mailbox formats <http://homepage.ntlworld.com/jonathan.deboynepollard/FGA/mail-mbox-formats.html>`_ |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 495 | A history of mbox variations. |
| 496 | |
| 497 | |
| 498 | .. _mailbox-mh: |
| 499 | |
| 500 | :class:`MH` |
| 501 | ^^^^^^^^^^^ |
| 502 | |
| 503 | |
Georg Brandl | cd7f32b | 2009-06-08 09:13:45 +0000 | [diff] [blame] | 504 | .. class:: MH(path, factory=None, create=True) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 505 | |
| 506 | A subclass of :class:`Mailbox` for mailboxes in MH format. Parameter *factory* |
| 507 | is a callable object that accepts a file-like message representation (which |
| 508 | behaves as if opened in binary mode) and returns a custom representation. If |
| 509 | *factory* is ``None``, :class:`MHMessage` is used as the default message |
| 510 | representation. If *create* is ``True``, the mailbox is created if it does not |
| 511 | exist. |
| 512 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 513 | MH is a directory-based mailbox format invented for the MH Message Handling |
| 514 | System, a mail user agent. Each message in an MH mailbox resides in its own |
| 515 | file. An MH mailbox may contain other MH mailboxes (called :dfn:`folders`) in |
| 516 | addition to messages. Folders may be nested indefinitely. MH mailboxes also |
| 517 | support :dfn:`sequences`, which are named lists used to logically group |
| 518 | messages without moving them to sub-folders. Sequences are defined in a file |
| 519 | called :file:`.mh_sequences` in each folder. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 520 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 521 | The :class:`MH` class manipulates MH mailboxes, but it does not attempt to |
| 522 | emulate all of :program:`mh`'s behaviors. In particular, it does not modify |
| 523 | and is not affected by the :file:`context` or :file:`.mh_profile` files that |
| 524 | are used by :program:`mh` to store its state and configuration. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 525 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 526 | :class:`MH` instances have all of the methods of :class:`Mailbox` in addition |
| 527 | to the following: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 528 | |
| 529 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 530 | .. method:: list_folders() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 531 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 532 | Return a list of the names of all folders. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 533 | |
| 534 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 535 | .. method:: get_folder(folder) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 536 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 537 | Return an :class:`MH` instance representing the folder whose name is |
| 538 | *folder*. A :exc:`NoSuchMailboxError` exception is raised if the folder |
| 539 | does not exist. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 540 | |
| 541 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 542 | .. method:: add_folder(folder) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 543 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 544 | Create a folder whose name is *folder* and return an :class:`MH` instance |
| 545 | representing it. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 546 | |
| 547 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 548 | .. method:: remove_folder(folder) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 549 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 550 | Delete the folder whose name is *folder*. If the folder contains any |
| 551 | messages, a :exc:`NotEmptyError` exception will be raised and the folder |
| 552 | will not be deleted. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 553 | |
| 554 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 555 | .. method:: get_sequences() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 556 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 557 | Return a dictionary of sequence names mapped to key lists. If there are no |
| 558 | sequences, the empty dictionary is returned. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 559 | |
| 560 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 561 | .. method:: set_sequences(sequences) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 562 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 563 | Re-define the sequences that exist in the mailbox based upon *sequences*, |
| 564 | a dictionary of names mapped to key lists, like returned by |
| 565 | :meth:`get_sequences`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 566 | |
| 567 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 568 | .. method:: pack() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 569 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 570 | Rename messages in the mailbox as necessary to eliminate gaps in |
| 571 | numbering. Entries in the sequences list are updated correspondingly. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 572 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 573 | .. note:: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 574 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 575 | Already-issued keys are invalidated by this operation and should not be |
| 576 | subsequently used. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 577 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 578 | Some :class:`Mailbox` methods implemented by :class:`MH` deserve special |
| 579 | remarks: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 580 | |
| 581 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 582 | .. method:: remove(key) |
| 583 | __delitem__(key) |
| 584 | discard(key) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 585 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 586 | These methods immediately delete the message. The MH convention of marking |
| 587 | a message for deletion by prepending a comma to its name is not used. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 588 | |
| 589 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 590 | .. method:: lock() |
| 591 | unlock() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 592 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 593 | Three locking mechanisms are used---dot locking and, if available, the |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 594 | :c:func:`flock` and :c:func:`lockf` system calls. For MH mailboxes, locking |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 595 | the mailbox means locking the :file:`.mh_sequences` file and, only for the |
| 596 | duration of any operations that affect them, locking individual message |
| 597 | files. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 598 | |
| 599 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 600 | .. method:: get_file(key) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 601 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 602 | Depending upon the host platform, it may not be possible to remove the |
| 603 | underlying message while the returned file remains open. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 604 | |
| 605 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 606 | .. method:: flush() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 607 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 608 | All changes to MH mailboxes are immediately applied, so this method does |
| 609 | nothing. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 610 | |
| 611 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 612 | .. method:: close() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 613 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 614 | :class:`MH` instances do not keep any open files, so this method is |
| 615 | equivalent to :meth:`unlock`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 616 | |
| 617 | |
| 618 | .. seealso:: |
| 619 | |
| 620 | `nmh - Message Handling System <http://www.nongnu.org/nmh/>`_ |
| 621 | Home page of :program:`nmh`, an updated version of the original :program:`mh`. |
| 622 | |
Georg Brandl | 495f7b5 | 2009-10-27 15:28:25 +0000 | [diff] [blame] | 623 | `MH & nmh: Email for Users & Programmers <http://rand-mh.sourceforge.net/book/>`_ |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 624 | A GPL-licensed book on :program:`mh` and :program:`nmh`, with some information |
| 625 | on the mailbox format. |
| 626 | |
| 627 | |
| 628 | .. _mailbox-babyl: |
| 629 | |
| 630 | :class:`Babyl` |
| 631 | ^^^^^^^^^^^^^^ |
| 632 | |
| 633 | |
Georg Brandl | cd7f32b | 2009-06-08 09:13:45 +0000 | [diff] [blame] | 634 | .. class:: Babyl(path, factory=None, create=True) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 635 | |
| 636 | A subclass of :class:`Mailbox` for mailboxes in Babyl format. Parameter |
| 637 | *factory* is a callable object that accepts a file-like message representation |
| 638 | (which behaves as if opened in binary mode) and returns a custom representation. |
| 639 | If *factory* is ``None``, :class:`BabylMessage` is used as the default message |
| 640 | representation. If *create* is ``True``, the mailbox is created if it does not |
| 641 | exist. |
| 642 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 643 | Babyl is a single-file mailbox format used by the Rmail mail user agent |
| 644 | included with Emacs. The beginning of a message is indicated by a line |
| 645 | containing the two characters Control-Underscore (``'\037'``) and Control-L |
| 646 | (``'\014'``). The end of a message is indicated by the start of the next |
| 647 | message or, in the case of the last message, a line containing a |
| 648 | Control-Underscore (``'\037'``) character. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 649 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 650 | Messages in a Babyl mailbox have two sets of headers, original headers and |
| 651 | so-called visible headers. Visible headers are typically a subset of the |
| 652 | original headers that have been reformatted or abridged to be more |
| 653 | attractive. Each message in a Babyl mailbox also has an accompanying list of |
| 654 | :dfn:`labels`, or short strings that record extra information about the |
| 655 | message, and a list of all user-defined labels found in the mailbox is kept |
| 656 | in the Babyl options section. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 657 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 658 | :class:`Babyl` instances have all of the methods of :class:`Mailbox` in |
| 659 | addition to the following: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 660 | |
| 661 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 662 | .. method:: get_labels() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 663 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 664 | Return a list of the names of all user-defined labels used in the mailbox. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 665 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 666 | .. note:: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 667 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 668 | The actual messages are inspected to determine which labels exist in |
| 669 | the mailbox rather than consulting the list of labels in the Babyl |
| 670 | options section, but the Babyl section is updated whenever the mailbox |
| 671 | is modified. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 672 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 673 | Some :class:`Mailbox` methods implemented by :class:`Babyl` deserve special |
| 674 | remarks: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 675 | |
| 676 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 677 | .. method:: get_file(key) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 678 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 679 | In Babyl mailboxes, the headers of a message are not stored contiguously |
| 680 | with the body of the message. To generate a file-like representation, the |
Martin Panter | 7462b649 | 2015-11-02 03:37:02 +0000 | [diff] [blame] | 681 | headers and body are copied together into an :class:`io.BytesIO` instance, |
Serhiy Storchaka | e79be87 | 2013-08-17 00:09:55 +0300 | [diff] [blame] | 682 | which has an API identical to that of a |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 683 | file. As a result, the file-like object is truly independent of the |
| 684 | underlying mailbox but does not save memory compared to a string |
| 685 | representation. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 686 | |
| 687 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 688 | .. method:: lock() |
| 689 | unlock() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 690 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 691 | Three locking mechanisms are used---dot locking and, if available, the |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 692 | :c:func:`flock` and :c:func:`lockf` system calls. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 693 | |
| 694 | |
| 695 | .. seealso:: |
| 696 | |
Serhiy Storchaka | 6dff020 | 2016-05-07 10:49:07 +0300 | [diff] [blame] | 697 | `Format of Version 5 Babyl Files <https://quimby.gnus.org/notes/BABYL>`_ |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 698 | A specification of the Babyl format. |
| 699 | |
Serhiy Storchaka | 6dff020 | 2016-05-07 10:49:07 +0300 | [diff] [blame] | 700 | `Reading Mail with Rmail <https://www.gnu.org/software/emacs/manual/html_node/emacs/Rmail.html>`_ |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 701 | The Rmail manual, with some information on Babyl semantics. |
| 702 | |
| 703 | |
| 704 | .. _mailbox-mmdf: |
| 705 | |
| 706 | :class:`MMDF` |
| 707 | ^^^^^^^^^^^^^ |
| 708 | |
| 709 | |
Georg Brandl | cd7f32b | 2009-06-08 09:13:45 +0000 | [diff] [blame] | 710 | .. class:: MMDF(path, factory=None, create=True) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 711 | |
| 712 | A subclass of :class:`Mailbox` for mailboxes in MMDF format. Parameter *factory* |
| 713 | is a callable object that accepts a file-like message representation (which |
| 714 | behaves as if opened in binary mode) and returns a custom representation. If |
| 715 | *factory* is ``None``, :class:`MMDFMessage` is used as the default message |
| 716 | representation. If *create* is ``True``, the mailbox is created if it does not |
| 717 | exist. |
| 718 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 719 | MMDF is a single-file mailbox format invented for the Multichannel Memorandum |
| 720 | Distribution Facility, a mail transfer agent. Each message is in the same |
| 721 | form as an mbox message but is bracketed before and after by lines containing |
| 722 | four Control-A (``'\001'``) characters. As with the mbox format, the |
| 723 | beginning of each message is indicated by a line whose first five characters |
| 724 | are "From ", but additional occurrences of "From " are not transformed to |
| 725 | ">From " when storing messages because the extra message separator lines |
| 726 | prevent mistaking such occurrences for the starts of subsequent messages. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 727 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 728 | Some :class:`Mailbox` methods implemented by :class:`MMDF` deserve special |
| 729 | remarks: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 730 | |
| 731 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 732 | .. method:: get_file(key) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 733 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 734 | Using the file after calling :meth:`flush` or :meth:`close` on the |
| 735 | :class:`MMDF` instance may yield unpredictable results or raise an |
| 736 | exception. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 737 | |
| 738 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 739 | .. method:: lock() |
| 740 | unlock() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 741 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 742 | Three locking mechanisms are used---dot locking and, if available, the |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 743 | :c:func:`flock` and :c:func:`lockf` system calls. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 744 | |
| 745 | |
| 746 | .. seealso:: |
| 747 | |
| 748 | `mmdf man page from tin <http://www.tin.org/bin/man.cgi?section=5&topic=mmdf>`_ |
| 749 | A specification of MMDF format from the documentation of tin, a newsreader. |
| 750 | |
Georg Brandl | 5d94134 | 2016-02-26 19:37:12 +0100 | [diff] [blame] | 751 | `MMDF <https://en.wikipedia.org/wiki/MMDF>`_ |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 752 | A Wikipedia article describing the Multichannel Memorandum Distribution |
| 753 | Facility. |
| 754 | |
| 755 | |
| 756 | .. _mailbox-message-objects: |
| 757 | |
| 758 | :class:`Message` objects |
| 759 | ------------------------ |
| 760 | |
| 761 | |
Georg Brandl | cd7f32b | 2009-06-08 09:13:45 +0000 | [diff] [blame] | 762 | .. class:: Message(message=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 763 | |
R David Murray | c5fe407 | 2012-09-28 15:09:31 -0400 | [diff] [blame] | 764 | A subclass of the :mod:`email.message` module's |
| 765 | :class:`~email.message.Message`. Subclasses of :class:`mailbox.Message` add |
| 766 | mailbox-format-specific state and behavior. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 767 | |
| 768 | If *message* is omitted, the new instance is created in a default, empty state. |
R David Murray | c5fe407 | 2012-09-28 15:09:31 -0400 | [diff] [blame] | 769 | If *message* is an :class:`email.message.Message` instance, its contents are |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 770 | copied; furthermore, any format-specific information is converted insofar as |
R. David Murray | b7deff1 | 2011-01-30 06:21:28 +0000 | [diff] [blame] | 771 | possible if *message* is a :class:`Message` instance. If *message* is a string, |
| 772 | a byte string, |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 773 | or a file, it should contain an :rfc:`2822`\ -compliant message, which is read |
R. David Murray | b7deff1 | 2011-01-30 06:21:28 +0000 | [diff] [blame] | 774 | and parsed. Files should be open in binary mode, but text mode files |
| 775 | are accepted for backward compatibility. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 776 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 777 | The format-specific state and behaviors offered by subclasses vary, but in |
| 778 | general it is only the properties that are not specific to a particular |
| 779 | mailbox that are supported (although presumably the properties are specific |
| 780 | to a particular mailbox format). For example, file offsets for single-file |
| 781 | mailbox formats and file names for directory-based mailbox formats are not |
| 782 | retained, because they are only applicable to the original mailbox. But state |
| 783 | such as whether a message has been read by the user or marked as important is |
| 784 | retained, because it applies to the message itself. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 785 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 786 | There is no requirement that :class:`Message` instances be used to represent |
| 787 | messages retrieved using :class:`Mailbox` instances. In some situations, the |
| 788 | time and memory required to generate :class:`Message` representations might |
Ezio Melotti | e130a52 | 2011-10-19 10:58:56 +0300 | [diff] [blame] | 789 | not be acceptable. For such situations, :class:`Mailbox` instances also |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 790 | offer string and file-like representations, and a custom message factory may |
| 791 | be specified when a :class:`Mailbox` instance is initialized. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 792 | |
| 793 | |
| 794 | .. _mailbox-maildirmessage: |
| 795 | |
| 796 | :class:`MaildirMessage` |
| 797 | ^^^^^^^^^^^^^^^^^^^^^^^ |
| 798 | |
| 799 | |
Georg Brandl | cd7f32b | 2009-06-08 09:13:45 +0000 | [diff] [blame] | 800 | .. class:: MaildirMessage(message=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 801 | |
| 802 | A message with Maildir-specific behaviors. Parameter *message* has the same |
| 803 | meaning as with the :class:`Message` constructor. |
| 804 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 805 | Typically, a mail user agent application moves all of the messages in the |
| 806 | :file:`new` subdirectory to the :file:`cur` subdirectory after the first time |
| 807 | the user opens and closes the mailbox, recording that the messages are old |
| 808 | whether or not they've actually been read. Each message in :file:`cur` has an |
| 809 | "info" section added to its file name to store information about its state. |
| 810 | (Some mail readers may also add an "info" section to messages in |
| 811 | :file:`new`.) The "info" section may take one of two forms: it may contain |
| 812 | "2," followed by a list of standardized flags (e.g., "2,FR") or it may |
| 813 | contain "1," followed by so-called experimental information. Standard flags |
| 814 | for Maildir messages are as follows: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 815 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 816 | +------+---------+--------------------------------+ |
| 817 | | Flag | Meaning | Explanation | |
| 818 | +======+=========+================================+ |
| 819 | | D | Draft | Under composition | |
| 820 | +------+---------+--------------------------------+ |
| 821 | | F | Flagged | Marked as important | |
| 822 | +------+---------+--------------------------------+ |
| 823 | | P | Passed | Forwarded, resent, or bounced | |
| 824 | +------+---------+--------------------------------+ |
| 825 | | R | Replied | Replied to | |
| 826 | +------+---------+--------------------------------+ |
| 827 | | S | Seen | Read | |
| 828 | +------+---------+--------------------------------+ |
| 829 | | T | Trashed | Marked for subsequent deletion | |
| 830 | +------+---------+--------------------------------+ |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 831 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 832 | :class:`MaildirMessage` instances offer the following methods: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 833 | |
| 834 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 835 | .. method:: get_subdir() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 836 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 837 | Return either "new" (if the message should be stored in the :file:`new` |
| 838 | subdirectory) or "cur" (if the message should be stored in the :file:`cur` |
| 839 | subdirectory). |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 840 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 841 | .. note:: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 842 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 843 | A message is typically moved from :file:`new` to :file:`cur` after its |
| 844 | mailbox has been accessed, whether or not the message is has been |
| 845 | read. A message ``msg`` has been read if ``"S" in msg.get_flags()`` is |
| 846 | ``True``. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 847 | |
| 848 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 849 | .. method:: set_subdir(subdir) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 850 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 851 | Set the subdirectory the message should be stored in. Parameter *subdir* |
| 852 | must be either "new" or "cur". |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 853 | |
| 854 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 855 | .. method:: get_flags() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 856 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 857 | Return a string specifying the flags that are currently set. If the |
| 858 | message complies with the standard Maildir format, the result is the |
| 859 | concatenation in alphabetical order of zero or one occurrence of each of |
| 860 | ``'D'``, ``'F'``, ``'P'``, ``'R'``, ``'S'``, and ``'T'``. The empty string |
| 861 | is returned if no flags are set or if "info" contains experimental |
| 862 | semantics. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 863 | |
| 864 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 865 | .. method:: set_flags(flags) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 866 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 867 | Set the flags specified by *flags* and unset all others. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 868 | |
| 869 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 870 | .. method:: add_flag(flag) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 871 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 872 | Set the flag(s) specified by *flag* without changing other flags. To add |
| 873 | more than one flag at a time, *flag* may be a string of more than one |
| 874 | character. The current "info" is overwritten whether or not it contains |
| 875 | experimental information rather than flags. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 876 | |
| 877 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 878 | .. method:: remove_flag(flag) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 879 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 880 | Unset the flag(s) specified by *flag* without changing other flags. To |
| 881 | remove more than one flag at a time, *flag* maybe a string of more than |
| 882 | one character. If "info" contains experimental information rather than |
| 883 | flags, the current "info" is not modified. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 884 | |
| 885 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 886 | .. method:: get_date() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 887 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 888 | Return the delivery date of the message as a floating-point number |
| 889 | representing seconds since the epoch. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 890 | |
| 891 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 892 | .. method:: set_date(date) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 893 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 894 | Set the delivery date of the message to *date*, a floating-point number |
| 895 | representing seconds since the epoch. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 896 | |
| 897 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 898 | .. method:: get_info() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 899 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 900 | Return a string containing the "info" for a message. This is useful for |
| 901 | accessing and modifying "info" that is experimental (i.e., not a list of |
| 902 | flags). |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 903 | |
| 904 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 905 | .. method:: set_info(info) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 906 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 907 | Set "info" to *info*, which should be a string. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 908 | |
| 909 | When a :class:`MaildirMessage` instance is created based upon an |
| 910 | :class:`mboxMessage` or :class:`MMDFMessage` instance, the :mailheader:`Status` |
| 911 | and :mailheader:`X-Status` headers are omitted and the following conversions |
| 912 | take place: |
| 913 | |
| 914 | +--------------------+----------------------------------------------+ |
| 915 | | Resulting state | :class:`mboxMessage` or :class:`MMDFMessage` | |
| 916 | | | state | |
| 917 | +====================+==============================================+ |
| 918 | | "cur" subdirectory | O flag | |
| 919 | +--------------------+----------------------------------------------+ |
| 920 | | F flag | F flag | |
| 921 | +--------------------+----------------------------------------------+ |
| 922 | | R flag | A flag | |
| 923 | +--------------------+----------------------------------------------+ |
| 924 | | S flag | R flag | |
| 925 | +--------------------+----------------------------------------------+ |
| 926 | | T flag | D flag | |
| 927 | +--------------------+----------------------------------------------+ |
| 928 | |
| 929 | When a :class:`MaildirMessage` instance is created based upon an |
| 930 | :class:`MHMessage` instance, the following conversions take place: |
| 931 | |
| 932 | +-------------------------------+--------------------------+ |
| 933 | | Resulting state | :class:`MHMessage` state | |
| 934 | +===============================+==========================+ |
| 935 | | "cur" subdirectory | "unseen" sequence | |
| 936 | +-------------------------------+--------------------------+ |
| 937 | | "cur" subdirectory and S flag | no "unseen" sequence | |
| 938 | +-------------------------------+--------------------------+ |
| 939 | | F flag | "flagged" sequence | |
| 940 | +-------------------------------+--------------------------+ |
| 941 | | R flag | "replied" sequence | |
| 942 | +-------------------------------+--------------------------+ |
| 943 | |
| 944 | When a :class:`MaildirMessage` instance is created based upon a |
| 945 | :class:`BabylMessage` instance, the following conversions take place: |
| 946 | |
| 947 | +-------------------------------+-------------------------------+ |
| 948 | | Resulting state | :class:`BabylMessage` state | |
| 949 | +===============================+===============================+ |
| 950 | | "cur" subdirectory | "unseen" label | |
| 951 | +-------------------------------+-------------------------------+ |
| 952 | | "cur" subdirectory and S flag | no "unseen" label | |
| 953 | +-------------------------------+-------------------------------+ |
| 954 | | P flag | "forwarded" or "resent" label | |
| 955 | +-------------------------------+-------------------------------+ |
| 956 | | R flag | "answered" label | |
| 957 | +-------------------------------+-------------------------------+ |
| 958 | | T flag | "deleted" label | |
| 959 | +-------------------------------+-------------------------------+ |
| 960 | |
| 961 | |
| 962 | .. _mailbox-mboxmessage: |
| 963 | |
| 964 | :class:`mboxMessage` |
| 965 | ^^^^^^^^^^^^^^^^^^^^ |
| 966 | |
| 967 | |
Georg Brandl | cd7f32b | 2009-06-08 09:13:45 +0000 | [diff] [blame] | 968 | .. class:: mboxMessage(message=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 969 | |
| 970 | A message with mbox-specific behaviors. Parameter *message* has the same meaning |
| 971 | as with the :class:`Message` constructor. |
| 972 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 973 | Messages in an mbox mailbox are stored together in a single file. The |
| 974 | sender's envelope address and the time of delivery are typically stored in a |
| 975 | line beginning with "From " that is used to indicate the start of a message, |
| 976 | though there is considerable variation in the exact format of this data among |
| 977 | mbox implementations. Flags that indicate the state of the message, such as |
| 978 | whether it has been read or marked as important, are typically stored in |
| 979 | :mailheader:`Status` and :mailheader:`X-Status` headers. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 980 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 981 | Conventional flags for mbox messages are as follows: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 982 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 983 | +------+----------+--------------------------------+ |
| 984 | | Flag | Meaning | Explanation | |
| 985 | +======+==========+================================+ |
| 986 | | R | Read | Read | |
| 987 | +------+----------+--------------------------------+ |
| 988 | | O | Old | Previously detected by MUA | |
| 989 | +------+----------+--------------------------------+ |
| 990 | | D | Deleted | Marked for subsequent deletion | |
| 991 | +------+----------+--------------------------------+ |
| 992 | | F | Flagged | Marked as important | |
| 993 | +------+----------+--------------------------------+ |
| 994 | | A | Answered | Replied to | |
| 995 | +------+----------+--------------------------------+ |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 996 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 997 | The "R" and "O" flags are stored in the :mailheader:`Status` header, and the |
| 998 | "D", "F", and "A" flags are stored in the :mailheader:`X-Status` header. The |
| 999 | flags and headers typically appear in the order mentioned. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1000 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1001 | :class:`mboxMessage` instances offer the following methods: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1002 | |
| 1003 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1004 | .. method:: get_from() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1005 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1006 | Return a string representing the "From " line that marks the start of the |
| 1007 | message in an mbox mailbox. The leading "From " and the trailing newline |
| 1008 | are excluded. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1009 | |
| 1010 | |
Georg Brandl | cd7f32b | 2009-06-08 09:13:45 +0000 | [diff] [blame] | 1011 | .. method:: set_from(from_, time_=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1012 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1013 | Set the "From " line to *from_*, which should be specified without a |
| 1014 | leading "From " or trailing newline. For convenience, *time_* may be |
| 1015 | specified and will be formatted appropriately and appended to *from_*. If |
Serhiy Storchaka | bfdcd43 | 2013-10-13 23:09:14 +0300 | [diff] [blame] | 1016 | *time_* is specified, it should be a :class:`time.struct_time` instance, a |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1017 | tuple suitable for passing to :meth:`time.strftime`, or ``True`` (to use |
| 1018 | :meth:`time.gmtime`). |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1019 | |
| 1020 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1021 | .. method:: get_flags() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1022 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1023 | Return a string specifying the flags that are currently set. If the |
| 1024 | message complies with the conventional format, the result is the |
| 1025 | concatenation in the following order of zero or one occurrence of each of |
| 1026 | ``'R'``, ``'O'``, ``'D'``, ``'F'``, and ``'A'``. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1027 | |
| 1028 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1029 | .. method:: set_flags(flags) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1030 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1031 | Set the flags specified by *flags* and unset all others. Parameter *flags* |
| 1032 | should be the concatenation in any order of zero or more occurrences of |
| 1033 | each of ``'R'``, ``'O'``, ``'D'``, ``'F'``, and ``'A'``. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1034 | |
| 1035 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1036 | .. method:: add_flag(flag) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1037 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1038 | Set the flag(s) specified by *flag* without changing other flags. To add |
| 1039 | more than one flag at a time, *flag* may be a string of more than one |
| 1040 | character. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1041 | |
| 1042 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1043 | .. method:: remove_flag(flag) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1044 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1045 | Unset the flag(s) specified by *flag* without changing other flags. To |
| 1046 | remove more than one flag at a time, *flag* maybe a string of more than |
| 1047 | one character. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1048 | |
| 1049 | When an :class:`mboxMessage` instance is created based upon a |
| 1050 | :class:`MaildirMessage` instance, a "From " line is generated based upon the |
| 1051 | :class:`MaildirMessage` instance's delivery date, and the following conversions |
| 1052 | take place: |
| 1053 | |
| 1054 | +-----------------+-------------------------------+ |
| 1055 | | Resulting state | :class:`MaildirMessage` state | |
| 1056 | +=================+===============================+ |
| 1057 | | R flag | S flag | |
| 1058 | +-----------------+-------------------------------+ |
| 1059 | | O flag | "cur" subdirectory | |
| 1060 | +-----------------+-------------------------------+ |
| 1061 | | D flag | T flag | |
| 1062 | +-----------------+-------------------------------+ |
| 1063 | | F flag | F flag | |
| 1064 | +-----------------+-------------------------------+ |
| 1065 | | A flag | R flag | |
| 1066 | +-----------------+-------------------------------+ |
| 1067 | |
| 1068 | When an :class:`mboxMessage` instance is created based upon an |
| 1069 | :class:`MHMessage` instance, the following conversions take place: |
| 1070 | |
| 1071 | +-------------------+--------------------------+ |
| 1072 | | Resulting state | :class:`MHMessage` state | |
| 1073 | +===================+==========================+ |
| 1074 | | R flag and O flag | no "unseen" sequence | |
| 1075 | +-------------------+--------------------------+ |
| 1076 | | O flag | "unseen" sequence | |
| 1077 | +-------------------+--------------------------+ |
| 1078 | | F flag | "flagged" sequence | |
| 1079 | +-------------------+--------------------------+ |
| 1080 | | A flag | "replied" sequence | |
| 1081 | +-------------------+--------------------------+ |
| 1082 | |
| 1083 | When an :class:`mboxMessage` instance is created based upon a |
| 1084 | :class:`BabylMessage` instance, the following conversions take place: |
| 1085 | |
| 1086 | +-------------------+-----------------------------+ |
| 1087 | | Resulting state | :class:`BabylMessage` state | |
| 1088 | +===================+=============================+ |
| 1089 | | R flag and O flag | no "unseen" label | |
| 1090 | +-------------------+-----------------------------+ |
| 1091 | | O flag | "unseen" label | |
| 1092 | +-------------------+-----------------------------+ |
| 1093 | | D flag | "deleted" label | |
| 1094 | +-------------------+-----------------------------+ |
| 1095 | | A flag | "answered" label | |
| 1096 | +-------------------+-----------------------------+ |
| 1097 | |
| 1098 | When a :class:`Message` instance is created based upon an :class:`MMDFMessage` |
| 1099 | instance, the "From " line is copied and all flags directly correspond: |
| 1100 | |
| 1101 | +-----------------+----------------------------+ |
| 1102 | | Resulting state | :class:`MMDFMessage` state | |
| 1103 | +=================+============================+ |
| 1104 | | R flag | R flag | |
| 1105 | +-----------------+----------------------------+ |
| 1106 | | O flag | O flag | |
| 1107 | +-----------------+----------------------------+ |
| 1108 | | D flag | D flag | |
| 1109 | +-----------------+----------------------------+ |
| 1110 | | F flag | F flag | |
| 1111 | +-----------------+----------------------------+ |
| 1112 | | A flag | A flag | |
| 1113 | +-----------------+----------------------------+ |
| 1114 | |
| 1115 | |
| 1116 | .. _mailbox-mhmessage: |
| 1117 | |
| 1118 | :class:`MHMessage` |
| 1119 | ^^^^^^^^^^^^^^^^^^ |
| 1120 | |
| 1121 | |
Georg Brandl | cd7f32b | 2009-06-08 09:13:45 +0000 | [diff] [blame] | 1122 | .. class:: MHMessage(message=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1123 | |
| 1124 | A message with MH-specific behaviors. Parameter *message* has the same meaning |
| 1125 | as with the :class:`Message` constructor. |
| 1126 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1127 | MH messages do not support marks or flags in the traditional sense, but they |
| 1128 | do support sequences, which are logical groupings of arbitrary messages. Some |
| 1129 | mail reading programs (although not the standard :program:`mh` and |
| 1130 | :program:`nmh`) use sequences in much the same way flags are used with other |
| 1131 | formats, as follows: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1132 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1133 | +----------+------------------------------------------+ |
| 1134 | | Sequence | Explanation | |
| 1135 | +==========+==========================================+ |
| 1136 | | unseen | Not read, but previously detected by MUA | |
| 1137 | +----------+------------------------------------------+ |
| 1138 | | replied | Replied to | |
| 1139 | +----------+------------------------------------------+ |
| 1140 | | flagged | Marked as important | |
| 1141 | +----------+------------------------------------------+ |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1142 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1143 | :class:`MHMessage` instances offer the following methods: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1144 | |
| 1145 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1146 | .. method:: get_sequences() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1147 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1148 | Return a list of the names of sequences that include this message. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1149 | |
| 1150 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1151 | .. method:: set_sequences(sequences) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1152 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1153 | Set the list of sequences that include this message. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1154 | |
| 1155 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1156 | .. method:: add_sequence(sequence) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1157 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1158 | Add *sequence* to the list of sequences that include this message. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1159 | |
| 1160 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1161 | .. method:: remove_sequence(sequence) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1162 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1163 | Remove *sequence* from the list of sequences that include this message. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1164 | |
| 1165 | When an :class:`MHMessage` instance is created based upon a |
| 1166 | :class:`MaildirMessage` instance, the following conversions take place: |
| 1167 | |
| 1168 | +--------------------+-------------------------------+ |
| 1169 | | Resulting state | :class:`MaildirMessage` state | |
| 1170 | +====================+===============================+ |
| 1171 | | "unseen" sequence | no S flag | |
| 1172 | +--------------------+-------------------------------+ |
| 1173 | | "replied" sequence | R flag | |
| 1174 | +--------------------+-------------------------------+ |
| 1175 | | "flagged" sequence | F flag | |
| 1176 | +--------------------+-------------------------------+ |
| 1177 | |
| 1178 | When an :class:`MHMessage` instance is created based upon an |
| 1179 | :class:`mboxMessage` or :class:`MMDFMessage` instance, the :mailheader:`Status` |
| 1180 | and :mailheader:`X-Status` headers are omitted and the following conversions |
| 1181 | take place: |
| 1182 | |
| 1183 | +--------------------+----------------------------------------------+ |
| 1184 | | Resulting state | :class:`mboxMessage` or :class:`MMDFMessage` | |
| 1185 | | | state | |
| 1186 | +====================+==============================================+ |
| 1187 | | "unseen" sequence | no R flag | |
| 1188 | +--------------------+----------------------------------------------+ |
| 1189 | | "replied" sequence | A flag | |
| 1190 | +--------------------+----------------------------------------------+ |
| 1191 | | "flagged" sequence | F flag | |
| 1192 | +--------------------+----------------------------------------------+ |
| 1193 | |
| 1194 | When an :class:`MHMessage` instance is created based upon a |
| 1195 | :class:`BabylMessage` instance, the following conversions take place: |
| 1196 | |
| 1197 | +--------------------+-----------------------------+ |
| 1198 | | Resulting state | :class:`BabylMessage` state | |
| 1199 | +====================+=============================+ |
| 1200 | | "unseen" sequence | "unseen" label | |
| 1201 | +--------------------+-----------------------------+ |
| 1202 | | "replied" sequence | "answered" label | |
| 1203 | +--------------------+-----------------------------+ |
| 1204 | |
| 1205 | |
| 1206 | .. _mailbox-babylmessage: |
| 1207 | |
| 1208 | :class:`BabylMessage` |
| 1209 | ^^^^^^^^^^^^^^^^^^^^^ |
| 1210 | |
| 1211 | |
Georg Brandl | cd7f32b | 2009-06-08 09:13:45 +0000 | [diff] [blame] | 1212 | .. class:: BabylMessage(message=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1213 | |
| 1214 | A message with Babyl-specific behaviors. Parameter *message* has the same |
| 1215 | meaning as with the :class:`Message` constructor. |
| 1216 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1217 | Certain message labels, called :dfn:`attributes`, are defined by convention |
| 1218 | to have special meanings. The attributes are as follows: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1219 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1220 | +-----------+------------------------------------------+ |
| 1221 | | Label | Explanation | |
| 1222 | +===========+==========================================+ |
| 1223 | | unseen | Not read, but previously detected by MUA | |
| 1224 | +-----------+------------------------------------------+ |
| 1225 | | deleted | Marked for subsequent deletion | |
| 1226 | +-----------+------------------------------------------+ |
| 1227 | | filed | Copied to another file or mailbox | |
| 1228 | +-----------+------------------------------------------+ |
| 1229 | | answered | Replied to | |
| 1230 | +-----------+------------------------------------------+ |
| 1231 | | forwarded | Forwarded | |
| 1232 | +-----------+------------------------------------------+ |
| 1233 | | edited | Modified by the user | |
| 1234 | +-----------+------------------------------------------+ |
| 1235 | | resent | Resent | |
| 1236 | +-----------+------------------------------------------+ |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1237 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1238 | By default, Rmail displays only visible headers. The :class:`BabylMessage` |
| 1239 | class, though, uses the original headers because they are more |
| 1240 | complete. Visible headers may be accessed explicitly if desired. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1241 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1242 | :class:`BabylMessage` instances offer the following methods: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1243 | |
| 1244 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1245 | .. method:: get_labels() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1246 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1247 | Return a list of labels on the message. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1248 | |
| 1249 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1250 | .. method:: set_labels(labels) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1251 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1252 | Set the list of labels on the message to *labels*. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1253 | |
| 1254 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1255 | .. method:: add_label(label) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1256 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1257 | Add *label* to the list of labels on the message. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1258 | |
| 1259 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1260 | .. method:: remove_label(label) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1261 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1262 | Remove *label* from the list of labels on the message. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1263 | |
| 1264 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1265 | .. method:: get_visible() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1266 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1267 | Return an :class:`Message` instance whose headers are the message's |
| 1268 | visible headers and whose body is empty. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1269 | |
| 1270 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1271 | .. method:: set_visible(visible) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1272 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1273 | Set the message's visible headers to be the same as the headers in |
| 1274 | *message*. Parameter *visible* should be a :class:`Message` instance, an |
R David Murray | 5320250 | 2012-09-28 15:19:16 -0400 | [diff] [blame] | 1275 | :class:`email.message.Message` instance, a string, or a file-like object |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1276 | (which should be open in text mode). |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1277 | |
| 1278 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1279 | .. method:: update_visible() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1280 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1281 | When a :class:`BabylMessage` instance's original headers are modified, the |
| 1282 | visible headers are not automatically modified to correspond. This method |
| 1283 | updates the visible headers as follows: each visible header with a |
| 1284 | corresponding original header is set to the value of the original header, |
| 1285 | each visible header without a corresponding original header is removed, |
| 1286 | and any of :mailheader:`Date`, :mailheader:`From`, :mailheader:`Reply-To`, |
| 1287 | :mailheader:`To`, :mailheader:`CC`, and :mailheader:`Subject` that are |
| 1288 | present in the original headers but not the visible headers are added to |
| 1289 | the visible headers. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1290 | |
| 1291 | When a :class:`BabylMessage` instance is created based upon a |
| 1292 | :class:`MaildirMessage` instance, the following conversions take place: |
| 1293 | |
| 1294 | +-------------------+-------------------------------+ |
| 1295 | | Resulting state | :class:`MaildirMessage` state | |
| 1296 | +===================+===============================+ |
| 1297 | | "unseen" label | no S flag | |
| 1298 | +-------------------+-------------------------------+ |
| 1299 | | "deleted" label | T flag | |
| 1300 | +-------------------+-------------------------------+ |
| 1301 | | "answered" label | R flag | |
| 1302 | +-------------------+-------------------------------+ |
| 1303 | | "forwarded" label | P flag | |
| 1304 | +-------------------+-------------------------------+ |
| 1305 | |
| 1306 | When a :class:`BabylMessage` instance is created based upon an |
| 1307 | :class:`mboxMessage` or :class:`MMDFMessage` instance, the :mailheader:`Status` |
| 1308 | and :mailheader:`X-Status` headers are omitted and the following conversions |
| 1309 | take place: |
| 1310 | |
| 1311 | +------------------+----------------------------------------------+ |
| 1312 | | Resulting state | :class:`mboxMessage` or :class:`MMDFMessage` | |
| 1313 | | | state | |
| 1314 | +==================+==============================================+ |
| 1315 | | "unseen" label | no R flag | |
| 1316 | +------------------+----------------------------------------------+ |
| 1317 | | "deleted" label | D flag | |
| 1318 | +------------------+----------------------------------------------+ |
| 1319 | | "answered" label | A flag | |
| 1320 | +------------------+----------------------------------------------+ |
| 1321 | |
| 1322 | When a :class:`BabylMessage` instance is created based upon an |
| 1323 | :class:`MHMessage` instance, the following conversions take place: |
| 1324 | |
| 1325 | +------------------+--------------------------+ |
| 1326 | | Resulting state | :class:`MHMessage` state | |
| 1327 | +==================+==========================+ |
| 1328 | | "unseen" label | "unseen" sequence | |
| 1329 | +------------------+--------------------------+ |
| 1330 | | "answered" label | "replied" sequence | |
| 1331 | +------------------+--------------------------+ |
| 1332 | |
| 1333 | |
| 1334 | .. _mailbox-mmdfmessage: |
| 1335 | |
| 1336 | :class:`MMDFMessage` |
| 1337 | ^^^^^^^^^^^^^^^^^^^^ |
| 1338 | |
| 1339 | |
Georg Brandl | cd7f32b | 2009-06-08 09:13:45 +0000 | [diff] [blame] | 1340 | .. class:: MMDFMessage(message=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1341 | |
| 1342 | A message with MMDF-specific behaviors. Parameter *message* has the same meaning |
| 1343 | as with the :class:`Message` constructor. |
| 1344 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1345 | As with message in an mbox mailbox, MMDF messages are stored with the |
| 1346 | sender's address and the delivery date in an initial line beginning with |
| 1347 | "From ". Likewise, flags that indicate the state of the message are |
| 1348 | typically stored in :mailheader:`Status` and :mailheader:`X-Status` headers. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1349 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1350 | Conventional flags for MMDF messages are identical to those of mbox message |
| 1351 | and are as follows: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1352 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1353 | +------+----------+--------------------------------+ |
| 1354 | | Flag | Meaning | Explanation | |
| 1355 | +======+==========+================================+ |
| 1356 | | R | Read | Read | |
| 1357 | +------+----------+--------------------------------+ |
| 1358 | | O | Old | Previously detected by MUA | |
| 1359 | +------+----------+--------------------------------+ |
| 1360 | | D | Deleted | Marked for subsequent deletion | |
| 1361 | +------+----------+--------------------------------+ |
| 1362 | | F | Flagged | Marked as important | |
| 1363 | +------+----------+--------------------------------+ |
| 1364 | | A | Answered | Replied to | |
| 1365 | +------+----------+--------------------------------+ |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1366 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1367 | The "R" and "O" flags are stored in the :mailheader:`Status` header, and the |
| 1368 | "D", "F", and "A" flags are stored in the :mailheader:`X-Status` header. The |
| 1369 | flags and headers typically appear in the order mentioned. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1370 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1371 | :class:`MMDFMessage` instances offer the following methods, which are |
| 1372 | identical to those offered by :class:`mboxMessage`: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1373 | |
| 1374 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1375 | .. method:: get_from() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1376 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1377 | Return a string representing the "From " line that marks the start of the |
| 1378 | message in an mbox mailbox. The leading "From " and the trailing newline |
| 1379 | are excluded. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1380 | |
| 1381 | |
Georg Brandl | cd7f32b | 2009-06-08 09:13:45 +0000 | [diff] [blame] | 1382 | .. method:: set_from(from_, time_=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1383 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1384 | Set the "From " line to *from_*, which should be specified without a |
| 1385 | leading "From " or trailing newline. For convenience, *time_* may be |
| 1386 | specified and will be formatted appropriately and appended to *from_*. If |
Serhiy Storchaka | bfdcd43 | 2013-10-13 23:09:14 +0300 | [diff] [blame] | 1387 | *time_* is specified, it should be a :class:`time.struct_time` instance, a |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1388 | tuple suitable for passing to :meth:`time.strftime`, or ``True`` (to use |
| 1389 | :meth:`time.gmtime`). |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1390 | |
| 1391 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1392 | .. method:: get_flags() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1393 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1394 | Return a string specifying the flags that are currently set. If the |
| 1395 | message complies with the conventional format, the result is the |
| 1396 | concatenation in the following order of zero or one occurrence of each of |
| 1397 | ``'R'``, ``'O'``, ``'D'``, ``'F'``, and ``'A'``. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1398 | |
| 1399 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1400 | .. method:: set_flags(flags) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1401 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1402 | Set the flags specified by *flags* and unset all others. Parameter *flags* |
| 1403 | should be the concatenation in any order of zero or more occurrences of |
| 1404 | each of ``'R'``, ``'O'``, ``'D'``, ``'F'``, and ``'A'``. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1405 | |
| 1406 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1407 | .. method:: add_flag(flag) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1408 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1409 | Set the flag(s) specified by *flag* without changing other flags. To add |
| 1410 | more than one flag at a time, *flag* may be a string of more than one |
| 1411 | character. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1412 | |
| 1413 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1414 | .. method:: remove_flag(flag) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1415 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1416 | Unset the flag(s) specified by *flag* without changing other flags. To |
| 1417 | remove more than one flag at a time, *flag* maybe a string of more than |
| 1418 | one character. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1419 | |
| 1420 | When an :class:`MMDFMessage` instance is created based upon a |
| 1421 | :class:`MaildirMessage` instance, a "From " line is generated based upon the |
| 1422 | :class:`MaildirMessage` instance's delivery date, and the following conversions |
| 1423 | take place: |
| 1424 | |
| 1425 | +-----------------+-------------------------------+ |
| 1426 | | Resulting state | :class:`MaildirMessage` state | |
| 1427 | +=================+===============================+ |
| 1428 | | R flag | S flag | |
| 1429 | +-----------------+-------------------------------+ |
| 1430 | | O flag | "cur" subdirectory | |
| 1431 | +-----------------+-------------------------------+ |
| 1432 | | D flag | T flag | |
| 1433 | +-----------------+-------------------------------+ |
| 1434 | | F flag | F flag | |
| 1435 | +-----------------+-------------------------------+ |
| 1436 | | A flag | R flag | |
| 1437 | +-----------------+-------------------------------+ |
| 1438 | |
| 1439 | When an :class:`MMDFMessage` instance is created based upon an |
| 1440 | :class:`MHMessage` instance, the following conversions take place: |
| 1441 | |
| 1442 | +-------------------+--------------------------+ |
| 1443 | | Resulting state | :class:`MHMessage` state | |
| 1444 | +===================+==========================+ |
| 1445 | | R flag and O flag | no "unseen" sequence | |
| 1446 | +-------------------+--------------------------+ |
| 1447 | | O flag | "unseen" sequence | |
| 1448 | +-------------------+--------------------------+ |
| 1449 | | F flag | "flagged" sequence | |
| 1450 | +-------------------+--------------------------+ |
| 1451 | | A flag | "replied" sequence | |
| 1452 | +-------------------+--------------------------+ |
| 1453 | |
| 1454 | When an :class:`MMDFMessage` instance is created based upon a |
| 1455 | :class:`BabylMessage` instance, the following conversions take place: |
| 1456 | |
| 1457 | +-------------------+-----------------------------+ |
| 1458 | | Resulting state | :class:`BabylMessage` state | |
| 1459 | +===================+=============================+ |
| 1460 | | R flag and O flag | no "unseen" label | |
| 1461 | +-------------------+-----------------------------+ |
| 1462 | | O flag | "unseen" label | |
| 1463 | +-------------------+-----------------------------+ |
| 1464 | | D flag | "deleted" label | |
| 1465 | +-------------------+-----------------------------+ |
| 1466 | | A flag | "answered" label | |
| 1467 | +-------------------+-----------------------------+ |
| 1468 | |
| 1469 | When an :class:`MMDFMessage` instance is created based upon an |
| 1470 | :class:`mboxMessage` instance, the "From " line is copied and all flags directly |
| 1471 | correspond: |
| 1472 | |
| 1473 | +-----------------+----------------------------+ |
| 1474 | | Resulting state | :class:`mboxMessage` state | |
| 1475 | +=================+============================+ |
| 1476 | | R flag | R flag | |
| 1477 | +-----------------+----------------------------+ |
| 1478 | | O flag | O flag | |
| 1479 | +-----------------+----------------------------+ |
| 1480 | | D flag | D flag | |
| 1481 | +-----------------+----------------------------+ |
| 1482 | | F flag | F flag | |
| 1483 | +-----------------+----------------------------+ |
| 1484 | | A flag | A flag | |
| 1485 | +-----------------+----------------------------+ |
| 1486 | |
| 1487 | |
| 1488 | Exceptions |
| 1489 | ---------- |
| 1490 | |
| 1491 | The following exception classes are defined in the :mod:`mailbox` module: |
| 1492 | |
| 1493 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1494 | .. exception:: Error() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1495 | |
| 1496 | The based class for all other module-specific exceptions. |
| 1497 | |
| 1498 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1499 | .. exception:: NoSuchMailboxError() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1500 | |
| 1501 | Raised when a mailbox is expected but is not found, such as when instantiating a |
| 1502 | :class:`Mailbox` subclass with a path that does not exist (and with the *create* |
| 1503 | parameter set to ``False``), or when opening a folder that does not exist. |
| 1504 | |
| 1505 | |
Georg Brandl | 734e268 | 2008-08-12 08:18:18 +0000 | [diff] [blame] | 1506 | .. exception:: NotEmptyError() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1507 | |
| 1508 | Raised when a mailbox is not empty but is expected to be, such as when deleting |
| 1509 | a folder that contains messages. |
| 1510 | |
| 1511 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1512 | .. exception:: ExternalClashError() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1513 | |
| 1514 | Raised when some mailbox-related condition beyond the control of the program |
| 1515 | causes it to be unable to proceed, such as when failing to acquire a lock that |
| 1516 | another program already holds a lock, or when a uniquely-generated file name |
| 1517 | already exists. |
| 1518 | |
| 1519 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1520 | .. exception:: FormatError() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1521 | |
| 1522 | Raised when the data in a file cannot be parsed, such as when an :class:`MH` |
| 1523 | instance attempts to read a corrupted :file:`.mh_sequences` file. |
| 1524 | |
| 1525 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1526 | .. _mailbox-examples: |
| 1527 | |
| 1528 | Examples |
| 1529 | -------- |
| 1530 | |
| 1531 | A simple example of printing the subjects of all messages in a mailbox that seem |
| 1532 | interesting:: |
| 1533 | |
| 1534 | import mailbox |
| 1535 | for message in mailbox.mbox('~/mbox'): |
| 1536 | subject = message['subject'] # Could possibly be None. |
| 1537 | if subject and 'python' in subject.lower(): |
Georg Brandl | 6911e3c | 2007-09-04 07:15:32 +0000 | [diff] [blame] | 1538 | print(subject) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1539 | |
| 1540 | To copy all mail from a Babyl mailbox to an MH mailbox, converting all of the |
| 1541 | format-specific information that can be converted:: |
| 1542 | |
| 1543 | import mailbox |
| 1544 | destination = mailbox.MH('~/Mail') |
| 1545 | destination.lock() |
| 1546 | for message in mailbox.Babyl('~/RMAIL'): |
Christian Heimes | dd15f6c | 2008-03-16 00:07:10 +0000 | [diff] [blame] | 1547 | destination.add(mailbox.MHMessage(message)) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1548 | destination.flush() |
| 1549 | destination.unlock() |
| 1550 | |
| 1551 | This example sorts mail from several mailing lists into different mailboxes, |
| 1552 | being careful to avoid mail corruption due to concurrent modification by other |
| 1553 | programs, mail loss due to interruption of the program, or premature termination |
| 1554 | due to malformed messages in the mailbox:: |
| 1555 | |
| 1556 | import mailbox |
Ezio Melotti | 956040a | 2013-12-14 12:42:29 +0200 | [diff] [blame] | 1557 | import email.errors |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1558 | |
| 1559 | list_names = ('python-list', 'python-dev', 'python-bugs') |
| 1560 | |
Georg Brandl | f694518 | 2008-02-01 11:56:49 +0000 | [diff] [blame] | 1561 | boxes = {name: mailbox.mbox('~/email/%s' % name) for name in list_names} |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1562 | inbox = mailbox.Maildir('~/Maildir', factory=None) |
| 1563 | |
| 1564 | for key in inbox.iterkeys(): |
| 1565 | try: |
| 1566 | message = inbox[key] |
Ezio Melotti | 956040a | 2013-12-14 12:42:29 +0200 | [diff] [blame] | 1567 | except email.errors.MessageParseError: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1568 | continue # The message is malformed. Just leave it. |
| 1569 | |
| 1570 | for name in list_names: |
| 1571 | list_id = message['list-id'] |
| 1572 | if list_id and name in list_id: |
| 1573 | # Get mailbox to use |
| 1574 | box = boxes[name] |
| 1575 | |
| 1576 | # Write copy to disk before removing original. |
| 1577 | # If there's a crash, you might duplicate a message, but |
| 1578 | # that's better than losing a message completely. |
| 1579 | box.lock() |
| 1580 | box.add(message) |
Georg Brandl | 48310cd | 2009-01-03 21:18:54 +0000 | [diff] [blame] | 1581 | box.flush() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1582 | box.unlock() |
| 1583 | |
| 1584 | # Remove original message |
| 1585 | inbox.lock() |
| 1586 | inbox.discard(key) |
| 1587 | inbox.flush() |
| 1588 | inbox.unlock() |
| 1589 | break # Found destination, so stop looking. |
| 1590 | |
| 1591 | for box in boxes.itervalues(): |
| 1592 | box.close() |
| 1593 | |