EmailConfiguration

Version 1 (Cyber Sprocket, 2009-05-18 22:11)

1 1 Cyber Sprocket
h1. Email Configuration
2 1 Cyber Sprocket
3 1 Cyber Sprocket
h2. Configuration Directives
4 1 Cyber Sprocket
5 1 Cyber Sprocket
This page is a work in progress, the following configuration directives is only a partial list.
6 1 Cyber Sprocket
7 1 Cyber Sprocket
h3. authentication
8 1 Cyber Sprocket
9 1 Cyber Sprocket
The type of authentication method expected by your service provider. 
10 1 Cyber Sprocket
11 1 Cyber Sprocket
Valid settings:
12 1 Cyber Sprocket
* :login
13 1 Cyber Sprocket
* :none
14 1 Cyber Sprocket
15 1 Cyber Sprocket
h3. delivery_method
16 1 Cyber Sprocket
17 1 Cyber Sprocket
The mail transport method to be used.
18 1 Cyber Sprocket
19 1 Cyber Sprocket
Valid settings:
20 1 Cyber Sprocket
* :smtp
21 1 Cyber Sprocket
22 1 Cyber Sprocket
23 1 Cyber Sprocket
h2. Example email.yml Configurations
24 1 Cyber Sprocket
25 1 Cyber Sprocket
h3. Simple Login Authentication (default settings)
26 1 Cyber Sprocket
27 1 Cyber Sprocket
<pre>
28 1 Cyber Sprocket
# Outgoing email settings
29 1 Cyber Sprocket
30 1 Cyber Sprocket
production:
31 1 Cyber Sprocket
  delivery_method: :smtp
32 1 Cyber Sprocket
  smtp_settings:
33 1 Cyber Sprocket
    address: smtp.example.net
34 1 Cyber Sprocket
    port: 25
35 1 Cyber Sprocket
    domain: example.net
36 1 Cyber Sprocket
    authentication: :login
37 1 Cyber Sprocket
    user_name: redmine@example.net
38 1 Cyber Sprocket
    password: redmine
39 1 Cyber Sprocket
  
40 1 Cyber Sprocket
development:
41 1 Cyber Sprocket
  delivery_method: :smtp
42 1 Cyber Sprocket
  smtp_settings:
43 1 Cyber Sprocket
    address: 127.0.0.1
44 1 Cyber Sprocket
    port: 25
45 1 Cyber Sprocket
    domain: example.net
46 1 Cyber Sprocket
    authentication: :login
47 1 Cyber Sprocket
    user_name: redmine@example.net
48 1 Cyber Sprocket
    password: redmine
49 1 Cyber Sprocket
</pre>
50 1 Cyber Sprocket
51 1 Cyber Sprocket
52 1 Cyber Sprocket
h3. No Authentication
53 1 Cyber Sprocket
54 1 Cyber Sprocket
Example for an SMTP service provider with no authentication.  Note the colon before none.
55 1 Cyber Sprocket
56 1 Cyber Sprocket
<pre>
57 1 Cyber Sprocket
production:
58 1 Cyber Sprocket
  delivery_method: :smtp
59 1 Cyber Sprocket
  smtp_settings:
60 1 Cyber Sprocket
    address: smtp.knology.net
61 1 Cyber Sprocket
    port: 25
62 1 Cyber Sprocket
    domain: cybersprocket.com
63 1 Cyber Sprocket
    authentication: :none
64 1 Cyber Sprocket
</pre>