Project

General

Profile

EmailConfiguration » History » Version 6

Eric Davis, 2009-10-09 19:23
Added notes about the :async options only working in trunk

1 1 Cyber Sprocket
h1. Email Configuration
2
3
h2. Configuration Directives
4
5
This page is a work in progress, the following configuration directives is only a partial list.
6
7
h3. authentication
8
9
The type of authentication method expected by your service provider. 
10
11
Valid settings:
12
* :login
13
* :none
14
15 4 Anthony Cartmell
(note: if you set this to @:none@, you must not include the @user_name@ and @password@ settings)
16
17 1 Cyber Sprocket
h3. delivery_method
18
19 6 Eric Davis
The mail transport method to be used.
20 1 Cyber Sprocket
21
Valid settings:
22
* :smtp
23 6 Eric Davis
* :async_smtp - valid in trunk/0.9 only
24 1 Cyber Sprocket
* :sendmail
25 6 Eric Davis
* :async_sendmail - valid in trunk/0.9 only
26 1 Cyber Sprocket
27 6 Eric Davis
h4. Asynchronous delivery_methods
28
29
The @:async_smtp@ and @:async_sendmail@ use asynchronous sends, which mean 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.
30 1 Cyber Sprocket
31
h2. Example email.yml Configurations
32
33
h3. Simple Login Authentication (default settings)
34
35
<pre>
36
# Outgoing email settings
37
38
production:
39
  delivery_method: :smtp
40
  smtp_settings:
41
    address: smtp.example.net
42
    port: 25
43
    domain: example.net
44
    authentication: :login
45
    user_name: redmine@example.net
46
    password: redmine
47
  
48
development:
49
  delivery_method: :smtp
50
  smtp_settings:
51
    address: 127.0.0.1
52
    port: 25
53
    domain: example.net
54
    authentication: :login
55
    user_name: redmine@example.net
56
    password: redmine
57
</pre>
58
59
60
h3. No Authentication
61
62
Example for an SMTP service provider with no authentication.  Note the colon before none.
63
64
<pre>
65
production:
66
  delivery_method: :smtp
67
  smtp_settings:
68
    address: smtp.knology.net
69
    port: 25
70
    domain: cybersprocket.com
71
    authentication: :none
72
</pre>
73 5 Eric Davis
74
h3. Using sendmail command
75
76
Example for a unix system that uses the @/usr/sbin/sendmail@ command.
77
78
<pre>
79
production:
80
  delivery_method: :sendmail
81
</pre>
82
83
h3. More information
84
85
* "Configuring Action Mailer":http://wiki.rubyonrails.org/howtos/mailers#configuring_action_mailer
86
* "Action Mailer Configuration":http://guides.rubyonrails.org/action_mailer_basics.html#action-mailer-configuration