EmailConfiguration » History » Version 44

Holger Just, 2016-12-21 15:19
Add additional linkable header for example configurations

1 1 Cyber Sprocket
h1. Email Configuration
2 1 Cyber Sprocket
3 7 Mischa The Evil
{{>toc}}
4 7 Mischa The Evil
5 31 Miodrag Milic
6 1 Cyber Sprocket
h2. Configuration Directives
7 1 Cyber Sprocket
8 34 Anonymous
This page is a work in progress, the following configuration directives are only a partial list. Please consult "Action Mailer Configuration":http://guides.rubyonrails.org/action_mailer_basics.html#action-mailer-configuration
9 34 Anonymous
for detailed information.
10 1 Cyber Sprocket
11 1 Cyber Sprocket
h3. authentication
12 1 Cyber Sprocket
13 1 Cyber Sprocket
The type of authentication method expected by your service provider. 
14 1 Cyber Sprocket
15 1 Cyber Sprocket
Valid settings:
16 34 Anonymous
* @nil@ (or omit the key) for no authentication
17 34 Anonymous
* @:plain@
18 34 Anonymous
* @:login@
19 34 Anonymous
* @:cram_md5@
20 1 Cyber Sprocket
21 34 Anonymous
(note: if you set this to @nil@ or omit it, you must not include the @user_name@ and @password@ settings)
22 1 Cyber Sprocket
23 1 Cyber Sprocket
h3. delivery_method
24 1 Cyber Sprocket
25 6 Eric Davis
The mail transport method to be used.
26 1 Cyber Sprocket
27 1 Cyber Sprocket
Valid settings:
28 34 Anonymous
* @:smtp@
29 34 Anonymous
* :@sendmail@
30 34 Anonymous
* @:async_smtp@
31 34 Anonymous
* @:async_sendmail@
32 1 Cyber Sprocket
33 6 Eric Davis
h4. Asynchronous delivery_methods
34 6 Eric Davis
35 30 Miodrag Milic
The @:async_smtp@ and @:async_sendmail@ use asynchronous sends, which means Redmine does not wait for the email to be sent to display the next page.  See "Asynchronous Email Delivery":http://redmineblog.com/articles/asynchronous-email-delivery/ for more details. Some SMTP servers have delay period before processing takes place as anti-spam feature, during which time synchronous method will block Redmine ("10 seconds":http://answers.bitnami.org/questions/4421/updating-an-issue-in-redmine-takes-10-seconds could be default value, see also #11376 for more information) .
36 1 Cyber Sprocket
37 23 Miodrag Milic
With this delivery method, smtp configuration is specified using @async_smtp_settings@ keyword:
38 23 Miodrag Milic
39 23 Miodrag Milic
<pre>
40 23 Miodrag Milic
development:
41 23 Miodrag Milic
  email_delivery:
42 23 Miodrag Milic
    delivery_method: :async_smtp
43 23 Miodrag Milic
    async_smtp_settings:
44 23 Miodrag Milic
    ...
45 23 Miodrag Milic
</pre>
46 23 Miodrag Milic
47 11 Etienne Massip
h2. Example configuration.yml Configurations
48 1 Cyber Sprocket
49 1 Cyber Sprocket
h3. Simple Login Authentication (default settings)
50 1 Cyber Sprocket
51 1 Cyber Sprocket
<pre>
52 1 Cyber Sprocket
# Outgoing email settings
53 1 Cyber Sprocket
54 1 Cyber Sprocket
production:
55 12 Ross Wilson
  email_delivery:
56 12 Ross Wilson
    delivery_method: :smtp
57 12 Ross Wilson
    smtp_settings:
58 12 Ross Wilson
      address: smtp.example.net
59 12 Ross Wilson
      port: 25
60 12 Ross Wilson
      domain: example.net
61 12 Ross Wilson
      authentication: :login
62 12 Ross Wilson
      user_name: redmine@example.net
63 12 Ross Wilson
      password: redmine
64 1 Cyber Sprocket
  
65 1 Cyber Sprocket
development:
66 12 Ross Wilson
  email_delivery:
67 12 Ross Wilson
    delivery_method: :smtp
68 12 Ross Wilson
    smtp_settings:
69 12 Ross Wilson
      address: 127.0.0.1
70 12 Ross Wilson
      port: 25
71 12 Ross Wilson
      domain: example.net
72 12 Ross Wilson
      authentication: :login
73 12 Ross Wilson
      user_name: redmine@example.net
74 12 Ross Wilson
      password: redmine
75 1 Cyber Sprocket
</pre>
76 1 Cyber Sprocket
77 44 Holger Just
h3. GMail, Google Apps
78 1 Cyber Sprocket
79 44 Holger Just
If you want to use GMail/Google Apps and other TLS-requiring SMTP servers, you'll have to add some TLS-related settings:
80 8 Joël Lamotte
81 8 Joël Lamotte
<pre>
82 8 Joël Lamotte
production:
83 12 Ross Wilson
  email_delivery:
84 12 Ross Wilson
    delivery_method: :smtp
85 12 Ross Wilson
    smtp_settings:
86 12 Ross Wilson
      enable_starttls_auto: true
87 12 Ross Wilson
      address: "smtp.gmail.com" 
88 12 Ross Wilson
      port: '587'
89 12 Ross Wilson
      domain: "smtp.gmail.com" 
90 12 Ross Wilson
      authentication: :plain
91 1 Cyber Sprocket
      user_name: "your_email@gmail.com" 
92 1 Cyber Sprocket
      password: "your_password" 
93 1 Cyber Sprocket
</pre>
94 44 Holger Just
95 44 Holger Just
h3. Office 365, Exchange Online
96 8 Joël Lamotte
97 41 Pierre Maigne
Here is an example for Office 365 users (Exchange online). The sender must have an account, or if you want to send from a shared mailbox, the account below must have authorization to "Send As" the sender which is defined in Redmine email notifications settings.
98 41 Pierre Maigne
99 41 Pierre Maigne
<pre>
100 41 Pierre Maigne
production:
101 41 Pierre Maigne
  email_delivery:
102 41 Pierre Maigne
    delivery_method: :smtp
103 41 Pierre Maigne
    smtp_settings:
104 41 Pierre Maigne
      enable_starttls_auto: true
105 41 Pierre Maigne
      address: "smtp.office365.com"
106 41 Pierre Maigne
      port: '587'
107 41 Pierre Maigne
      domain: "your_domain.com"
108 41 Pierre Maigne
      authentication: :login
109 41 Pierre Maigne
      user_name: "email@your_domain.com"
110 41 Pierre Maigne
      password: "password"
111 41 Pierre Maigne
</pre>
112 41 Pierre Maigne
113 8 Joël Lamotte
However, this will only work with "recent" enough ruby and rails versions (1.8.7 patchset 2xx and 2.3.5).
114 8 Joël Lamotte
(See #5814 )
115 8 Joël Lamotte
116 1 Cyber Sprocket
h3. No Authentication
117 1 Cyber Sprocket
118 34 Anonymous
Example for an SMTP service provider with no authentication.
119 1 Cyber Sprocket
120 1 Cyber Sprocket
<pre>
121 13 Ross Wilson
production:
122 13 Ross Wilson
  email_delivery:
123 13 Ross Wilson
    delivery_method: :smtp
124 13 Ross Wilson
    smtp_settings:
125 13 Ross Wilson
      address: smtp.knology.net
126 13 Ross Wilson
      port: 25
127 13 Ross Wilson
      domain: cybersprocket.com
128 1 Cyber Sprocket
</pre>
129 1 Cyber Sprocket
130 1 Cyber Sprocket
h3. Using sendmail command
131 5 Eric Davis
132 5 Eric Davis
Example for a unix system that uses the @/usr/sbin/sendmail@ command.
133 5 Eric Davis
134 5 Eric Davis
<pre>
135 5 Eric Davis
production:
136 13 Ross Wilson
  email_delivery:
137 13 Ross Wilson
    delivery_method: :sendmail
138 5 Eric Davis
</pre>
139 1 Cyber Sprocket
140 35 Jean-Baptiste Barth
h2. Troubleshooting
141 35 Jean-Baptiste Barth
142 35 Jean-Baptiste Barth
h3. Error: "hostname was not match with the server certificate"
143 35 Jean-Baptiste Barth
144 35 Jean-Baptiste Barth
If you get this error, there's probably a problem verifying the SSL certificate of your smtp relay. As a temporary fix, you can set this option in the appropriate "email_delivery" section:
145 35 Jean-Baptiste Barth
146 35 Jean-Baptiste Barth
    enable_starttls_auto: false
147 35 Jean-Baptiste Barth
148 36 Richard Gomes
h3. Error: "Mail failure - no recipient addresses"
149 36 Richard Gomes
150 36 Richard Gomes
When this error happens, the notification is not delivered to the destination address. Instead, you will probably receive a rejection message on your sender address, where you can see the header of the message sent, containing "From:" fields but not containing any "To:" fields.
151 36 Richard Gomes
152 39 Richard Gomes
This error is common on *Debian* boxes, due to the way _exim4_ is configured by default, which is @"-i -t"@. This configuration tells _exim4_ that the destination address is inside the header of the message. Instead, we need to configure _exim4_ so that the destination address will be retrieved from the command line.
153 36 Richard Gomes
154 37 Richard Gomes
The solution consists on editing your _config/configuration.yml_ and making sure you define @arguments@ containing the string @"-i"@, as shown below:
155 36 Richard Gomes
156 36 Richard Gomes
<pre>
157 36 Richard Gomes
# default configuration options for all environments
158 36 Richard Gomes
default:
159 36 Richard Gomes
  email_delivery:    
160 36 Richard Gomes
    delivery_method: :sendmail
161 36 Richard Gomes
    sendmail_settings:
162 36 Richard Gomes
      arguments: "-i" 
163 36 Richard Gomes
</pre>
164 36 Richard Gomes
165 40 Richard Gomes
The example above employs @:sendmail@ method, which employs @sendmail_settings@. In case you are using @:smtp@ or @:async_smtp@ methods, try @smtp_settings@ instead.
166 38 Richard Gomes
167 43 hongbo yang
h3. Error: "Timeout:Error" due to SSL SMTP server connection
168 43 hongbo yang
169 1 Cyber Sprocket
add an ssl option to the configuration.yml #17239
170 43 hongbo yang
171 42 hongbo yang
<pre>
172 42 hongbo yang
default:
173 42 hongbo yang
  # Outgoing emails configuration (see examples above)
174 42 hongbo yang
  email_delivery:
175 42 hongbo yang
    delivery_method: :smtp
176 42 hongbo yang
  smtp_settings:
177 42 hongbo yang
    address: smtp.domain.com
178 42 hongbo yang
    port: 465
179 42 hongbo yang
    ssl: true
180 42 hongbo yang
    enable_starttls_auto: true
181 42 hongbo yang
    domain: domain.com
182 42 hongbo yang
    authentication: :login
183 42 hongbo yang
    user_name: redmine@domain.com
184 42 hongbo yang
    password: xxxx
185 42 hongbo yang
</pre>
186 42 hongbo yang
187 7 Mischa The Evil
h2. More information
188 5 Eric Davis
189 5 Eric Davis
* "Action Mailer Configuration":http://guides.rubyonrails.org/action_mailer_basics.html#action-mailer-configuration