def refresh_folders(self, subscribed = True):
'''This method extracts the folder list from the
server.
'''
if not self.folder_tree:
self.folder_tree = FolderTree( self )
self.folder_tree.refresh_folders( subscribed )
self.folder_tree.set_properties(self.expand_list,
self.special_folders)
self.folder_tree.sort()
self.set_iterator(self.folder_tree.iter_expand)
class ImapServer(object):
'''Establishes the server connection, and does the authentication.
'''
def __init__(self, host='localhost', port=None, ssl=False,
keyfile=None, certfile=None):
'''
@param host: host name of the imap server;
@param port: port to be used. If not specified it will default to 143
for plain text and 993 for ssl;
@param ssl: Is the connection ssl?
@type ssl: Bool
@param keyfile: PEM formatted private key;
@param certfile: certificate chain file for the SSL connection.
'''
object.__init__(self)
try:
self._imap = IMAP4P(host=host, port=port, ssl=ssl,
keyfile=keyfile,certfile=certfile, autologout=False )
self.connected = True
except socket.gaierror:
self.connected = False
raise
self.special_folders = []
self.expand_list = []
self.folder_tree = None
# IMAP methods
def login(self, username, password):
'''Performs the login on the server.
@param username:
@param password:
@return: it returns the LOGIN imap4 command response on the format
defined on the imaplibii library.
'''
return self._imap.login(username, password)
# Folder list management
def set_special_folders(self, *folder_list):
'''The folders are displayed allways with 'INBOX' in the first place,
then all the folders defined on this method, and then the folders on
the order returned by the server.
'''
self.special_folders = folder_list
def set_expand_list(self, *folder_list):
'''From which folders should we fetch the sub folder list?
'''
self.expand_list = folder_list
def refresh_folders(self, subscribed = True):
'''This method extracts the folder list from the
server.
'''
if not self.folder_tree:
self.folder_tree = FolderTree( self )
self.folder_tree.refresh_folders( subscribed )
self.folder_tree.set_properties(self.expand_list,
self.special_folders)
self.folder_tree.sort()
self.set_iterator(self.folder_tree.iter_expand)
def folder_iter(self):
'''
First show the special folders, then rest of the folders
if a folder is in the expandable list show also the sub folders.
'''
return self.folders()
def set_iterator(self, it):
'''Pre-defines the iterator to use on the folder tree. The available
iterators are defined on FolderTree
'''
if self.folder_tree:
self.folders = it
else:
raise NoFolderListError('No folder list')
# Special methods
def __del__(self):
'''Logs out from the imap server when the class instance is deleted'''
if self.connected:
self._imap.logout()
def __getitem__(self, path):
'''Returns a folder object'''
if not self.folder_tree:
self.folder_tree = FolderTree( self )
return self.folder_tree.get_folder(path)
def __iter__(self):
'''Iteracts through the folders'''
if not self.folder_tree:
self.refresh_folders()
return self.folders()
def __getitem__(self, path):
'''Returns a folder object'''
if not self.folder_tree:
self.folder_tree = FolderTree( self )
return self.folder_tree.get_folder(path)
class ImapServer(object):
'''Establishes the server connection, and does the authentication.
'''
def __init__(self,
host='localhost',
port=None,
ssl=False,
keyfile=None,
certfile=None):
'''
@param host: host name of the imap server;
@param port: port to be used. If not specified it will default to 143
for plain text and 993 for ssl;
@param ssl: Is the connection ssl?
@type ssl: Bool
@param keyfile: PEM formatted private key;
@param certfile: certificate chain file for the SSL connection.
'''
object.__init__(self)
try:
self._imap = IMAP4P(host=host,
port=port,
ssl=ssl,
keyfile=keyfile,
certfile=certfile,
autologout=False)
self.connected = True
except socket.gaierror:
self.connected = False
raise
self.special_folders = []
self.expand_list = []
self.__folder_tree = None
self.folder_iterator = 'iter_expand'
# IMAP methods
def login(self, username, password):
'''Performs the login on the server.
@param username:
@param password:
@return: it returns the LOGIN imap4 command response on the format
defined on the imaplib2 library.
'''
return self._imap.login(username, password)
# Folder list management
def set_special_folders(self, *folder_list):
'''The folders are displayed allways with 'INBOX' in the first place,
then all the folders defined on this method, and then the folders on
the order returned by the server.
'''
self.special_folders = folder_list
def set_expand_list(self, *folder_list):
'''From which folders should we fetch the sub folder list?
'''
self.expand_list = folder_list
def _get_folder_tree(self):
if not self.__folder_tree:
self.__folder_tree = FolderTree(self)
return self.__folder_tree
folder_tree = property(_get_folder_tree)
def refresh_folders(self, subscribed=True):
'''This method extracts the folder list from the
server.
'''
self.folder_tree.refresh_folders(subscribed)
self.folder_tree.set_properties(self.expand_list, self.special_folders)
self.folder_tree.sort()
self.set_folder_iterator()
def set_folder_iterator(self):
'''Pre-defines the iterator to use on the folder tree. The available
iterators are defined on FolderTree
'''
try:
it = getattr(self.folder_tree, self.folder_iterator)
except AttributeError:
raise ServerError('Unknown iterator "%s"' % self.folder_iterator)
if self.folder_tree:
self.folders = it
else:
raise NoFolderListError('No folder list')
# Special methods
def __del__(self):
'''Logs out from the imap server when the class instance is deleted'''
if self.connected:
self._imap.logout()
def __getitem__(self, path):
'''Returns a folder object'''
if not self.folder_tree:
self.folder_tree = FolderTree(self)
return self.folder_tree.get_folder(path)
def __iter__(self):
'''Iteracts through the folders'''
if not self.folder_tree or not hasattr(self, 'folders'):
self.refresh_folders()
return self.folders()
def __getitem__(self, path):
'''Returns a folder object'''
if not self.folder_tree:
self.folder_tree = FolderTree(self)
return self.folder_tree.get_folder(path)
def _get_folder_tree(self):
if not self.__folder_tree:
self.__folder_tree = FolderTree(self)
return self.__folder_tree
