Changeset 143:b09900646458

Timestamp:

29/04/10 22:10:51 (22 months ago)

Author:

Menno Smits <menno@…>

Branch:

default

Message:

#42: Folder names with double quotes around them have the double quotes stripped

Work around an imaplib misfeature which prevents quoting when folder names
start and end with double quotes.

Files:

• imapclient/imapclient.py (modified) (3 diffs)
• imapclient/test/test_IMAPClient.py (modified) (2 diffs)
• livetest.py (modified) (2 diffs)

imapclient/imapclient.py

@@ -329 +329 @@
         typ, data = self._imap.list('', self._encode_folder_name(folder))
         self._checkok('list', typ, data)
+        data = [x for x in data if x]
         return len(data) == 1 and data[0] != None
 
@@ -629 +630 @@
     def _encode_folder_name(self, name):
         if self.folder_encode:
-            return imap_utf7.encode(name)
-        return name
+            name = imap_utf7.encode(name)
+        # imaplib assumes that if a command argument (in this case a
+        # folder name) has double quotes around it, then it doesn't
+        # need quoting. This "feature" prevents creation of folders
+        # with names that start and end with double quotes.
+        #
+        # To work around this IMAPClient performs the quoting
+        # itself. This adds start and end double quotes which also
+        # serves to fool IMAP4._checkquote into not attempting further
+        # quoting. A hack but it works.
+        return _quote_arg(name)
 
 
@@ -671 +681 @@
 
 
+def _quote_arg(arg):
+  arg = arg.replace('\\', '\\\\')
+  arg = arg.replace('"', '\\"')
+  return '"%s"' % arg

imapclient/test/test_IMAPClient.py

@@ -117 +117 @@
 
         self.client.append('foobar', sentinel.msg, ['FLAG', 'WAVE'], None)
-                           
+
         self.assert_(self.client._imap.method_calls ==
-                     [('append', ('foobar',
+                     [('append', ('"foobar"',
                                   '(FLAG WAVE)',
                                   None,
@@ -136 +136 @@
         self.assert_(datetime_to_imap.called)
         self.assert_(self.client._imap.method_calls ==
-                     [('append', ('foobar',
+                     [('append', ('"foobar"',
                                   '(FLAG WAVE)',
                                   '"somedate"',

livetest.py

@@ -144 +144 @@
 
     test_folders = ['foobar',
+                    '"foobar"',
+                    'foo "bar"',
                     'stuff & things',
                     u'test & \u2622']
@@ -153 +155 @@
 
         assert client.folder_exists(folder)
-        assert folder in extract_normal_folders(client.list_folders())
+        assert folder in extract_normal_folders(client.list_folders()), repr(folder)
 
         client.select_folder(folder)