Changeset 276:2e8ae6303dae

Timestamp:

08/11/11 22:44:19 (7 months ago)

Author:

Menno Smits <menno@…>

Branch:

default

Message:

Return expunge responses (#80)

Location:

imapclient

Files:

• imapclient.py (modified) (1 diff)
• livetest.py (modified) (1 diff)

imapclient/imapclient.py

@@ -727 +727 @@
         """Remove any messages from the currently selected folder that
         have the ``\\Deleted`` flag set.
-        """
-        typ, data = self._imap.expunge()
-        self._checkok('expunge', typ, data)
-        #TODO: expunge response
+
+        The return value is the server response message
+        followed by a list of expunge responses. For example::
+
+            ('Expunge completed.',
+             [(2, 'EXPUNGE'),
+              (1, 'EXPUNGE'),
+              (0, 'RECENT')])
+
+        In this case, the responses indicate that the message with
+        sequence numbers 2 and 1 where deleted, leaving no recent
+        messages in the folder.
+
+        See `RFC 3501 section 6.4.3
+        <http://tools.ietf.org/html/rfc3501#section-6.4.3>`_ and
+        `RFC 3501 section 7.4.1
+        <http://tools.ietf.org/html/rfc3501#section-7.4.1>`_ for more
+        details.
+        """
+        tag = self._imap._command('EXPUNGE')
+        return self._consume_until_tagged_response(tag, 'EXPUNGE')
 
     def getacl(self, folder):

imapclient/livetest.py

@@ -528 +528 @@
             self.assertIn((1, 'EXISTS'), resps)
 
+        def test_expunge(self):
+            self.client.select_folder('INBOX')
+
+            # Test empty mailbox
+            text, resps = self.client.expunge()
+            self.assertTrue(isinstance(text, str))
+            self.assertGreater(len(text), 0)
+            self.assertEqual(resps, [])
+
+            # Now try with a message to expunge
+            self.client.append('INBOX', SIMPLE_MESSAGE, flags=[imapclient.DELETED])
+
+            msg, resps = self.client.expunge()
+
+            self.assertTrue(isinstance(text, str))
+            self.assertGreater(len(text), 0)
+            self.assertTrue(isinstance(resps, list))
+            if not self.is_gmail():
+                # GMail has an auto-expunge feature which might be
+                # on. EXPUNGE won't return anything in this case
+                self.assertIn((1, 'EXPUNGE'), resps)
+
     return LiveTest