Merge branch 'mailroom_idle_timeout' into 'master'

Allows configuration of idle_timeout for incoming email.

https://gitlab.com/gitlab-org/omnibus-gitlab/merge_requests/1087

See merge request !7423

6 files changed, 19 insertions, 1 deletions

diff --git a/changelogs/unreleased/mailroom_idle_timeout.yml b/changelogs/unreleased/mailroom_idle_timeout.yml
new file mode 100644
index 00000000000..276b28a56dd
--- /dev/null
+++ b/changelogs/unreleased/mailroom_idle_timeout.yml
@@ -0,0 +1,4 @@
+---
+title: Allow mail_room idle_timeout option to be configurable
+merge_request: 7423
+author:
diff --git a/config/gitlab.yml.example b/config/gitlab.yml.example
index 699ab6075b6..327e4a7937c 100644
--- a/config/gitlab.yml.example
+++ b/config/gitlab.yml.example
@@ -138,6 +138,8 @@ production: &base
 
     # The mailbox where incoming mail will end up. Usually "inbox".
     mailbox: "inbox"
+    # The IDLE command timeout.
+    idle_timeout: 60
 
   ## Build Artifacts
   artifacts:
diff --git a/config/mail_room.yml b/config/mail_room.yml
index b026d510f1b..774c5350a45 100644
--- a/config/mail_room.yml
+++ b/config/mail_room.yml
@@ -15,7 +15,7 @@
       :start_tls: <%= config[:start_tls].to_json %>
       :email: <%= config[:user].to_json %>
       :password: <%= config[:password].to_json %>
-      :idle_timeout: 60
+      :idle_timeout: <%= config[:idle_timeout].to_json %>
 
       :name: <%= config[:mailbox].to_json %>
 
diff --git a/doc/administration/reply_by_email.md b/doc/administration/reply_by_email.md
index 5a9a1582877..14cd7a03826 100644
--- a/doc/administration/reply_by_email.md
+++ b/doc/administration/reply_by_email.md
@@ -105,6 +105,8 @@ To set up a basic Postfix mail server with IMAP access on Ubuntu, follow
 
     # The mailbox where incoming mail will end up. Usually "inbox".
     gitlab_rails['incoming_email_mailbox_name'] = "inbox"
+    # The IDLE command timeout.
+    gitlab_rails['incoming_email_idle_timeout'] = 60
     ```
 
     ```ruby
@@ -133,6 +135,8 @@ To set up a basic Postfix mail server with IMAP access on Ubuntu, follow
 
     # The mailbox where incoming mail will end up. Usually "inbox".
     gitlab_rails['incoming_email_mailbox_name'] = "inbox"
+    # The IDLE command timeout.
+    gitlab_rails['incoming_email_idle_timeout'] = 60
     ```
 
 1. Reconfigure GitLab and restart mailroom for the changes to take effect:
@@ -192,6 +196,8 @@ To set up a basic Postfix mail server with IMAP access on Ubuntu, follow
 
       # The mailbox where incoming mail will end up. Usually "inbox".
       mailbox: "inbox"
+      # The IDLE command timeout.
+      idle_timeout: 60
     ```
 
     ```yaml
@@ -221,6 +227,8 @@ To set up a basic Postfix mail server with IMAP access on Ubuntu, follow
 
       # The mailbox where incoming mail will end up. Usually "inbox".
       mailbox: "inbox"
+      # The IDLE command timeout.
+      idle_timeout: 60
     ```
 
 1. Enable `mail_room` in the init script at `/etc/default/gitlab`:
@@ -277,6 +285,8 @@ To set up a basic Postfix mail server with IMAP access on Ubuntu, follow
 
       # The mailbox where incoming mail will end up. Usually "inbox".
       mailbox: "inbox"
+      # The IDLE command timeout.
+      idle_timeout: 60
     ```
 
     As mentioned, the part after `+` is ignored, and this will end up in the mailbox for `gitlab-incoming@gmail.com`.
diff --git a/lib/gitlab/mail_room.rb b/lib/gitlab/mail_room.rb
index a5220d92312..3503fac40e8 100644
--- a/lib/gitlab/mail_room.rb
+++ b/lib/gitlab/mail_room.rb
@@ -31,6 +31,7 @@ module Gitlab
         config[:ssl] = false if config[:ssl].nil?
         config[:start_tls] = false if config[:start_tls].nil?
         config[:mailbox] = 'inbox' if config[:mailbox].nil?
+        config[:idle_timeout] = 60 if config[:idle_timeout].nil?
 
         if config[:enabled] && config[:address]
           gitlab_redis = Gitlab::Redis.new(rails_env)
diff --git a/spec/config/mail_room_spec.rb b/spec/config/mail_room_spec.rb
index 22bf3055538..294fae95752 100644
--- a/spec/config/mail_room_spec.rb
+++ b/spec/config/mail_room_spec.rb
@@ -47,6 +47,7 @@ describe 'mail_room.yml' do
       expect(mailbox[:email]).to eq('gitlab-incoming@gmail.com')
       expect(mailbox[:password]).to eq('[REDACTED]')
       expect(mailbox[:name]).to eq('inbox')
+      expect(mailbox[:idle_timeout]).to eq(60)
 
       redis_url = gitlab_redis.url
       sentinels = gitlab_redis.sentinels