kotovalexarian-likes-gitlab/gitlab-org--gitlab-foss
1
0
Fork 0
Code Releases Activity
gitlab-org--gitlab-foss/doc/incoming_email
History
Rémy Coutable 9f218fc184 Improve and finish the fallback to the In-Reply-To and References header for the reply-by-email feature 
A few things to note:
- The IncomingEmail feature is now enabled even without a
  correctly-formatted sub-address
- Message-ID for new thread mail are kept the same so that subsequent
  notifications to this thread are grouped in the thread by the email
  service that receives the notification
  (i.e. In-Reply-To of the answer == Message-ID of the first thread message)
- To maximize our chance to be able to retrieve the reply key, we look
  for it in the In-Reply-To header and the References header
- The pattern for the fallback reply message id is "reply-[key]@[gitlab_host]"
- Improve docs thanks to Axil
2016-03-25 13:05:15 +01:00
..
postfix.md Update mailroom/postfix documentation [ci skip] 2016-01-14 11:26:24 -06:00
README.md Improve and finish the fallback to the In-Reply-To and References header for the reply-by-email feature 2016-03-25 13:05:15 +01:00

README.md

Reply by email

GitLab can be set up to allow users to comment on issues and merge requests by replying to notification emails.

Requirement

Reply by email requires an IMAP-enabled email account. GitLab allows you to use three strategies for this feature:

  • using email sub-addressing
  • using a dedicated email address
  • using a catch-all mailbox

Email sub-addressing

If your provider or server supports email sub-addressing, we recommend using it.

Sub-addressing is a feature where any email to user+some_arbitrary_tag@example.com will end up in the mailbox for user@example.com, and is supported by providers such as Gmail, Google Apps, Yahoo! Mail, Outlook.com and iCloud, as well as the Postfix mail server which you can run on-premises.

Dedicated email address

This solution is really simple to set up: you just have to create an email address dedicated to receive your users' replies to GitLab notifications.

Catch-all mailbox

A catch-all mailbox for a domain will "catch all" the emails addressed to the domain that do not exist in the mail server.

How it works?

1. GitLab sends a notification email

When GitLab sends a notification and Reply by email is enabled, the Reply-To header is set to the address defined in your GitLab configuration, with the %{key} placeholder (if present) replaced by a specific "reply key". In addition, this "reply key" is also added to the References header.

2. You reply to the notification email

When you reply to the notification email, your email client will:

  • send the email to the Reply-To address it got from the notification email
  • set the In-Reply-To header to the value of the Message-ID header from the notification email
  • set the References header to the value of the Message-ID plus the value of the notification email's References header.

3. GitLab receives your reply to the notification email

When GitLab receives your reply, it will look for the "reply key" in the following headers, in this order:

  1. the To header
  2. the References header

If it finds a reply key, it will be able to leave your reply as a comment on the entity the notification was about (issue, merge request, commit...).

For more details about the Message-ID, In-Reply-To, and References headers, please consult RFC 5322.

Set it up

If you want to use Gmail / Google Apps with Reply by email, make sure you have IMAP access enabled and allowed less secure apps to access the account.

To set up a basic Postfix mail server with IMAP access on Ubuntu, follow these instructions.

Omnibus package installations

  1. Find the incoming_email section in /etc/gitlab/gitlab.rb, enable the feature and fill in the details for your specific IMAP server and email account:

    # Configuration for Postfix mail server, assumes mailbox incoming@gitlab.example.com
gitlab_rails['incoming_email_enabled'] = true

# The email address including the `%{key}` placeholder that will be replaced to reference the item being replied to.
# The placeholder can be omitted but if present, it must appear in the "user" part of the address (before the `@`).
gitlab_rails['incoming_email_address'] = "incoming+%{key}@gitlab.example.com"

# Email account username
# With third party providers, this is usually the full email address.
# With self-hosted email servers, this is usually the user part of the email address.
gitlab_rails['incoming_email_email'] = "incoming"
# Email account password
gitlab_rails['incoming_email_password'] = "[REDACTED]"

# IMAP server host
gitlab_rails['incoming_email_host'] = "gitlab.example.com"
# IMAP server port
gitlab_rails['incoming_email_port'] = 143
# Whether the IMAP server uses SSL
gitlab_rails['incoming_email_ssl'] = false
# Whether the IMAP server uses StartTLS
gitlab_rails['incoming_email_start_tls'] = false

# The mailbox where incoming mail will end up. Usually "inbox".
gitlab_rails['incoming_email_mailbox_name'] = "inbox"

    # Configuration for Gmail / Google Apps, assumes mailbox gitlab-incoming@gmail.com
gitlab_rails['incoming_email_enabled'] = true

# The email address including the `%{key}` placeholder that will be replaced to reference the item being replied to.
# The placeholder can be omitted but if present, it must appear in the "user" part of the address (before the `@`).
gitlab_rails['incoming_email_address'] = "gitlab-incoming+%{key}@gmail.com"

# Email account username
# With third party providers, this is usually the full email address.
# With self-hosted email servers, this is usually the user part of the email address.
gitlab_rails['incoming_email_email'] = "gitlab-incoming@gmail.com"
# Email account password
gitlab_rails['incoming_email_password'] = "[REDACTED]"

# IMAP server host
gitlab_rails['incoming_email_host'] = "imap.gmail.com"
# IMAP server port
gitlab_rails['incoming_email_port'] = 993
# Whether the IMAP server uses SSL
gitlab_rails['incoming_email_ssl'] = true
# Whether the IMAP server uses StartTLS
gitlab_rails['incoming_email_start_tls'] = false

# The mailbox where incoming mail will end up. Usually "inbox".
gitlab_rails['incoming_email_mailbox_name'] = "inbox"

  2. Reconfigure GitLab and restart mailroom for the changes to take effect:

    sudo gitlab-ctl reconfigure
sudo gitlab-ctl restart mailroom

  3. Verify that everything is configured correctly:

    sudo gitlab-rake gitlab:incoming_email:check

  4. Reply by email should now be working.

Installations from source

  1. Go to the GitLab installation directory:

    cd /home/git/gitlab

  2. Find the incoming_email section in config/gitlab.yml, enable the feature and fill in the details for your specific IMAP server and email account:

    sudo editor config/gitlab.yml

    # Configuration for Postfix mail server, assumes mailbox incoming@gitlab.example.com
incoming_email:
  enabled: true

  # The email address including the `%{key}` placeholder that will be replaced to reference the item being replied to.
  # The placeholder can be omitted but if present, it must appear in the "user" part of the address (before the `@`).
  address: "incoming+%{key}@gitlab.example.com"

  # Email account username
  # With third party providers, this is usually the full email address.
  # With self-hosted email servers, this is usually the user part of the email address.
  user: "incoming"
  # Email account password
  password: "[REDACTED]"

  # IMAP server host
  host: "gitlab.example.com"
  # IMAP server port
  port: 143
  # Whether the IMAP server uses SSL
  ssl: false
  # Whether the IMAP server uses StartTLS
  start_tls: false

  # The mailbox where incoming mail will end up. Usually "inbox".
  mailbox: "inbox"

    # Configuration for Gmail / Google Apps, assumes mailbox gitlab-incoming@gmail.com
incoming_email:
  enabled: true

  # The email address including the `%{key}` placeholder that will be replaced to reference the item being replied to.
  # The placeholder can be omitted but if present, it must appear in the "user" part of the address (before the `@`).
  address: "gitlab-incoming+%{key}@gmail.com"

  # Email account username
  # With third party providers, this is usually the full email address.
  # With self-hosted email servers, this is usually the user part of the email address.
  user: "gitlab-incoming@gmail.com"
  # Email account password
  password: "[REDACTED]"

  # IMAP server host
  host: "imap.gmail.com"
  # IMAP server port
  port: 993
  # Whether the IMAP server uses SSL
  ssl: true
  # Whether the IMAP server uses StartTLS
  start_tls: false

  # The mailbox where incoming mail will end up. Usually "inbox".
  mailbox: "inbox"

  3. Enable mail_room in the init script at /etc/default/gitlab:

    sudo mkdir -p /etc/default
echo 'mail_room_enabled=true' | sudo tee -a /etc/default/gitlab

  4. Restart GitLab:

    sudo service gitlab restart

  5. Verify that everything is configured correctly:

    sudo -u git -H bundle exec rake gitlab:incoming_email:check RAILS_ENV=production

  6. Reply by email should now be working.

Development

  1. Go to the GitLab installation directory.

  2. Find the incoming_email section in config/gitlab.yml, enable the feature and fill in the details for your specific IMAP server and email account:

    # Configuration for Gmail / Google Apps, assumes mailbox gitlab-incoming@gmail.com
incoming_email:
  enabled: true

  # The email address including the `%{key}` placeholder that will be replaced to reference the item being replied to.
  # The placeholder can be omitted but if present, it must appear in the "user" part of the address (before the `@`).
  address: "gitlab-incoming+%{key}@gmail.com"

  # Email account username
  # With third party providers, this is usually the full email address.
  # With self-hosted email servers, this is usually the user part of the email address.
  user: "gitlab-incoming@gmail.com"
  # Email account password
  password: "[REDACTED]"

  # IMAP server host
  host: "imap.gmail.com"
  # IMAP server port
  port: 993
  # Whether the IMAP server uses SSL
  ssl: true
  # Whether the IMAP server uses StartTLS
  start_tls: false

  # The mailbox where incoming mail will end up. Usually "inbox".
  mailbox: "inbox"

    As mentioned, the part after + is ignored, and this will end up in the mailbox for gitlab-incoming@gmail.com.

  3. Uncomment the mail_room line in your Procfile:

    mail_room: bundle exec mail_room -q -c config/mail_room.yml

  4. Restart GitLab:

    bundle exec foreman start

  5. Verify that everything is configured correctly:

    bundle exec rake gitlab:incoming_email:check RAILS_ENV=development

  6. Reply by email should now be working.