Changeset 207:835686a87307

Timestamp:

03/23/11 00:43:05 (14 months ago)

Author:

Johannes Heckel <stone.pixel@…>

Branch:

oauth

Children:

209:80f530da50d7, 213:8e81638b42ec

Message:

Implemented oauth authentication using oauth2.

Also added an example to demonstrate the new oauth_login function's use.

Location:

imapclient

Files:

• examples/oauth_example.py (added)
• imapclient.py (modified) (2 diffs)

imapclient/imapclient.py

@@ -9 +9 @@
 import warnings
 #imaplib.Debug = 5
+
+try:
+    import oauth2
+except ImportError:
+    oauth2 = None
 
 import imap_utf7
@@ -113 +118 @@
         return data[0]
 
+    def oauth_login(self, url, oauth_token, oauth_token_secret,
+                    consumer_key='anonymous', consumer_secret='anonymous'):
+        """Authenticate using oauth.
+
+        @param url: The OAuth request URL.
+        @param oauth_token: An OAuth key.
+        @param oauth_token_secret: An OAuth secret.
+        @param consumer_key: An OAuth consumer key (defaults to 'anonymous').
+        @param consumer_secret: An OAuth consumer secret (defaults to 'anonymous').
+        """
+        if oauth2:
+            token = oauth2.Token(oauth_token, oauth_token_secret)
+            consumer = oauth2.Consumer(consumer_key, consumer_secret)
+            xoauth_callable = lambda x: oauth2.build_xoauth_string(url, consumer, token)
+            
+            typ, data = self._imap.authenticate('XOAUTH', xoauth_callable)
+            self._checkok('authenticate', typ, data)
+            return data[0]
+        else:
+            raise self.Error('The optional oauth2 dependency is needed for oauth authentication')
 
     def logout(self):