Update BACKERS.md

Add logo (in feature branch of website, pending merge) with link to sponsor website!

BACKERS.md

@@ -0,0 +1,24 @@
+### Many thanks to our wonderful Sponsors!  Your generous support helps us maintain OfflineIMAP.
+
+
+<!-- PLATINUM sponsors: in the README.md and on the front page of website -->
+<!-- https://shields.io/opencollective/tier/offlineimap-organization/12940 -->
+
+<!-- GOLD sponsors: in the README.md and on the front page of website -->
+<!-- https://shields.io/opencollective/tier/offlineimap-organization/12941 -->
+
+# SILVER sponsors  <!-- here and on sponsors page of website -->
+<!-- https://shields.io/opencollective/tier/offlineimap-organization/12942 -->
+[![silver-zeronet-logo]][silver-zeronet-link]
+
+![Silver Sponsors][silver]
+
+# BRONZE sponsors <!-- here only -->
+<!-- https://shields.io/opencollective/tier/offlineimap-organization/12873 -->
+![Bronze Sponsors][bronze]
+
+<!-- links / references -->
+[silver]: https://opencollective.com/offlineimap-organization/tiers/silver-sponsor.svg "Our Silver Sponsors"
+[silver-zeronet-logo]: https://github.com/OfflineIMAP/offlineimap.github.io/raw/master/assets/img/sponsors/zeronet.svg
+[silver-zeronet-link]: https://zeronet.co.nz/ "Zeronet - naturally fast internet"
+[bronze]: https://opencollective.com/offlineimap-organization/tiers/bronze-sponsor.svg "Our Bronze Sponsors"

Changelog.md

@@ -15,6 +15,110 @@ Note to mainainers:
 * The following excerpt is only usefull when rendered in the website.
 {:toc}
 
+### OfflineIMAP v7.3.4 (2021-08-03)
+
+#### Notes
+
+The release is likely the last minor release. This project will be maintained
+for minor bug fixes only.
+
+In this version we've backported patches from the offlineimap3 project. There's
+no new features. Users should try this fork. The official project is there and
+is maintained by Rodolfo:
+
+  https://github.com/OfflineIMAP/offlineimap3
+
+This release was tested by:
+
+- Nicolas Sebrecht
+
+
+#### Authors
+
+- Nicolas Sebrecht (5)
+- Rodolfo García Peñas (kix) (4)
+- Martin Di Paola (2)
+- Reto Schnyder (1)
+
+
+#### Fixes
+
+- folder: IMAP: fix issue when the response of searchforheaders is the same UID multiple times. [Nicolas Sebrecht]
+- Fix hooks for IDLE sync. [Reto Schnyder]
+- Changed wrong comparison equal. [Rodolfo García Peñas (kix)]
+- Comparison error. [Rodolfo García Peñas (kix)]
+- remove outdated links to travis. [Nicolas Sebrecht]
+- ui init is lintian clean. [Rodolfo García Peñas (kix)]
+- Require the minimal dependencies in python package. [Martin Di Paola]
+
+#### Changes
+
+- README: update regarding the offlineimap3 fork. [Nicolas Sebrecht]
+- redirect the users to offlineimap3. [Nicolas Sebrecht]
+- threadutil imports not used. [Rodolfo García Peñas (kix)]
+- Move out pkg attributes from __init__.py. [Martin Di Paola]
+
+
+### OfflineIMAP v7.3.3 (2020-04-11)
+
+#### Notes
+
+Here is a small release after nearly 4 months of slow moves. Still, the patches
+are very usefull for some use cases. Thanks to the contributors!
+
+This release was tested by:
+
+- Nicolas Sebrecht
+
+
+#### Authors
+
+- Chris Coleman (1)
+- Frank LENORMAND (1)
+- Herton R. Krzesinski (1)
+- martin f. krafft (1)
+
+
+#### Features
+
+- export env. variables when running account hooks. [Frank LENORMAND]
+
+#### Fixes
+
+- Fix stale gss api authentication security context. [Herton R. Krzesinski]
+- Handle [ALREADYEXISTS] and Mailbox already exists!. [Chris Coleman]
+
+#### Changes
+
+- exec() the tunnel command. [martin f. krafft]
+
+
+
+
+### OfflineIMAP v7.3.2 (2019-12-17)
+
+#### Notes
+
+This is a very small bug fix release.
+
+
+This release was tested by:
+
+- Nicolas Sebrecht
+
+
+#### Authors
+
+- Jaroslav Lichtblau (1)
+- Nicolas Sebrecht (1)
+
+
+#### Fixes
+
+- Revert "fix check for unsupported sep character". [Nicolas Sebrecht]
+- Fixing the Arch Linux name. [Jaroslav Lichtblau]
+
+
 ### OfflineIMAP v7.3.1 (2019-12-15)
 
 #### Notes

README.md

@@ -1,14 +1,8 @@
-Upstream status (`master` branch):
-[![OfflineIMAP build status on Travis-CI.org](https://travis-ci.org/OfflineIMAP/offlineimap.svg?branch=master)](https://travis-ci.org/OfflineIMAP/offlineimap)
-[![OfflineIMAP code coverage on Codecov.io](https://codecov.io/gh/OfflineIMAP/offlineimap/branch/master/graph/badge.svg)](https://codecov.io/gh/OfflineIMAP/offlineimap)
-[![Gitter chat](https://badges.gitter.im/OfflineIMAP/offlineimap.png)](https://gitter.im/OfflineIMAP/offlineimap)
-
-Upstream status (`next` branch):
-[![OfflineIMAP build status on Travis-CI.org](https://travis-ci.org/OfflineIMAP/offlineimap.svg?branch=next)](https://travis-ci.org/OfflineIMAP/offlineimap)
 
 Financial contributors: [![Financial Contributors on Open Collective](https://opencollective.com/offlineimap-organization/all/badge.svg?label=financial+contributors)](https://opencollective.com/offlineimap-organization) 
 
 [offlineimap]: http://github.com/OfflineIMAP/offlineimap
+[offlineimap3]: http://github.com/OfflineIMAP/offlineimap3
 [website]: http://www.offlineimap.org
 [wiki]: http://github.com/OfflineIMAP/offlineimap/wiki
 [blog]: http://www.offlineimap.org/posts.html
@@ -23,7 +17,14 @@ Links:
 
 ***"Get the emails where you need them."***
 
-[Official offlineimap][offlineimap].
+> IMPORTANT NOTE: This repository is for python2 only. The support for offlineimap3
+> is happening in [Official offlineimap for python3][offlineimap3].
+>
+> I'll still lazily maintain this legacy offlineimap but users should definitely go with
+> offlineimap3.
+
+- [Official offlineimap for python3][offlineimap3].
+- [Official offlineimap for python2][offlineimap].
 
 
 ## Description
@@ -45,22 +46,9 @@ message without internet connection? No problem, the message is still there.
 
 ## Project status and future
 
-> As one of the maintainer of OfflineIMAP, I'd like to put my efforts into
-> [imapfw](http://github.com/OfflineIMAP/imapfw). **imapfw** is software in
-> development that I intend to replace OfflineIMAP with in the long term.
->
-> That's why I'm not going to continue OfflineIMAP development. I'll continue
-> to maintain OfflineIMAP (fixing small bugs, reviewing patches and merging,
-> and rolling out new releases), but that's all.
->
-> While I keep tracking issues for OfflineIMAP, you should not expect future support.
->
-> You won't be left at the side. OfflineIMAP's community is large enough so that
-> you'll find people for most of your issues.
->
-> Get news from the [blog][blog].
->
->                                  Nicolas Sebrecht. ,-)
+The [offlineimap][offlineimap] project was forked to
+[offlineimap3][offlineimap3] to support python3. Contributions are welcome to
+this project.
 
 
 ## Contributors
@@ -106,7 +94,7 @@ Downloads releases as [tarball or zipball](https://github.com/OfflineIMAP/offlin
 If you are running Linux Os, you can install offlineimap with:
 
 -  openSUSE `zypper in offlineimap`
--  archLinux `pacman -S offlineimap`
+-  Arch Linux `pacman -S offlineimap`
 -  fedora `dnf install offlineimap`
 
 ## Feedbacks and contributions
@@ -137,14 +125,15 @@ Bugs, issues and contributions can be requested to both the mailing list or the
 
 ## Requirements & dependencies
 
-* Python v2.7+
+* Python v2.7.x
 * six (required)
 * rfc6555 (required)
 * imaplib2 >= 2.57 (optional)
 * gssapi (optional), for Kerberos authentication
 * portalocker (optional), if you need to run offlineimap in Cygwin for Windows
 
-* Python v3.4+ ***[STALLED] (experimental: [see known issues](https://github.com/OfflineIMAP/offlineimap/issues?q=is%3Aissue+is%3Aopen+label%3APy3))***
+* Python v3: See the [offlineimap3][offlineimap3] fork of
+  [offlineimap][offlineimap].
 
 ## Documentation
 

contrib/helpers.py

@@ -204,9 +204,8 @@ class OfflineimapInfo(object):
         cmd = shlex.split("./offlineimap.py --version")
         return run(cmd).rstrip().decode(FS_ENCODING)
 
-    def editInit(self):
-        return system("{} ./offlineimap/__init__.py".format(EDITOR))
-
+    def editVersion(self):
+        return system("{} ./offlineimap/version.py".format(EDITOR))
 
 
 class User(object):

contrib/release.py

@@ -357,7 +357,7 @@ class Release(object):
         User.request("going to make a new release after {}".format(currentVersion))
 
     def updateVersion(self):
-        self.offlineimapInfo.editInit()
+        self.offlineimapInfo.editVersion()
 
     def checkVersions(self, current, new):
         if new == current:
@@ -405,7 +405,7 @@ class Release(object):
         announce.close()
 
     def make(self):
-        Git.add('offlineimap/__init__.py')
+        Git.add('offlineimap/version.py')
         Git.add('Changelog.md')
         commitMsg = "v{}\n".format(newVersion)
         for tester in self.testers.getListOk():

offlineimap/__init__.py

@@ -1,18 +1,17 @@
 __all__ = ['OfflineImap']
 
-__productname__ = 'OfflineIMAP'
-# Expecting trailing "-rcN" or "" for stable releases.
-__version__     = "7.3.1"
-__copyright__   = "Copyright 2002-2019 John Goerzen & contributors"
-__author__      = "John Goerzen"
-__author_email__= "offlineimap-project@lists.alioth.debian.org"
-__description__ = "Disconnected Universal IMAP Mail Synchronization/Reader Support"
-__license__  = "Licensed under the GNU GPL v2 or any later version (with an OpenSSL exception)"
-__bigcopyright__ = """%(__productname__)s %(__version__)s
-  %(__license__)s""" % locals()
-__homepage__ = "http://www.offlineimap.org"
-
-banner = __bigcopyright__
+from offlineimap.version import (
+        __productname__,
+        __version__,
+        __copyright__,
+        __author__,
+        __author_email__,
+        __description__,
+        __license__,
+        __bigcopyright__,
+        __homepage__,
+        banner
+        )
 
 from offlineimap.error import OfflineImapError
 # put this last, so we don't run into circular dependencies using

offlineimap/accounts.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2003-2019 John Goerzen & contributors
+# Copyright (C) 2003-2016 John Goerzen & contributors
 #
 #    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
@@ -333,8 +333,11 @@ class SyncableAccount(Account):
 
         folderthreads = []
 
-        hook = self.getconf('presynchook', '')
-        self.callhook(hook)
+        hook_env = {
+            'OIMAP_ACCOUNT_NAME': self.getname(),
+        }
+
+        self.callhook('presynchook', hook_env)
 
         if self.utf_8_support and self.remoterepos.getdecodefoldernames():
             raise OfflineImapError("Configuration mismatch in account " +
@@ -385,24 +388,24 @@ class SyncableAccount(Account):
                                   "[%s]"% (remotefolder.getname(), remoterepos))
                     continue # Ignore filtered folder.
 
-                localfolder = self.get_local_folder(remotefolder)
-                if not localfolder.sync_this:
-                    self.ui.debug('', "Not syncing filtered folder '%s'"
-                                 "[%s]"% (localfolder.getname(), localfolder.repository))
-                    continue # Ignore filtered folder.
-
                 # The remote folder names must not have the local sep char in
                 # their names since this would cause troubles while converting
                 # the name back (from local to remote).
                 sep = localrepos.getsep()
-                if (sep == os.path.sep or
-                    sep == remoterepos.getsep() or
+                if (sep != os.path.sep and
+                    sep != remoterepos.getsep() and
                     sep in remotefolder.getname()):
                     self.ui.warn('', "Ignoring folder '%s' due to unsupported "
                         "'%s' character serving as local separator."%
                         (remotefolder.getname(), localrepos.getsep()))
                     continue # Ignore unsupported folder name.
 
+                localfolder = self.get_local_folder(remotefolder)
+                if not localfolder.sync_this:
+                    self.ui.debug('', "Not syncing filtered folder '%s'"
+                                 "[%s]"% (localfolder.getname(), localfolder.repository))
+                    continue # Ignore filtered folder.
+
                 if not globals.options.singlethreading:
                     thread = InstanceLimitedThread(
                         limitNamespace="%s%s"% (
@@ -438,20 +441,23 @@ class SyncableAccount(Account):
             localrepos.holdordropconnections()
             remoterepos.holdordropconnections()
 
-        hook = self.getconf('postsynchook', '')
-        self.callhook(hook)
+        self.callhook('postsynchook', hook_env)
 
-    def callhook(self, cmd):
+    def callhook(self, name, env={}):
         # Check for CTRL-C or SIGTERM and run postsynchook.
         if Account.abort_NOW_signal.is_set():
             return
+        cmd = self.getconf(name, '')
         if not cmd:
             return
         try:
             self.ui.callhook("Calling hook: " + cmd)
             if self.dryrun:
                 return
-            p = Popen(cmd, shell=True,
+            env = env.copy()
+            env.update(os.environ)
+            env['OIMAP_HOOK_NAME'] = name
+            p = Popen(cmd, shell=True, env=env,
                       stdin=PIPE, stdout=PIPE, stderr=PIPE,
                       close_fds=True)
             r = p.communicate()

offlineimap/folder/IMAP.py

@@ -402,6 +402,7 @@ class IMAPFolder(BaseFolder):
             return 0
 
         matchinguids = matchinguids.split(' ')
+        matchinguids = list(set(matchinguids)) # Remove duplicates.
         self.ui.debug('imap', '__savemessage_searchforheader: matchinguids now '
             + repr(matchinguids))
         if len(matchinguids) != 1 or matchinguids[0] is None:

offlineimap/imaplibutil.py

@@ -132,7 +132,7 @@ class IMAP4_Tunnel(UsefulIMAPMixIn, IMAP4):
         """The tunnelcmd comes in on host!"""
 
         self.host = host
-        self.process = subprocess.Popen(host, shell=True, close_fds=True,
+        self.process = subprocess.Popen('exec %s'%host, shell=True, close_fds=True,
                         stdin=subprocess.PIPE, stdout=subprocess.PIPE)
         (self.outfd, self.infd) = (self.process.stdin, self.process.stdout)
         # imaplib2 polls on this fd

offlineimap/imapserver.py

@@ -102,7 +102,7 @@ class IMAPServer(object):
         self.starttls = repos.getstarttls()
 
         if self.usessl \
-           and self.tlslevel is not "tls_compat" \
+           and self.tlslevel != "tls_compat" \
            and self.sslversion is None:
             raise Exception("When 'tls_level' is not 'tls_compat' "
                 "the 'ssl_version' must be set explicitly.")
@@ -356,16 +356,13 @@ class IMAPServer(object):
             return False
 
         self.connectionlock.acquire()
+        self.gssapi = False
         try:
             imapobj.authenticate('GSSAPI', self.__gsshandler)
-            return True
-        except imapobj.error as e:
-            self.gssapi = False
-            raise
-        else:
             self.gssapi = True
-            self.gss_vc = None
+            return True
         finally:
+            self.gss_vc = None
             self.connectionlock.release()
 
     def __authn_cram_md5(self, imapobj):
@@ -826,11 +823,12 @@ class IdleThread(object):
         statusrepos = account.statusrepos
         remotefolder = remoterepos.getfolder(self.folder, decode=False)
 
-        hook = account.getconf('presynchook', '')
-        account.callhook(hook)
+        hook_env = {
+            'OIMAP_ACCOUNT_NAME': account.getname(),
+        }
+        account.callhook('presynchook', hook_env)
         offlineimap.accounts.syncfolder(account, remotefolder, quick=False)
-        hook = account.getconf('postsynchook', '')
-        account.callhook(hook)
+        account.callhook('postsynchook', hook_env)
 
         ui = getglobalui()
         ui.unregisterthread(currentThread()) #syncfolder registered the thread

offlineimap/repository/IMAP.py

@@ -545,7 +545,7 @@ class IMAPRepository(BaseRepository):
 
         :param foldername: Full path of the folder to be created."""
 
-        if foldername is '':
+        if foldername == '':
             return
 
         if self.getreference():
@@ -561,7 +561,8 @@ class IMAPRepository(BaseRepository):
             try:
                 self.makefolder_single(folder_path)
             except OfflineImapError as e:
-                if '[ALREADYEXISTS]' not in e.reason:
+                reasonLower = e.reason.lower()  # Handle reasons '[ALREADYEXISTS]' and 'Mailbox already exists!' @chris001
+                if not ('already' in reasonLower and 'exists' in reasonLower):
                     raise
 
     def makefolder_single(self, foldername):

offlineimap/threadutil.py

@@ -15,13 +15,12 @@
 #    along with this program; if not, write to the Free Software
 #    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
 
-from threading import Lock, Thread, BoundedSemaphore, currentThread
+from threading import Lock, Thread, BoundedSemaphore
 try:
     from Queue import Queue, Empty
 except ImportError: # python3
     from queue import Queue, Empty
 import traceback
-import os.path
 from offlineimap.ui import getglobalui
 
 

offlineimap/ui/__init__.py

@@ -24,7 +24,7 @@ UI_LIST = {'ttyui': TTY.TTYUI,
            'syslog': Noninteractive.Syslog,
            'machineui': Machine.MachineUI}
 
-#add Blinkenlights UI if it imports correctly (curses installed)
+# add Blinkenlights UI if it imports correctly (curses installed)
 try:
     from offlineimap.ui import Curses
     UI_LIST['blinkenlights'] = Curses.Blinkenlights

offlineimap/version.py

@@ -0,0 +1,13 @@
+__productname__ = 'OfflineIMAP'
+# Expecting trailing "-rcN" or "" for stable releases.
+__version__     = "7.3.4"
+__copyright__   = "Copyright 2002-2021 John Goerzen & contributors"
+__author__      = "John Goerzen"
+__author_email__= "offlineimap-project@lists.alioth.debian.org"
+__description__ = "Disconnected Universal IMAP Mail Synchronization/Reader Support"
+__license__  = "Licensed under the GNU GPL v2 or any later version (with an OpenSSL exception)"
+__bigcopyright__ = """%(__productname__)s %(__version__)s
+  %(__license__)s""" % locals()
+__homepage__ = "http://www.offlineimap.org"
+
+banner = __bigcopyright__

requirements.txt

@@ -1,5 +1,5 @@
-# Requirements
-six
+# Minimal requirements defined in setup.py
+-e .
+# Extra "optional" requirements
 gssapi[kerberos]
 portalocker[cygwin]
-rfc6555

setup.py

@@ -5,7 +5,7 @@
 # IMAP synchronization
 # Module: installer
 # COPYRIGHT #
-# Copyright (C) 2002 - 2018 John Goerzen & contributors
+# Copyright (C) 2002 - 2020 John Goerzen & contributors
 #
 #    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
@@ -23,9 +23,13 @@
 
 import os
 from distutils.core import setup, Command
-import offlineimap
 import logging
-from test.OLItest import TextTestRunner, TestLoader, OLITestLib
+
+from os import path
+here = path.abspath(path.dirname(__file__))
+
+# load __version__, __doc__, __author_, ...
+exec(open(path.join(here, 'offlineimap', 'version.py')).read())
 
 class TestCommand(Command):
     """runs the OLI testsuite"""
@@ -42,6 +46,11 @@ class TestCommand(Command):
         pass
 
     def run(self):
+        # Import the test classes here instead of at the begin of the module
+        # to avoid an implicit dependency of the 'offlineimap' module
+        # in the setup.py (which may run *before* offlineimap is installed)
+        from test.OLItest import TextTestRunner, TestLoader, OLITestLib
+
         logging.basicConfig(format='%(message)s')
         # set credentials and OfflineImap command to be executed:
         OLITestLib(cred_file='./test/credentials.conf', cmd='./offlineimap.py')
@@ -49,20 +58,25 @@ class TestCommand(Command):
         #TODO: failfast does not seem to exist in python2.6?
         TextTestRunner(verbosity=2,failfast=True).run(suite)
 
+reqs = [
+    'six',
+    'rfc6555'
+    ]
 
 setup(name = "offlineimap",
-      version = offlineimap.__version__,
-      description = offlineimap.__description__,
-      long_description = offlineimap.__description__,
-      author = offlineimap.__author__,
-      author_email = offlineimap.__author_email__,
-      url = offlineimap.__homepage__,
+      version = __version__,
+      description = __description__,
+      long_description = __description__,
+      author = __author__,
+      author_email = __author_email__,
+      url = __homepage__,
       packages = ['offlineimap', 'offlineimap.folder',
                   'offlineimap.repository', 'offlineimap.ui',
                   'offlineimap.utils'],
       scripts = ['bin/offlineimap'],
-      license = offlineimap.__copyright__ + \
+      license = __copyright__ + \
                 ", Licensed under the GPL version 2",
-      cmdclass = { 'test': TestCommand}
+      cmdclass = { 'test': TestCommand},
+      install_requires = reqs
 )