Merge remote-tracking branch 'kali/feature/3409_make_imap_poll_configurable' into develop

2 files changed, 31 insertions, 0 deletions

diff --git a/changes/feature_3409-make-imap-poll-configurable b/changes/feature_3409-make-imap-poll-configurable
new file mode 100644
index 00000000..8730b5ab
--- /dev/null
+++ b/changes/feature_3409-make-imap-poll-configurable
@@ -0,0 +1,2 @@
+  o Make mail fetch interval in imap service configurable via environment
+    variable. Closes: #3409
diff --git a/src/leap/bitmask/services/mail/imap.py b/src/leap/bitmask/services/mail/imap.py
index cf93c60e..4828180e 100644
--- a/src/leap/bitmask/services/mail/imap.py
+++ b/src/leap/bitmask/services/mail/imap.py
@@ -18,6 +18,7 @@
 Initialization of imap service
 """
 import logging
+import os
 #import sys
 
 from leap.mail.imap.service import imap
@@ -25,6 +26,30 @@ from leap.mail.imap.service import imap
 
 logger = logging.getLogger(__name__)
 
+# The name of the environment variable that has to be
+# set to override the default time value, in seconds.
+INCOMING_CHECK_PERIOD_ENV = "BITMASK_MAILCHECK_PERIOD"
+
+
+def get_mail_check_period():
+    """
+    Tries to get the value of the environment variable for
+    overriding the period for incoming mail fetch.
+    """
+    period = None
+    period_str = os.environ.get(INCOMING_CHECK_PERIOD_ENV, None)
+    try:
+        period = int(period_str)
+    except (ValueError, TypeError):
+        logger.warning("BAD value found for %s: %s" % (
+            INCOMING_CHECK_PERIOD_ENV,
+            period_str))
+    except Exception as exc:
+        logger.warning("Unhandled error while getting %s: %r" % (
+            INCOMING_CHECK_PERIOD_ENV,
+            exc))
+    return period
+
 
 def start_imap_service(*args, **kwargs):
     """
@@ -34,6 +59,10 @@ def start_imap_service(*args, **kwargs):
     """
     logger.debug('Launching imap service')
 
+    override_period = get_mail_check_period()
+    if override_period:
+        kwargs['check_period'] = override_period
+
     # Uncomment the next two lines to get a separate debugging log
     # TODO handle this by a separate flag.
     #log.startLogging(open('/tmp/leap-imap.log', 'w'))