Redmine

h1. Email Configuration

{{>toc}}

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 wait period for response (10 seconds could be default value) during which time synchronous method will block Redmine. 

*NB* : if you want to use asynchronous sends, be careful there's a regression in Redmine 2.x which implies a modification of the "smtp_settings" key in your @config/configuration.yml@. See #11376 for more informations.

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