0e4afa9132
When synclabels config flag is set to "yes" for the GMail repo, offlineimap fetches the message labels along with the messages, and embeds them into the body under the header X-Keywords (or whatever 'labelsheader' was set to), as a comma separated list. It also adds an extra pass to savemessageto, that performs label synchronization on existing messages from GMail to local, the same way it is done with flags. We also introduce GmailMaildir repository that adds functionality to change message labels. It keeps track of messages modification time, so one can quickly detect when the labels may have changed. Signed-off-by: Eygene Ryabinkin <rea@codelabs.ru>
81 lines
3.0 KiB
Python
81 lines
3.0 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)
|
|
|
|
if self.account.getconfboolean('synclabels', 0) and \
|
|
self.account.getconf('status_backend', 'plain') != 'sqlite':
|
|
raise OfflineImapError("The Gmail repository needs the sqlite backend to sync labels.\n"
|
|
"To enable it add 'status_backend = sqlite' in the account section",
|
|
OfflineImapError.ERROR.REPO)
|
|
|
|
|
|
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)
|
|
|
|
def getfoldertype(self):
|
|
return folder.Gmail.GmailFolder
|
|
|
|
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')
|