1"""
2The MIT License
3
4Copyright (c) 2007-2010 Leah Culver, Joe Stump, Mark Paschal, Vic Fryzel
5
6Permission is hereby granted, free of charge, to any person obtaining a copy
7of this software and associated documentation files (the "Software"), to deal
8in the Software without restriction, including without limitation the rights
9to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10copies of the Software, and to permit persons to whom the Software is
11furnished to do so, subject to the following conditions:
12
13The above copyright notice and this permission notice shall be included in
14all copies or substantial portions of the Software.
15
16THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22THE SOFTWARE.
23"""
24
25import oauth2
26import imaplib
27
28
29class IMAP4_SSL(imaplib.IMAP4_SSL):
30    """IMAP wrapper for imaplib.IMAP4_SSL that implements XOAUTH."""
31
32    def authenticate(self, url, consumer, token):
33        if consumer is not None and not isinstance(consumer, oauth2.Consumer):
34            raise ValueError("Invalid consumer.")
35
36        if token is not None and not isinstance(token, oauth2.Token):
37            raise ValueError("Invalid token.")
38
39        imaplib.IMAP4_SSL.authenticate(self, 'XOAUTH',
40            lambda x: oauth2.build_xoauth_string(url, consumer, token))
41