EmailConfiguration » History » Version 23

« Previous - Version 23/55 (diff) - Next » - Current version
Miodrag Milic, 2012-12-25 07:21


Email Configuration

Configuration Directives

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

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)

delivery_method

The mail transport method to be used.

Valid settings:
  • :smtp
  • :async_smtp
  • :sendmail
  • :async_sendmail

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 for more details.

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:

development:
  email_delivery:
    delivery_method: :async_smtp
    async_smtp_settings:
    ...

Example configuration.yml Configurations

Simple Login Authentication (default settings)

# 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

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

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" 

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

No Authentication

Example for an SMTP service provider with no authentication. Note the colon before none.

production:
  email_delivery:
    delivery_method: :smtp
    smtp_settings:
      address: smtp.knology.net
      port: 25
      domain: cybersprocket.com
      authentication: :none

Using sendmail command

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

production:
  email_delivery:
    delivery_method: :sendmail

More information