2015-08-19 20:58:14 +00:00
# Reply by email
GitLab can be set up to allow users to comment on issues and merge requests by replying to notification emails.
2015-08-24 21:46:45 +00:00
## Get a mailbox
2015-08-19 20:58:14 +00:00
2015-10-13 11:07:59 +00:00
Reply by email requires an IMAP-enabled email account, with a provider or server that supports [email sub-addressing ](https://en.wikipedia.org/wiki/Email_address#Sub-addressing ). 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.
2015-08-24 18:23:24 +00:00
2015-10-13 11:07:59 +00:00
If you want to use Gmail / Google Apps with Reply by email, make sure you have [IMAP access enabled ](https://support.google.com/mail/troubleshooter/1668960?hl=en#ts=1665018 ) and [allow less secure apps to access the account ](https://support.google.com/accounts/answer/6010255 ).
2015-08-24 21:46:45 +00:00
To set up a basic Postfix mail server with IMAP access on Ubuntu, follow [these instructions ](./postfix.md ).
2015-08-24 18:23:24 +00:00
2015-08-19 20:58:14 +00:00
## Set it up
2015-09-09 11:11:08 +00:00
### Omnibus package installations
2015-10-13 11:07:59 +00:00
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:
2015-09-09 11:11:08 +00:00
```ruby
2015-10-13 11:07:59 +00:00
# Configuration for Postfix mail server, assumes mailbox incoming@gitlab.example.com
2015-10-07 09:43:38 +00:00
gitlab_rails['incoming_email_enabled'] = true
2015-10-13 11:07:59 +00:00
# The email address including a placeholder for the key that references the item being replied to.
# The `%{key}` placeholder is added after the user part, before the `@` .
2015-10-07 09:43:38 +00:00
gitlab_rails['incoming_email_address'] = "incoming+%{key}@gitlab.example.com"
2015-10-13 11:07:59 +00:00
# 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"
2015-10-07 09:43:38 +00:00
```
```ruby
2015-10-13 11:07:59 +00:00
# Configuration for Gmail / Google Apps, assumes mailbox gitlab-incoming@gmail.com
2015-09-21 07:46:47 +00:00
gitlab_rails['incoming_email_enabled'] = true
2015-10-13 11:07:59 +00:00
# The email address including the `%{key}` placeholder that will be replaced to reference the item being replied to.
# The `%{key}` placeholder is added after the user part, after a `+` character, before the `@` .
2015-09-21 07:46:47 +00:00
gitlab_rails['incoming_email_address'] = "gitlab-incoming+%{key}@gmail.com"
2015-10-13 11:07:59 +00:00
# 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"
2015-09-09 11:11:08 +00:00
```
2015-10-07 09:43:38 +00:00
As mentioned, the part after `+` in the address is ignored, and any email sent here will end up in the mailbox for `incoming@gitlab.example.com` /`gitlab-incoming@gmail.com`.
2015-09-09 11:11:08 +00:00
2016-01-14 14:46:56 +00:00
1. Reconfigure GitLab and restart mailroom for the changes to take effect:
2015-09-09 11:11:08 +00:00
```sh
sudo gitlab-ctl reconfigure
2016-01-14 14:46:56 +00:00
sudo gitlab-ctl restart mailroom
2015-09-09 11:11:08 +00:00
```
1. Verify that everything is configured correctly:
```sh
2015-09-21 07:46:47 +00:00
sudo gitlab-rake gitlab:incoming_email:check
2015-09-09 11:11:08 +00:00
```
1. Reply by email should now be working.
2015-08-19 20:58:14 +00:00
### Installations from source
2015-08-20 00:43:36 +00:00
1. Go to the GitLab installation directory:
```sh
cd /home/git/gitlab
```
2015-08-19 20:58:14 +00:00
2015-10-13 11:07:59 +00:00
1. 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:
2015-08-20 00:43:36 +00:00
```sh
sudo editor config/gitlab.yml
```
2015-08-27 08:45:03 +00:00
2015-08-19 20:58:14 +00:00
```yaml
2015-10-13 11:07:59 +00:00
# Configuration for Postfix mail server, assumes mailbox incoming@gitlab.example.com
2015-10-07 09:43:38 +00:00
incoming_email:
enabled: true
2015-10-13 11:07:59 +00:00
# The email address including the `%{key}` placeholder that will be replaced to reference the item being replied to.
# The `%{key}` placeholder is added after the user part, after a `+` character, before the `@` .
2015-10-07 09:43:38 +00:00
address: "incoming+%{key}@gitlab.example.com"
2015-10-13 11:07:59 +00:00
# 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"
2015-10-07 09:43:38 +00:00
```
```yaml
2015-10-13 11:07:59 +00:00
# Configuration for Gmail / Google Apps, assumes mailbox gitlab-incoming@gmail.com
2015-09-21 07:46:47 +00:00
incoming_email:
2015-08-19 20:58:14 +00:00
enabled: true
2015-10-13 11:07:59 +00:00
# The email address including the `%{key}` placeholder that will be replaced to reference the item being replied to.
# The `%{key}` placeholder is added after the user part, after a `+` character, before the `@` .
address: "gitlab-incoming+%{key}@gmail.com"
2015-08-27 08:45:03 +00:00
2015-10-13 11:07:59 +00:00
# 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]"
2015-08-19 20:58:14 +00:00
2015-10-13 11:07:59 +00:00
# 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
2015-08-19 20:58:14 +00:00
2015-10-13 11:07:59 +00:00
# The mailbox where incoming mail will end up. Usually "inbox".
mailbox: "inbox"
2015-10-07 09:43:38 +00:00
```
2015-10-13 11:07:59 +00:00
As mentioned, the part after `+` in the address is ignored, and any email sent here will end up in the mailbox for `incoming@gitlab.example.com` /`gitlab-incoming@gmail.com`.
2015-08-19 20:58:14 +00:00
2015-10-13 11:07:59 +00:00
1. Enable `mail_room` in the init script at `/etc/default/gitlab` :
2015-08-25 17:23:55 +00:00
2015-08-19 20:58:14 +00:00
```sh
2015-08-26 16:23:25 +00:00
sudo mkdir -p /etc/default
echo 'mail_room_enabled=true' | sudo tee -a /etc/default/gitlab
2015-08-19 20:58:14 +00:00
```
2015-10-13 11:07:59 +00:00
1. Restart GitLab:
2015-08-27 08:45:03 +00:00
2015-08-19 20:58:14 +00:00
```sh
sudo service gitlab restart
```
2015-10-13 11:07:59 +00:00
1. Verify that everything is configured correctly:
2015-08-20 21:03:04 +00:00
```sh
2015-09-21 07:46:47 +00:00
sudo -u git -H bundle exec rake gitlab:incoming_email:check RAILS_ENV=production
2015-08-20 21:03:04 +00:00
```
2015-10-13 11:07:59 +00:00
1. Reply by email should now be working.
2015-08-19 20:58:14 +00:00
2015-08-21 22:13:22 +00:00
### Development
1. Go to the GitLab installation directory.
2015-10-13 11:07:59 +00:00
1. 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:
2015-08-27 08:45:03 +00:00
2015-08-21 22:13:22 +00:00
```yaml
2015-10-13 11:07:59 +00:00
# Configuration for Gmail / Google Apps, assumes mailbox gitlab-incoming@gmail.com
2015-09-21 07:46:47 +00:00
incoming_email:
2015-08-21 22:13:22 +00:00
enabled: true
2015-10-13 11:07:59 +00:00
# The email address including a placeholder for the key that references the item being replied to.
# The `%{key}` placeholder is added after the user part, before the `@` .
2015-09-21 07:46:47 +00:00
address: "gitlab-incoming+%{key}@gmail.com"
2015-08-21 22:13:22 +00:00
2015-10-13 11:07:59 +00:00
# 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]"
2015-08-21 22:13:22 +00:00
2015-10-13 11:07:59 +00:00
# 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
2015-08-27 08:45:03 +00:00
2015-10-13 11:07:59 +00:00
# The mailbox where incoming mail will end up. Usually "inbox".
mailbox: "inbox"
2015-08-21 22:13:22 +00:00
```
2015-10-13 11:07:59 +00:00
As mentioned, the part after `+` is ignored, and this will end up in the mailbox for `gitlab-incoming@gmail.com` .
2015-08-21 22:13:22 +00:00
2015-10-13 11:07:59 +00:00
1. Uncomment the `mail_room` line in your `Procfile` :
2015-08-21 22:13:22 +00:00
```yaml
mail_room: bundle exec mail_room -q -c config/mail_room.yml
```
2015-10-13 11:07:59 +00:00
1. Restart GitLab:
2015-08-27 08:45:03 +00:00
2015-08-21 22:13:22 +00:00
```sh
bundle exec foreman start
```
2015-10-13 11:07:59 +00:00
1. Verify that everything is configured correctly:
2015-08-21 22:13:22 +00:00
```sh
2015-09-21 07:46:47 +00:00
bundle exec rake gitlab:incoming_email:check RAILS_ENV=development
2015-08-21 22:13:22 +00:00
```
2015-10-13 11:07:59 +00:00
1. Reply by email should now be working.