EmailConfiguration » History » Version 32

Miodrag Milic, 2013-01-10 14:57

1 1 Cyber Sprocket
h1. Email Configuration
2 1 Cyber Sprocket
3 7 Mischa The Evil
{{>toc}}
4 7 Mischa The Evil
5 32 Miodrag Milic
ISSUE TEST START Defect #12799
6 31 Miodrag Milic
7 31 Miodrag Milic
h2.	Overview
8 31 Miodrag Milic
9 31 Miodrag Milic
h2.	Section 1
10 31 Miodrag Milic
11 32 Miodrag Milic
ISSUE TEST END Defect
12 31 Miodrag Milic
13 1 Cyber Sprocket
h2. Configuration Directives
14 1 Cyber Sprocket
15 10 Graham King
This page is a work in progress, the following configuration directives are only a partial list.
16 1 Cyber Sprocket
17 1 Cyber Sprocket
h3. authentication
18 1 Cyber Sprocket
19 1 Cyber Sprocket
The type of authentication method expected by your service provider. 
20 1 Cyber Sprocket
21 1 Cyber Sprocket
Valid settings:
22 1 Cyber Sprocket
* :login
23 1 Cyber Sprocket
* :none
24 1 Cyber Sprocket
25 4 Anthony Cartmell
(note: if you set this to @:none@, you must not include the @user_name@ and @password@ settings)
26 4 Anthony Cartmell
27 1 Cyber Sprocket
h3. delivery_method
28 1 Cyber Sprocket
29 6 Eric Davis
The mail transport method to be used.
30 1 Cyber Sprocket
31 1 Cyber Sprocket
Valid settings:
32 1 Cyber Sprocket
* :smtp
33 16 Mischa The Evil
* :async_smtp
34 1 Cyber Sprocket
* :sendmail
35 16 Mischa The Evil
* :async_sendmail
36 1 Cyber Sprocket
37 6 Eric Davis
h4. Asynchronous delivery_methods
38 6 Eric Davis
39 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) .
40 1 Cyber Sprocket
41 23 Miodrag Milic
With this delivery method, smtp configuration is specified using @async_smtp_settings@ keyword:
42 23 Miodrag Milic
43 23 Miodrag Milic
<pre>
44 23 Miodrag Milic
development:
45 23 Miodrag Milic
  email_delivery:
46 23 Miodrag Milic
    delivery_method: :async_smtp
47 23 Miodrag Milic
    async_smtp_settings:
48 23 Miodrag Milic
    ...
49 23 Miodrag Milic
</pre>
50 23 Miodrag Milic
51 11 Etienne Massip
h2. Example configuration.yml Configurations
52 1 Cyber Sprocket
53 1 Cyber Sprocket
h3. Simple Login Authentication (default settings)
54 1 Cyber Sprocket
55 1 Cyber Sprocket
<pre>
56 1 Cyber Sprocket
# Outgoing email settings
57 1 Cyber Sprocket
58 1 Cyber Sprocket
production:
59 12 Ross Wilson
  email_delivery:
60 12 Ross Wilson
    delivery_method: :smtp
61 12 Ross Wilson
    smtp_settings:
62 12 Ross Wilson
      address: smtp.example.net
63 12 Ross Wilson
      port: 25
64 12 Ross Wilson
      domain: example.net
65 12 Ross Wilson
      authentication: :login
66 12 Ross Wilson
      user_name: redmine@example.net
67 12 Ross Wilson
      password: redmine
68 1 Cyber Sprocket
  
69 1 Cyber Sprocket
development:
70 12 Ross Wilson
  email_delivery:
71 12 Ross Wilson
    delivery_method: :smtp
72 12 Ross Wilson
    smtp_settings:
73 12 Ross Wilson
      address: 127.0.0.1
74 12 Ross Wilson
      port: 25
75 12 Ross Wilson
      domain: example.net
76 12 Ross Wilson
      authentication: :login
77 12 Ross Wilson
      user_name: redmine@example.net
78 12 Ross Wilson
      password: redmine
79 1 Cyber Sprocket
</pre>
80 1 Cyber Sprocket
81 1 Cyber Sprocket
82 1 Cyber Sprocket
*If you want to use GMail/Google Apps and other TLS-requiring SMTP servers*, you'll have to add some TLS-related settings :
83 8 Joël Lamotte
84 8 Joël Lamotte
<pre>
85 8 Joël Lamotte
production:
86 12 Ross Wilson
  email_delivery:
87 12 Ross Wilson
    delivery_method: :smtp
88 12 Ross Wilson
    smtp_settings:
89 12 Ross Wilson
      enable_starttls_auto: true
90 12 Ross Wilson
      address: "smtp.gmail.com" 
91 12 Ross Wilson
      port: '587'
92 12 Ross Wilson
      domain: "smtp.gmail.com" 
93 12 Ross Wilson
      authentication: :plain
94 12 Ross Wilson
      user_name: "your_email@gmail.com" 
95 12 Ross Wilson
      password: "your_password" 
96 8 Joël Lamotte
97 8 Joël Lamotte
</pre>
98 8 Joël Lamotte
99 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).
100 8 Joël Lamotte
(See #5814 )
101 8 Joël Lamotte
102 1 Cyber Sprocket
h3. No Authentication
103 1 Cyber Sprocket
104 1 Cyber Sprocket
Example for an SMTP service provider with no authentication.  Note the colon before none.
105 1 Cyber Sprocket
106 1 Cyber Sprocket
<pre>
107 1 Cyber Sprocket
production:
108 13 Ross Wilson
  email_delivery:
109 13 Ross Wilson
    delivery_method: :smtp
110 13 Ross Wilson
    smtp_settings:
111 13 Ross Wilson
      address: smtp.knology.net
112 13 Ross Wilson
      port: 25
113 13 Ross Wilson
      domain: cybersprocket.com
114 13 Ross Wilson
      authentication: :none
115 1 Cyber Sprocket
</pre>
116 1 Cyber Sprocket
117 1 Cyber Sprocket
h3. Using sendmail command
118 5 Eric Davis
119 5 Eric Davis
Example for a unix system that uses the @/usr/sbin/sendmail@ command.
120 5 Eric Davis
121 5 Eric Davis
<pre>
122 5 Eric Davis
production:
123 13 Ross Wilson
  email_delivery:
124 13 Ross Wilson
    delivery_method: :sendmail
125 5 Eric Davis
</pre>
126 1 Cyber Sprocket
127 7 Mischa The Evil
h2. More information
128 5 Eric Davis
129 5 Eric Davis
* "Action Mailer Configuration":http://guides.rubyonrails.org/action_mailer_basics.html#action-mailer-configuration