EmailConfiguration » History » Version 43

Version 42 (hongbo yang, 2014-06-20 11:21) → Version 43/52 (hongbo yang, 2014-06-20 11:22)

h1. Email Configuration

{{>toc}}

h2. Configuration Directives

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
for detailed information.

h3. authentication

The type of authentication method expected by your service provider.

Valid settings:
* @nil@ (or omit the key) for no authentication
* @:plain@
* @:login@
* @:cram_md5@

(note: if you set this to @nil@ or omit it, you must not include the @user_name@ and @password@ settings)

h3. delivery_method

The mail transport method to be used.

Valid settings:
* @:smtp@
* :@sendmail@
* @:async_smtp@
* @:async_sendmail@

h4. Asynchronous delivery_methods

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) .

With this delivery method, smtp configuration is specified using @async_smtp_settings@ keyword:

<pre>
development:
email_delivery:
delivery_method: :async_smtp
async_smtp_settings:
...
</pre>

h2. Example configuration.yml Configurations

h3. Simple Login Authentication (default settings)

<pre>
# Outgoing email settings

production:
email_delivery:
delivery_method: :smtp
smtp_settings:
address: smtp.example.net
port: 25
domain: example.net
authentication: :login
user_name: redmine@example.net
password: redmine

development:
email_delivery:
delivery_method: :smtp
smtp_settings:
address: 127.0.0.1
port: 25
domain: example.net
authentication: :login
user_name: redmine@example.net
password: redmine
</pre>

*If you want to use GMail/Google Apps and other TLS-requiring SMTP servers*, you'll have to add some TLS-related settings :

<pre>
production:
email_delivery:
delivery_method: :smtp
smtp_settings:
enable_starttls_auto: true
address: "smtp.gmail.com"
port: '587'
domain: "smtp.gmail.com"
authentication: :plain
user_name: "your_email@gmail.com"
password: "your_password"

</pre>

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.

<pre>
production:
email_delivery:
delivery_method: :smtp
smtp_settings:
enable_starttls_auto: true
address: "smtp.office365.com"
port: '587'
domain: "your_domain.com"
authentication: :login
user_name: "email@your_domain.com"
password: "password"
</pre>

However, this will only work with "recent" enough ruby and rails versions (1.8.7 patchset 2xx and 2.3.5).
(See #5814 )

h3. No Authentication

Example for an SMTP service provider with no authentication.

<pre>
production:
email_delivery:
delivery_method: :smtp
smtp_settings:
address: smtp.knology.net
port: 25
domain: cybersprocket.com
</pre>

h3. Using sendmail command

Example for a unix system that uses the @/usr/sbin/sendmail@ command.

<pre>
production:
email_delivery:
delivery_method: :sendmail
</pre>

h2. Troubleshooting

h3. Error: "hostname was not match with the server certificate"

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:

enable_starttls_auto: false

h3. Error: "Mail failure - no recipient addresses"

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.

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.

The solution consists on editing your _config/configuration.yml_ and making sure you define @arguments@ containing the string @"-i"@, as shown below:

<pre>
# default configuration options for all environments
default:
email_delivery:
delivery_method: :sendmail
sendmail_settings:
arguments: "-i"
</pre>

The example above employs @:sendmail@ method, which employs @sendmail_settings@. In case you are using @:smtp@ or @:async_smtp@ methods, try @smtp_settings@ instead.

h3. Error: "Timeout:Error" &quot;Timeout:error&quot; due to SSL SMTP server connection


add an ssl option to the configuration.yml #17239


<pre>
default:
# Outgoing emails configuration (see examples above)
email_delivery:
delivery_method: :smtp
smtp_settings:
address: smtp.domain.com
port: 465
ssl: true
enable_starttls_auto: true
domain: domain.com
authentication: :login
user_name: redmine@domain.com
password: xxxx
</pre>

h2. More information

* "Action Mailer Configuration":http://guides.rubyonrails.org/action_mailer_basics.html#action-mailer-configuration