Changeset 245:60cb7b1b40e4

Timestamp:

03/03/11 13:48:10 (15 months ago)

Author:

Menno Smits <menno@…>

Branch:

default

Message:

document SEQ element and some cosmetic changes

Files:

• imapclient/imapclient.py (modified) (6 diffs)

imapclient/imapclient.py

@@ -115 +115 @@
 
     def namespace(self):
-        """Return the namespace for the account as a (personal, other, shared) tuple.
+        """Return the namespace for the account as a (personal, other,
+        shared) tuple.
 
         Each element may be None if no namespace of that type exists,
@@ -121 +122 @@
 
         For convenience the tuple elements may be accessed
-        positionally or attributes named "personal", "other" and
-        "shared".
+        positionally or using attributes named *personal*, *other* and
+        *shared*.
 
         See RFC 2342 for more details.
@@ -319 +320 @@
 
     def folder_exists(self, folder):
-        """Return True if *folder* exists on the server.
+        """Return ``True`` if *folder* exists on the server.
         """
         typ, data = self._imap.list('', self._encode_folder_name(folder))
@@ -426 +427 @@
         """Remove one or more *flags* from *messages*.
 
-        *flags* should be a sequence of strings. Returns the flags set
-         for each modified message (see *get_flags*).
+        *flags* should be a sequence of strings.
+
+        Returns the flags set for each modified message (see
+        *get_flags*).
         """
         return self._store('-FLAGS', messages, flags)
@@ -435 +438 @@
         """Set the *flags* for *messages*.
 
-        *flags* should be a sequence of strings. Returns the flags set
-         for each modified message (see *get_flags*).
+        *flags* should be a sequence of strings.
+
+        Returns the flags set for each modified message (see
+        *get_flags*).
         """
         return self._store('FLAGS', messages, flags)
@@ -466 +471 @@
         corresponding to each item in *data*.
 
-        XXX document SEQ
+        In addition to an element for each *data* item, the dict
+        returned for each message also contains a *SEQ* key containing
+        the sequence number for the message. This allows for mapping
+        between the UID and sequence number (when the *use_uid*
+        property is ``True``).
 
         Example::