Commit ee028d9d authored by Douwe Maan's avatar Douwe Maan

Rename reply_by_email to incoming_email to prepare for the future.

parent 11bbc06b
...@@ -110,7 +110,7 @@ class Notify < BaseMailer ...@@ -110,7 +110,7 @@ class Notify < BaseMailer
if reply_key if reply_key
headers['X-GitLab-Reply-Key'] = reply_key headers['X-GitLab-Reply-Key'] = reply_key
address = Mail::Address.new(Gitlab::ReplyByEmail.reply_address(reply_key)) address = Mail::Address.new(Gitlab::IncomingEmail.reply_address(reply_key))
address.display_name = @project.name_with_namespace address.display_name = @project.name_with_namespace
headers['Reply-To'] = address headers['Reply-To'] = address
...@@ -150,6 +150,6 @@ class Notify < BaseMailer ...@@ -150,6 +150,6 @@ class Notify < BaseMailer
end end
def reply_key def reply_key
@reply_key ||= Gitlab::ReplyByEmail.reply_key @reply_key ||= SentNotification.reply_key
end end
end end
...@@ -23,6 +23,12 @@ class SentNotification < ActiveRecord::Base ...@@ -23,6 +23,12 @@ class SentNotification < ActiveRecord::Base
validates :commit_id, presence: true, if: :for_commit? validates :commit_id, presence: true, if: :for_commit?
class << self class << self
def reply_key
return nil unless Gitlab::IncomingEmail.enabled?
SecureRandom.hex(16)
end
def for(reply_key) def for(reply_key)
find_by(reply_key: reply_key) find_by(reply_key: reply_key)
end end
......
...@@ -58,7 +58,7 @@ ...@@ -58,7 +58,7 @@
%p %p
Reply by email Reply by email
%span.light.pull-right %span.light.pull-right
= boolean_to_icon Gitlab::ReplyByEmail.enabled? = boolean_to_icon Gitlab::IncomingEmail.enabled?
.col-md-4 .col-md-4
%h4 %h4
Components Components
......
...@@ -4,7 +4,7 @@ class EmailReceiverWorker ...@@ -4,7 +4,7 @@ class EmailReceiverWorker
sidekiq_options queue: :incoming_email sidekiq_options queue: :incoming_email
def perform(raw) def perform(raw)
return unless Gitlab::ReplyByEmail.enabled? return unless Gitlab::IncomingEmail.enabled?
begin begin
Gitlab::Email::Receiver.new(raw).execute Gitlab::Email::Receiver.new(raw).execute
......
...@@ -96,10 +96,10 @@ production: &base ...@@ -96,10 +96,10 @@ production: &base
## Reply by email ## Reply by email
# Allow users to comment on issues and merge requests by replying to notification emails. # Allow users to comment on issues and merge requests by replying to notification emails.
# For documentation on how to set this up, see http://doc.gitlab.com/ce/reply_by_email/README.html # For documentation on how to set this up, see http://doc.gitlab.com/ce/incoming_email/README.html
reply_by_email: incoming_email:
enabled: false enabled: false
address: "replies+%{reply_key}@gitlab.example.com" address: "incoming+%{key}@gitlab.example.com"
## Gravatar ## Gravatar
## For Libravatar see: http://doc.gitlab.com/ce/customization/libravatar.html ## For Libravatar see: http://doc.gitlab.com/ce/customization/libravatar.html
......
...@@ -187,8 +187,8 @@ Settings.gitlab_ci['builds_path'] = File.expand_path(Settings.gitlab_ci[ ...@@ -187,8 +187,8 @@ Settings.gitlab_ci['builds_path'] = File.expand_path(Settings.gitlab_ci[
# #
# Reply by email # Reply by email
# #
Settings['reply_by_email'] ||= Settingslogic.new({}) Settings['incoming_email'] ||= Settingslogic.new({})
Settings.reply_by_email['enabled'] = false if Settings.reply_by_email['enabled'].nil? Settings.incoming_email['enabled'] = false if Settings.incoming_email['enabled'].nil?
# #
# Gravatar # Gravatar
......
...@@ -46,7 +46,7 @@ ...@@ -46,7 +46,7 @@
- [System hooks](system_hooks/system_hooks.md) Notifications when users, projects and keys are changed. - [System hooks](system_hooks/system_hooks.md) Notifications when users, projects and keys are changed.
- [Update](update/README.md) Update guides to upgrade your installation. - [Update](update/README.md) Update guides to upgrade your installation.
- [Welcome message](customization/welcome_message.md) Add a custom welcome message to the sign-in page. - [Welcome message](customization/welcome_message.md) Add a custom welcome message to the sign-in page.
- [Reply by email](reply_by_email/README.md) Allow users to comment on issues and merge requests by replying to notification emails. - [Reply by email](incoming_email/README.md) Allow users to comment on issues and merge requests by replying to notification emails.
- [Migrate GitLab CI to CE/EE](migrate_ci_to_ce/README.md) Follow this guide to migrate your existing GitLab CI data to GitLab CE/EE. - [Migrate GitLab CI to CE/EE](migrate_ci_to_ce/README.md) Follow this guide to migrate your existing GitLab CI data to GitLab CE/EE.
### Administrator documentation ### Administrator documentation
......
...@@ -12,24 +12,24 @@ To set up a basic Postfix mail server with IMAP access on Ubuntu, follow [these ...@@ -12,24 +12,24 @@ To set up a basic Postfix mail server with IMAP access on Ubuntu, follow [these
## Set it up ## Set it up
In this example, we'll use the Gmail address `gitlab-replies@gmail.com`. In this example, we'll use the Gmail address `gitlab-incoming@gmail.com`.
### Omnibus package installations ### Omnibus package installations
1. Find the `reply_by_email` section in `/etc/gitlab/gitlab.rb`, enable the feature, enter the email address including a placeholder for the `reply_key` and fill in the details for your specific IMAP server and email account: 1. Find the `incoming_email` section in `/etc/gitlab/gitlab.rb`, enable the feature, enter the email address including a placeholder for the `key` and fill in the details for your specific IMAP server and email account:
```ruby ```ruby
gitlab_rails['reply_by_email_enabled'] = true gitlab_rails['incoming_email_enabled'] = true
gitlab_rails['reply_by_email_address'] = "gitlab-replies+%{reply_key}@gmail.com" gitlab_rails['incoming_email_address'] = "gitlab-incoming+%{key}@gmail.com"
gitlab_rails['reply_by_email_host'] = "imap.gmail.com" # IMAP server host gitlab_rails['incoming_email_host'] = "imap.gmail.com" # IMAP server host
gitlab_rails['reply_by_email_port'] = 993 # IMAP server port gitlab_rails['incoming_email_port'] = 993 # IMAP server port
gitlab_rails['reply_by_email_ssl'] = true # Whether the IMAP server uses SSL gitlab_rails['incoming_email_ssl'] = true # Whether the IMAP server uses SSL
gitlab_rails['reply_by_email_email'] = "gitlab-replies@gmail.com" # Email account username. Usually the full email address. gitlab_rails['incoming_email_email'] = "gitlab-incoming@gmail.com" # Email account username. Usually the full email address.
gitlab_rails['reply_by_email_password'] = "password" # Email account password gitlab_rails['incoming_email_password'] = "password" # Email account password
gitlab_rails['reply_by_email_mailbox_name'] = "inbox" # The name of the mailbox where incoming mail will end up. Usually "inbox". gitlab_rails['incoming_email_mailbox_name'] = "inbox" # The name of the mailbox where incoming mail will end up. Usually "inbox".
``` ```
As mentioned, the part after `+` in the address is ignored, and any email sent here will end up in the mailbox for `gitlab-replies@gmail.com`. As mentioned, the part after `+` in the address is ignored, and any email sent here will end up in the mailbox for `gitlab-incoming@gmail.com`.
1. Reconfigure GitLab for the changes to take effect: 1. Reconfigure GitLab for the changes to take effect:
...@@ -40,7 +40,7 @@ In this example, we'll use the Gmail address `gitlab-replies@gmail.com`. ...@@ -40,7 +40,7 @@ In this example, we'll use the Gmail address `gitlab-replies@gmail.com`.
1. Verify that everything is configured correctly: 1. Verify that everything is configured correctly:
```sh ```sh
sudo gitlab-rake gitlab:reply_by_email:check sudo gitlab-rake gitlab:incoming_email:check
``` ```
1. Reply by email should now be working. 1. Reply by email should now be working.
...@@ -53,19 +53,19 @@ In this example, we'll use the Gmail address `gitlab-replies@gmail.com`. ...@@ -53,19 +53,19 @@ In this example, we'll use the Gmail address `gitlab-replies@gmail.com`.
cd /home/git/gitlab cd /home/git/gitlab
``` ```
1. Find the `reply_by_email` section in `config/gitlab.yml`, enable the feature and enter the email address including a placeholder for the `reply_key`: 1. Find the `incoming_email` section in `config/gitlab.yml`, enable the feature and enter the email address including a placeholder for the `key`:
```sh ```sh
sudo editor config/gitlab.yml sudo editor config/gitlab.yml
``` ```
```yaml ```yaml
reply_by_email: incoming_email:
enabled: true enabled: true
address: "gitlab-replies+%{reply_key}@gmail.com" address: "gitlab-incoming+%{key}@gmail.com"
``` ```
As mentioned, the part after `+` in the address is ignored, and any email sent here will end up in the mailbox for `gitlab-replies@gmail.com`. As mentioned, the part after `+` in the address is ignored, and any email sent here will end up in the mailbox for `gitlab-incoming@gmail.com`.
2. Copy `config/mail_room.yml.example` to `config/mail_room.yml`: 2. Copy `config/mail_room.yml.example` to `config/mail_room.yml`:
...@@ -89,7 +89,7 @@ In this example, we'll use the Gmail address `gitlab-replies@gmail.com`. ...@@ -89,7 +89,7 @@ In this example, we'll use the Gmail address `gitlab-replies@gmail.com`.
# Whether the IMAP server uses SSL # Whether the IMAP server uses SSL
:ssl: true :ssl: true
# Email account username. Usually the full email address. # Email account username. Usually the full email address.
:email: "gitlab-replies@gmail.com" :email: "gitlab-incoming@gmail.com"
# Email account password # Email account password
:password: "[REDACTED]" :password: "[REDACTED]"
# The name of the mailbox where incoming mail will end up. Usually "inbox". # The name of the mailbox where incoming mail will end up. Usually "inbox".
...@@ -125,7 +125,7 @@ In this example, we'll use the Gmail address `gitlab-replies@gmail.com`. ...@@ -125,7 +125,7 @@ In this example, we'll use the Gmail address `gitlab-replies@gmail.com`.
7. Verify that everything is configured correctly: 7. Verify that everything is configured correctly:
```sh ```sh
sudo -u git -H bundle exec rake gitlab:reply_by_email:check RAILS_ENV=production sudo -u git -H bundle exec rake gitlab:incoming_email:check RAILS_ENV=production
``` ```
8. Reply by email should now be working. 8. Reply by email should now be working.
...@@ -134,15 +134,15 @@ In this example, we'll use the Gmail address `gitlab-replies@gmail.com`. ...@@ -134,15 +134,15 @@ In this example, we'll use the Gmail address `gitlab-replies@gmail.com`.
1. Go to the GitLab installation directory. 1. Go to the GitLab installation directory.
1. Find the `reply_by_email` section in `config/gitlab.yml`, enable the feature and enter the email address including a placeholder for the `reply_key`: 1. Find the `incoming_email` section in `config/gitlab.yml`, enable the feature and enter the email address including a placeholder for the `key`:
```yaml ```yaml
reply_by_email: incoming_email:
enabled: true enabled: true
address: "gitlab-replies+%{reply_key}@gmail.com" address: "gitlab-incoming+%{key}@gmail.com"
``` ```
As mentioned, the part after `+` is ignored, and this will end up in the mailbox for `gitlab-replies@gmail.com`. As mentioned, the part after `+` is ignored, and this will end up in the mailbox for `gitlab-incoming@gmail.com`.
2. Copy `config/mail_room.yml.example` to `config/mail_room.yml`: 2. Copy `config/mail_room.yml.example` to `config/mail_room.yml`:
...@@ -162,7 +162,7 @@ In this example, we'll use the Gmail address `gitlab-replies@gmail.com`. ...@@ -162,7 +162,7 @@ In this example, we'll use the Gmail address `gitlab-replies@gmail.com`.
# Whether the IMAP server uses SSL # Whether the IMAP server uses SSL
:ssl: true :ssl: true
# Email account username. Usually the full email address. # Email account username. Usually the full email address.
:email: "gitlab-replies@gmail.com" :email: "gitlab-incoming@gmail.com"
# Email account password # Email account password
:password: "[REDACTED]" :password: "[REDACTED]"
# The name of the mailbox where incoming mail will end up. Usually "inbox". # The name of the mailbox where incoming mail will end up. Usually "inbox".
...@@ -197,7 +197,7 @@ In this example, we'll use the Gmail address `gitlab-replies@gmail.com`. ...@@ -197,7 +197,7 @@ In this example, we'll use the Gmail address `gitlab-replies@gmail.com`.
7. Verify that everything is configured correctly: 7. Verify that everything is configured correctly:
```sh ```sh
bundle exec rake gitlab:reply_by_email:check RAILS_ENV=development bundle exec rake gitlab:incoming_email:check RAILS_ENV=development
``` ```
8. Reply by email should now be working. 8. Reply by email should now be working.
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
This document will take you through the steps of setting up a basic Postfix mail server with IMAP authentication on Ubuntu, to be used with Reply by email. This document will take you through the steps of setting up a basic Postfix mail server with IMAP authentication on Ubuntu, to be used with Reply by email.
The instructions make the assumption that you will be using the email address `replies@gitlab.example.com`, that is, username `replies` on host `gitlab.example.com`. Don't forget to change it to your actual host when executing the example code snippets. The instructions make the assumption that you will be using the email address `incoming@gitlab.example.com`, that is, username `incoming` on host `gitlab.example.com`. Don't forget to change it to your actual host when executing the example code snippets.
## Configure your server firewall ## Configure your server firewall
...@@ -27,16 +27,16 @@ The instructions make the assumption that you will be using the email address `r ...@@ -27,16 +27,16 @@ The instructions make the assumption that you will be using the email address `r
## Create user ## Create user
1. Create a user for replies. 1. Create a user for incoming.
```sh ```sh
sudo useradd -m -s /bin/bash replies sudo useradd -m -s /bin/bash incoming
``` ```
1. Set a password for this user. 1. Set a password for this user.
```sh ```sh
sudo passwd replies sudo passwd incoming
``` ```
Be sure not to forget this, you'll need it later. Be sure not to forget this, you'll need it later.
...@@ -70,12 +70,12 @@ The instructions make the assumption that you will be using the email address `r ...@@ -70,12 +70,12 @@ The instructions make the assumption that you will be using the email address `r
sudo postfix start sudo postfix start
``` ```
1. Send the new `replies` user a dummy email to test SMTP, by entering the following into the SMTP prompt: 1. Send the new `incoming` user a dummy email to test SMTP, by entering the following into the SMTP prompt:
``` ```
ehlo localhost ehlo localhost
mail from: root@localhost mail from: root@localhost
rcpt to: replies@localhost rcpt to: incoming@localhost
data data
Subject: Re: Some issue Subject: Re: Some issue
...@@ -86,17 +86,17 @@ The instructions make the assumption that you will be using the email address `r ...@@ -86,17 +86,17 @@ The instructions make the assumption that you will be using the email address `r
(Note: The `.` is a literal period on its own line) (Note: The `.` is a literal period on its own line)
1. Check if the `replies` user received the email: 1. Check if the `incoming` user received the email:
```sh ```sh
su - replies su - incoming
mail mail
``` ```
You should see output like this: You should see output like this:
``` ```
"/var/mail/replies": 1 message 1 unread "/var/mail/incoming": 1 message 1 unread
>U 1 root@localhost 59/2842 Re: Some issue >U 1 root@localhost 59/2842 Re: Some issue
``` ```
...@@ -106,7 +106,7 @@ The instructions make the assumption that you will be using the email address `r ...@@ -106,7 +106,7 @@ The instructions make the assumption that you will be using the email address `r
q q
``` ```
1. Log out of the `replies` account and go back to being `root`: 1. Log out of the `incoming` account and go back to being `root`:
```sh ```sh
logout logout
...@@ -131,18 +131,18 @@ Courier, which we will install later to add IMAP authentication, requires mailbo ...@@ -131,18 +131,18 @@ Courier, which we will install later to add IMAP authentication, requires mailbo
1. Test the new setup: 1. Test the new setup:
1. Follow steps 1 and 2 of _[Test the out-of-the-box setup](#test-the-out-of-the-box-setup)_. 1. Follow steps 1 and 2 of _[Test the out-of-the-box setup](#test-the-out-of-the-box-setup)_.
2. Check if the `replies` user received the email: 2. Check if the `incoming` user received the email:
```sh ```sh
su - replies su - incoming
MAIL=/home/replies/Maildir MAIL=/home/incoming/Maildir
mail mail
``` ```
You should see output like this: You should see output like this:
``` ```
"/home/replies/Maildir": 1 message 1 unread "/home/incoming/Maildir": 1 message 1 unread
>U 1 root@localhost 59/2842 Re: Some issue >U 1 root@localhost 59/2842 Re: Some issue
``` ```
...@@ -152,7 +152,7 @@ Courier, which we will install later to add IMAP authentication, requires mailbo ...@@ -152,7 +152,7 @@ Courier, which we will install later to add IMAP authentication, requires mailbo
q q
``` ```
1. Log out of the `replies` account and go back to being `root`: 1. Log out of the `incoming` account and go back to being `root`:
```sh ```sh
logout logout
...@@ -221,12 +221,12 @@ Courier, which we will install later to add IMAP authentication, requires mailbo ...@@ -221,12 +221,12 @@ Courier, which we will install later to add IMAP authentication, requires mailbo
If you get a `Connection refused` error instead, make sure your firewall is setup to allow inbound traffic on port 25. If you get a `Connection refused` error instead, make sure your firewall is setup to allow inbound traffic on port 25.
1. Send the `replies` user a dummy email to test SMTP, by entering the following into the SMTP prompt: 1. Send the `incoming` user a dummy email to test SMTP, by entering the following into the SMTP prompt:
``` ```
ehlo gitlab.example.com ehlo gitlab.example.com
mail from: root@gitlab.example.com mail from: root@gitlab.example.com
rcpt to: replies@gitlab.example.com rcpt to: incoming@gitlab.example.com
data data
Subject: Re: Some issue Subject: Re: Some issue
...@@ -237,18 +237,18 @@ Courier, which we will install later to add IMAP authentication, requires mailbo ...@@ -237,18 +237,18 @@ Courier, which we will install later to add IMAP authentication, requires mailbo
(Note: The `.` is a literal period on its own line) (Note: The `.` is a literal period on its own line)
1. Check if the `replies` user received the email: 1. Check if the `incoming` user received the email:
```sh ```sh
su - replies su - incoming
MAIL=/home/replies/Maildir MAIL=/home/incoming/Maildir
mail mail
``` ```
You should see output like this: You should see output like this:
``` ```
"/home/replies/Maildir": 1 message 1 unread "/home/incoming/Maildir": 1 message 1 unread
>U 1 root@gitlab.example.com 59/2842 Re: Some issue >U 1 root@gitlab.example.com 59/2842 Re: Some issue
``` ```
...@@ -258,7 +258,7 @@ Courier, which we will install later to add IMAP authentication, requires mailbo ...@@ -258,7 +258,7 @@ Courier, which we will install later to add IMAP authentication, requires mailbo
q q
``` ```
1. Log out of the `replies` account and go back to being `root`: 1. Log out of the `incoming` account and go back to being `root`:
```sh ```sh
logout logout
...@@ -281,13 +281,13 @@ Courier, which we will install later to add IMAP authentication, requires mailbo ...@@ -281,13 +281,13 @@ Courier, which we will install later to add IMAP authentication, requires mailbo
- OK [CAPABILITY IMAP4rev1 UIDPLUS CHILDREN NAMESPACE THREAD=ORDEREDSUBJECT THREAD=REFERENCES SORT QUOTA IDLE ACL ACL2=UNION] Courier-IMAP ready. Copyright 1998-2011 Double Precision, Inc. See COPYING for distribution information. - OK [CAPABILITY IMAP4rev1 UIDPLUS CHILDREN NAMESPACE THREAD=ORDEREDSUBJECT THREAD=REFERENCES SORT QUOTA IDLE ACL ACL2=UNION] Courier-IMAP ready. Copyright 1998-2011 Double Precision, Inc. See COPYING for distribution information.
``` ```
1. Sign in as the `replies` user to test IMAP, by entering the following into the IMAP prompt: 1. Sign in as the `incoming` user to test IMAP, by entering the following into the IMAP prompt:
``` ```
a login replies PASSWORD a login incoming PASSWORD
``` ```
Replace PASSWORD with the password you set on the `replies` user earlier. Replace PASSWORD with the password you set on the `incoming` user earlier.
You should see output like this: You should see output like this:
...@@ -307,4 +307,4 @@ If all the tests were successful, Postfix is all set up and ready to receive ema ...@@ -307,4 +307,4 @@ If all the tests were successful, Postfix is all set up and ready to receive ema
--------- ---------
_This document was adapted from https://help.ubuntu.com/community/PostfixBasicSetupHowto, by contributors to the Ubuntu documentation wiki._ _This document was adapted from https://help.ubuntu.com/community/PostfixBasicSetupHowto, by contributors to the Ubuntu documentation wiki._
\ No newline at end of file
...@@ -65,7 +65,7 @@ module Gitlab ...@@ -65,7 +65,7 @@ module Gitlab
def reply_key def reply_key
reply_key = nil reply_key = nil
message.to.each do |address| message.to.each do |address|
reply_key = Gitlab::ReplyByEmail.reply_key_from_address(address) reply_key = Gitlab::IncomingEmail.key_from_address(address)
break if reply_key break if reply_key
end end
...@@ -98,7 +98,8 @@ module Gitlab ...@@ -98,7 +98,8 @@ module Gitlab
note: reply, note: reply,
noteable_type: sent_notification.noteable_type, noteable_type: sent_notification.noteable_type,
noteable_id: sent_notification.noteable_id, noteable_id: sent_notification.noteable_id,
commit_id: sent_notification.commit_id commit_id: sent_notification.commit_id,
line_code: sent_notification.line_code
).execute ).execute
end end
end end
......
module Gitlab module Gitlab
module ReplyByEmail module IncomingEmail
class << self class << self
def enabled? def enabled?
config.enabled && address_formatted_correctly? config.enabled && address_formatted_correctly?
...@@ -7,20 +7,14 @@ module Gitlab ...@@ -7,20 +7,14 @@ module Gitlab
def address_formatted_correctly? def address_formatted_correctly?
config.address && config.address &&
config.address.include?("%{reply_key}") config.address.include?("%{key}")
end end
def reply_key def reply_address(key)
return nil unless enabled? config.address.gsub('%{key}', key)
SecureRandom.hex(16)
end
def reply_address(reply_key)
config.address.gsub('%{reply_key}', reply_key)
end end
def reply_key_from_address(address) def key_from_address(address)
regex = address_regex regex = address_regex
return unless regex return unless regex
...@@ -33,7 +27,7 @@ module Gitlab ...@@ -33,7 +27,7 @@ module Gitlab
private private
def config def config
Gitlab.config.reply_by_email Gitlab.config.incoming_email
end end
def address_regex def address_regex
...@@ -41,7 +35,7 @@ module Gitlab ...@@ -41,7 +35,7 @@ module Gitlab
return nil unless wildcard_address return nil unless wildcard_address
regex = Regexp.escape(wildcard_address) regex = Regexp.escape(wildcard_address)
regex = regex.gsub(Regexp.escape('%{reply_key}'), "(.+)") regex = regex.gsub(Regexp.escape('%{key}'), "(.+)")
Regexp.new(regex).freeze Regexp.new(regex).freeze
end end
end end
......
...@@ -2,7 +2,7 @@ namespace :gitlab do ...@@ -2,7 +2,7 @@ namespace :gitlab do
desc "GitLab | Check the configuration of GitLab and its environment" desc "GitLab | Check the configuration of GitLab and its environment"
task check: %w{gitlab:gitlab_shell:check task check: %w{gitlab:gitlab_shell:check
gitlab:sidekiq:check gitlab:sidekiq:check
gitlab:reply_by_email:check gitlab:incoming_email:check
gitlab:ldap:check gitlab:ldap:check
gitlab:app:check} gitlab:app:check}
...@@ -634,13 +634,13 @@ namespace :gitlab do ...@@ -634,13 +634,13 @@ namespace :gitlab do
end end
namespace :reply_by_email do namespace :incoming_email do
desc "GitLab | Check the configuration of Reply by email" desc "GitLab | Check the configuration of Reply by email"
task check: :environment do task check: :environment do
warn_user_is_not_gitlab warn_user_is_not_gitlab
start_checking "Reply by email" start_checking "Reply by email"
if Gitlab.config.reply_by_email.enabled if Gitlab.config.incoming_email.enabled
check_address_formatted_correctly check_address_formatted_correctly
check_mail_room_config_exists check_mail_room_config_exists
check_imap_authentication check_imap_authentication
...@@ -665,12 +665,12 @@ namespace :gitlab do ...@@ -665,12 +665,12 @@ namespace :gitlab do
def check_address_formatted_correctly def check_address_formatted_correctly
print "Address formatted correctly? ... " print "Address formatted correctly? ... "
if Gitlab::ReplyByEmail.address_formatted_correctly? if Gitlab::IncomingEmail.address_formatted_correctly?
puts "yes".green puts "yes".green
else else
puts "no".red puts "no".red
try_fixing_it( try_fixing_it(
"Make sure that the address in config/gitlab.yml includes the '%{reply_key}' placeholder." "Make sure that the address in config/gitlab.yml includes the '%{key}' placeholder."
) )
fix_and_rerun fix_and_rerun
end end
...@@ -689,7 +689,7 @@ namespace :gitlab do ...@@ -689,7 +689,7 @@ namespace :gitlab do
"Enable mail_room in the init.d configuration." "Enable mail_room in the init.d configuration."
) )
for_more_information( for_more_information(
"doc/reply_by_email/README.md" "doc/incoming_email/README.md"
) )
fix_and_rerun fix_and_rerun
end end
...@@ -708,7 +708,7 @@ namespace :gitlab do ...@@ -708,7 +708,7 @@ namespace :gitlab do
"Enable mail_room in your Procfile." "Enable mail_room in your Procfile."
) )
for_more_information( for_more_information(
"doc/reply_by_email/README.md" "doc/incoming_email/README.md"
) )
fix_and_rerun fix_and_rerun
end end
...@@ -753,7 +753,7 @@ namespace :gitlab do ...@@ -753,7 +753,7 @@ namespace :gitlab do
"Check that the information in config/mail_room.yml is correct" "Check that the information in config/mail_room.yml is correct"
) )
for_more_information( for_more_information(
"doc/reply_by_email/README.md" "doc/incoming_email/README.md"
) )
fix_and_rerun fix_and_rerun
end end
...@@ -789,7 +789,7 @@ namespace :gitlab do ...@@ -789,7 +789,7 @@ namespace :gitlab do
"Check that the information in config/mail_room.yml is correct" "Check that the information in config/mail_room.yml is correct"
) )
for_more_information( for_more_information(
"doc/reply_by_email/README.md" "doc/incoming_email/README.md"
) )
fix_and_rerun fix_and_rerun
end end
......
...@@ -2,7 +2,7 @@ require "spec_helper" ...@@ -2,7 +2,7 @@ require "spec_helper"
describe Gitlab::Email::Receiver do describe Gitlab::Email::Receiver do
before do before do
stub_reply_by_email_setting(enabled: true, address: "reply+%{reply_key}@appmail.adventuretime.ooo") stub_incoming_email_setting(enabled: true, address: "reply+%{key}@appmail.adventuretime.ooo")
end end
let(:reply_key) { "59d8df8370b7e95c5a49fbf86aeb2c93" } let(:reply_key) { "59d8df8370b7e95c5a49fbf86aeb2c93" }
......
require "spec_helper" require "spec_helper"
describe Gitlab::ReplyByEmail do describe Gitlab::IncomingEmail do
describe "self.enabled?" do describe "self.enabled?" do
context "when reply by email is enabled" do context "when reply by email is enabled" do
before do before do
stub_reply_by_email_setting(enabled: true) stub_incoming_email_setting(enabled: true)
end end
context "when the address is valid" do context "when the address is valid" do
before do before do
stub_reply_by_email_setting(address: "replies+%{reply_key}@example.com") stub_incoming_email_setting(address: "replies+%{key}@example.com")
end end
it "returns true" do it "returns true" do
...@@ -19,7 +19,7 @@ describe Gitlab::ReplyByEmail do ...@@ -19,7 +19,7 @@ describe Gitlab::ReplyByEmail do
context "when the address is invalid" do context "when the address is invalid" do
before do before do
stub_reply_by_email_setting(address: "replies@example.com") stub_incoming_email_setting(address: "replies@example.com")
end end
it "returns false" do it "returns false" do
...@@ -30,7 +30,7 @@ describe Gitlab::ReplyByEmail do ...@@ -30,7 +30,7 @@ describe Gitlab::ReplyByEmail do
context "when reply by email is disabled" do context "when reply by email is disabled" do
before do before do
stub_reply_by_email_setting(enabled: false) stub_incoming_email_setting(enabled: false)
end end
it "returns false" do it "returns false" do
...@@ -39,34 +39,9 @@ describe Gitlab::ReplyByEmail do ...@@ -39,34 +39,9 @@ describe Gitlab::ReplyByEmail do
end end
end end
describe "self.reply_key" do
context "when enabled" do
before do
allow(described_class).to receive(:enabled?).and_return(true)
end
it "returns a random hex" do
key = described_class.reply_key
key2 = described_class.reply_key
expect(key).not_to eq(key2)
end
end
context "when disabled" do
before do
allow(described_class).to receive(:enabled?).and_return(false)
end
it "returns nil" do
expect(described_class.reply_key).to be_nil
end
end
end
context "self.reply_address" do context "self.reply_address" do
before do before do
stub_reply_by_email_setting(address: "replies+%{reply_key}@example.com") stub_incoming_email_setting(address: "replies+%{key}@example.com")
end end
it "returns the address with an interpolated reply key" do it "returns the address with an interpolated reply key" do
...@@ -74,13 +49,13 @@ describe Gitlab::ReplyByEmail do ...@@ -74,13 +49,13 @@ describe Gitlab::ReplyByEmail do
end end
end end
context "self.reply_key_from_address" do context "self.key_from_address" do
before do before do
stub_reply_by_email_setting(address: "replies+%{reply_key}@example.com") stub_incoming_email_setting(address: "replies+%{key}@example.com")
end end
it "returns reply key" do it "returns reply key" do
expect(described_class.reply_key_from_address("replies+key@example.com")).to eq("key") expect(described_class.key_from_address("replies+key@example.com")).to eq("key")
end end
end end
end end
...@@ -17,8 +17,8 @@ module StubConfiguration ...@@ -17,8 +17,8 @@ module StubConfiguration
allow(Gitlab.config.gravatar).to receive_messages(messages) allow(Gitlab.config.gravatar).to receive_messages(messages)
end end
def stub_reply_by_email_setting(messages) def stub_incoming_email_setting(messages)
allow(Gitlab.config.reply_by_email).to receive_messages(messages) allow(Gitlab.config.incoming_email).to receive_messages(messages)
end end
private private
......
...@@ -5,7 +5,7 @@ describe EmailReceiverWorker do ...@@ -5,7 +5,7 @@ describe EmailReceiverWorker do
context "when reply by email is enabled" do context "when reply by email is enabled" do
before do before do
allow(Gitlab::ReplyByEmail).to receive(:enabled?).and_return(true) allow(Gitlab::IncomingEmail).to receive(:enabled?).and_return(true)
end end
it "calls the email receiver" do it "calls the email receiver" do
...@@ -33,7 +33,7 @@ describe EmailReceiverWorker do ...@@ -33,7 +33,7 @@ describe EmailReceiverWorker do
context "when reply by email is disabled" do context "when reply by email is disabled" do
before do before do
allow(Gitlab::ReplyByEmail).to receive(:enabled?).and_return(false) allow(Gitlab::IncomingEmail).to receive(:enabled?).and_return(false)
end end
it "doesn't call the email receiver" do it "doesn't call the email receiver" do
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment