EmailConfiguration » History » Version 32

Version 31 (Miodrag Milic, 2013-01-10 14:56) → Version 32/55 (Miodrag Milic, 2013-01-10 14:57)

h1. Email Configuration

{{>toc}}

ISSUE TEST START Defect #12799 --- test

h2. Overview

h2. Section 1

ISSUE TEST END Defect --- test

h2. Configuration Directives

This page is a work in progress, the following configuration directives are only a partial list.

h3. authentication

The type of authentication method expected by your service provider.

Valid settings:
* :login
* :none

(note: if you set this to @:none@, you must not include the @user_name@ and @password@ settings)

h3. delivery_method

The mail transport method to be used.

Valid settings:
* :smtp
* :async_smtp
* :sendmail
* :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>

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. Note the colon before none.

<pre>
production:
email_delivery:
delivery_method: :smtp
smtp_settings:
address: smtp.knology.net
port: 25
domain: cybersprocket.com
authentication: :none
</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. More information

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