b20f5192fb
Previously we hard-coded the imap server name in the case of Gmail repositories, but often we need a different host name. So, allow people to specify the hostname via the regular "remotehosteval" and "remotehost" settings, and only falling back to imap.gmail.com when nothing has been specified. Cache the hostname, so we don't evaluate the whole thing each time we query the host name. Make the remotehosteval processing more robust, by catching any Exceptions that occur, and throw a OfflineImapError, that explains where exactly the error had occured. You can test this, e.g. by setting remotehosteval to 1/"n" or some other invalid expression. The whole IMAP.gethost() function has been documented code wise while going through. Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de> Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
81 lines
2.9 KiB
Python
81 lines
2.9 KiB
Python
# Gmail IMAP repository support
|
|
# Copyright (C) 2008 Riccardo Murri <riccardo.murri@gmail.com>
|
|
#
|
|
# This program is free software; you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation; either version 2 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# This program is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with this program; if not, write to the Free Software
|
|
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
|
|
|
|
from offlineimap.repository.IMAP import IMAPRepository
|
|
from offlineimap import folder, OfflineImapError
|
|
|
|
class GmailRepository(IMAPRepository):
|
|
"""Gmail IMAP repository.
|
|
|
|
Falls back to hard-coded gmail host name and port, if none were specified:
|
|
http://mail.google.com/support/bin/answer.py?answer=78799&topic=12814
|
|
"""
|
|
# Gmail IMAP server hostname
|
|
HOSTNAME = "imap.gmail.com"
|
|
# Gmail IMAP server port
|
|
PORT = 993
|
|
|
|
def __init__(self, reposname, account):
|
|
"""Initialize a GmailRepository object."""
|
|
# Enforce SSL usage
|
|
account.getconfig().set('Repository ' + reposname,
|
|
'ssl', 'yes')
|
|
IMAPRepository.__init__(self, reposname, account)
|
|
|
|
def gethost(self):
|
|
"""Return the server name to connect to.
|
|
|
|
Gmail implementation first checks for the usual IMAP settings
|
|
and falls back to imap.gmail.com if not specified."""
|
|
try:
|
|
return super(GmailRepository, self).gethost()
|
|
except OfflineImapError:
|
|
# nothing was configured, cache and return hardcoded one
|
|
self._host = GmailRepository.HOSTNAME
|
|
return self._host
|
|
|
|
def getport(self):
|
|
return GmailRepository.PORT
|
|
|
|
def getssl(self):
|
|
return 1
|
|
|
|
def getpreauthtunnel(self):
|
|
return None
|
|
|
|
def getfolder(self, foldername):
|
|
return self.getfoldertype()(self.imapserver, foldername,
|
|
self.nametrans(foldername),
|
|
self.accountname, self)
|
|
|
|
def getfoldertype(self):
|
|
return folder.Gmail.GmailFolder
|
|
|
|
def getrealdelete(self, foldername):
|
|
# XXX: `foldername` is currently ignored - the `realdelete`
|
|
# setting is repository-wide
|
|
return self.getconfboolean('realdelete', 0)
|
|
|
|
def gettrashfolder(self, foldername):
|
|
#: Where deleted mail should be moved
|
|
return self.getconf('trashfolder','[Gmail]/Trash')
|
|
|
|
def getspamfolder(self):
|
|
#: Gmail also deletes messages upon EXPUNGE in the Spam folder
|
|
return self.getconf('spamfolder','[Gmail]/Spam')
|
|
|