Changeset 267:06c7e9364807

Timestamp:

18/09/11 21:42:52 (8 months ago)

Author:

Menno Smits <menno@…>

Branch:

default

Message:

Added rename_folder (#77)

Files:

• NEWS (modified) (1 diff)
• imapclient/imapclient.py (modified) (2 diffs)
• livetest.py (modified) (1 diff)

NEWS

@@ -22 +22 @@
 Full documentation is now available under doc/html in the source
 distribution and at http://imapclient.readthedocs.org/ online.
+
+Added rename_folder (#77) [NEW] 
+--------------------------------
+Renaming of folders was an obvious omission!
 
 Minor Features

imapclient/imapclient.py

@@ -438 +438 @@
         return out
 
-
     def close_folder(self):
         """Close the currently selected folder, returning the server
@@ -454 +453 @@
         return data[0]
 
+    def rename_folder(self, old_name, new_name):
+        """Change the name of a folder on the server.
+        """
+        typ, data = self._imap.rename(self._encode_folder_name(old_name),
+                                      self._encode_folder_name(new_name))
+        self._checkok('rename', typ, data)
+        return data[0]
+        
     def delete_folder(self, folder):
         """Delete *folder* on the server returning the server response string.

livetest.py

@@ -230 +230 @@
                 self.assertFalse(self.client.folder_exists(folder))
 
+        def test_rename_folder(self):
+            test_folders = ['foobar',
+                            'stuff & things',
+                            u'test & \u2622',
+                            '123']
+            for folder in test_folders:
+                self.client.create_folder(folder)
+
+                new_folder = folder + 'x'
+                resp = self.client.rename_folder(folder, new_folder)
+                self.assertIsInstance(resp, str)
+                self.assertTrue(len(resp) > 0)
+
+                self.assertFalse(self.client.folder_exists(folder))
+                self.assertTrue(self.client.folder_exists(new_folder))
 
         def test_status(self):