Merge branch 'feat/add-expunge-option-mailroom' into 'master'

feat: add expunge deleted messages option to mailroom

See merge request gitlab-org/gitlab!31531

changelogs/unreleased/feat-add-expunge-option-mailroom.yml

+---
+title: Add expunge deleted messages option to mailroom
+merge_request: 31531
+author: Diego Louzán
+type: added

config/gitlab.yml.example

@@ -202,6 +202,9 @@ production: &base
     #
     # log_path: log/mail_room_json.log
 
+    # Whether to expunge (permanently remove) messages from the mailbox when they are deleted after delivery
+    expunge_deleted: false
+
   ## Build Artifacts
   artifacts:
     enabled: true

config/mail_room.yml

@@ -17,6 +17,7 @@
       :name: <%= config[:mailbox].to_json %>
 
       :delete_after_delivery: true
+      :expunge_deleted: <%= config[:expunge_deleted].to_json %>
 
       :delivery_method: sidekiq
       :delivery_options:

doc/administration/incoming_email.md

@@ -182,6 +182,9 @@ gitlab_rails['incoming_email_start_tls'] = false
 gitlab_rails['incoming_email_mailbox_name'] = "inbox"
 # The IDLE command timeout.
 gitlab_rails['incoming_email_idle_timeout'] = 60
+
+# Whether to expunge (permanently remove) messages from the mailbox when they are deleted after delivery
+gitlab_rails['incoming_email_expunge_deleted'] = true
 ```
 
 Example for source installs:
@@ -214,6 +217,9 @@ incoming_email:
     mailbox: "inbox"
     # The IDLE command timeout.
     idle_timeout: 60
+
+    # Whether to expunge (permanently remove) messages from the mailbox when they are deleted after delivery
+    expunge_deleted: true
 ```
 
 #### Gmail
@@ -249,6 +255,9 @@ gitlab_rails['incoming_email_start_tls'] = false
 gitlab_rails['incoming_email_mailbox_name'] = "inbox"
 # The IDLE command timeout.
 gitlab_rails['incoming_email_idle_timeout'] = 60
+
+# Whether to expunge (permanently remove) messages from the mailbox when they are deleted after delivery
+gitlab_rails['incoming_email_expunge_deleted'] = true
 ```
 
 Example for source installs:
@@ -281,6 +290,9 @@ incoming_email:
     mailbox: "inbox"
     # The IDLE command timeout.
     idle_timeout: 60
+
+    # Whether to expunge (permanently remove) messages from the mailbox when they are deleted after delivery
+    expunge_deleted: true
 ```
 
 #### Microsoft Exchange Server

doc/development/emails.md

@@ -57,6 +57,9 @@ See the [Rails guides](https://guides.rubyonrails.org/action_mailer_basics.html#
      mailbox: "inbox"
      # The IDLE command timeout.
      idle_timeout: 60
+
+     # Whether to expunge (permanently remove) messages from the mailbox when they are deleted after delivery
+     expunge_deleted: false
    ```
 
    As mentioned, the part after `+` is ignored, and this will end up in the mailbox for `gitlab-incoming@gmail.com`.

doc/user/project/service_desk.md

@@ -151,6 +151,7 @@ service_desk_email:
   log_path: "log/mailroom.log"
   mailbox: "inbox"
   idle_timeout: 60
+  expunge_deleted: true
 ```
 
 In this case, suppose the `mygroup/myproject` project Service Desk settings has the project name

lib/gitlab/mail_room.rb

@@ -19,7 +19,8 @@ module Gitlab
       start_tls: false,
       mailbox: 'inbox',
       idle_timeout: 60,
-      log_path: RAILS_ROOT_DIR.join('log', 'mail_room_json.log')
+      log_path: RAILS_ROOT_DIR.join('log', 'mail_room_json.log'),
+      expunge_deleted: false
     }.freeze
 
     # Email specific configuration which is merged with configuration

spec/config/mail_room_spec.rb

@@ -53,7 +53,8 @@ describe 'mail_room.yml' do
         email: 'gitlab-incoming@gmail.com',
         password: '[REDACTED]',
         name: 'inbox',
-        idle_timeout: 60
+        idle_timeout: 60,
+        expunge_deleted: true
       }
       expected_options = {
         redis_url: gitlab_redis_queues.url,

spec/fixtures/config/mail_room_enabled.yml

@@ -9,6 +9,7 @@ test:
     ssl: true
     start_tls: false
     mailbox: "inbox"
+    expunge_deleted: true
 
   service_desk_email:
     enabled: true
@@ -20,3 +21,4 @@ test:
     ssl: true
     start_tls: false
     mailbox: "inbox"
+    expunge_deleted: true

spec/lib/gitlab/mail_room/mail_room_spec.rb

@@ -13,7 +13,8 @@ describe Gitlab::MailRoom do
       start_tls: false,
       mailbox: 'inbox',
       idle_timeout: 60,
-      log_path: Rails.root.join('log', 'mail_room_json.log').to_s
+      log_path: Rails.root.join('log', 'mail_room_json.log').to_s,
+      expunge_deleted: false
     }
   end