Project

General

Profile

RedmineReceivingEmails » History » Version 12

Eric Davis, 2008-08-20 08:28
Added Status keyword

1 1 Jean-Philippe Lang
h1. Receiving emails
2
3 4 Jean-Philippe Lang
{{>toc}}
4
5 2 Jean-Philippe Lang
As of r1572, Redmine can be configured to allow issue creation or comments via email.
6 1 Jean-Philippe Lang
7
h2. Setup
8
9 7 Jean-Philippe Lang
You can configure Redmine to receive emails in one of the following ways:
10
11
* Forwarding emails from your email server:
12
13
  * Pros: works with a remote mail server, email are processed instantly, fast (no environment reloading)
14 10 Jean-Philippe Lang
  * Cons: needs some configuration on your mail transfer agent (eg. Postfix, Sendmail...)
15 7 Jean-Philippe Lang
16
* Fetching emails from an IMAP server:
17
18
  * Pros: easy to setup, no need to configure your MTA, works with a remote mail server
19 9 Jean-Philippe Lang
  * Cons: emails are not processed instantly (a cron job needs to be added to read emails periodically)
20 7 Jean-Philippe Lang
21
* Reading emails from standard input:
22
23
  * Pros: fine for testing purpose
24
  * Cons: slow (the environment is reloaded each time an email is read), needs some configuration on your MTA
25 4 Jean-Philippe Lang
26
h3. Forwarding emails from your email server
27
28
A standalone script can be used to forward incoming emails from your mail server.
29
This script reads a raw email from the standard input and forward it to Redmine via a HTTP request.
30
It can be found in your redmine directory: @extra/mail_handler/rdm-mailhandler.rb@.
31
32
In order to use it, you have to enable the API that receive emails:
33
Go to _Application settings_ -> _Incoming emails_, check *Enable WS for incoming emails* and enter or generate a secret key.
34
35
Copy @rdm-mailhandler.rb@ to your mail server and configure your MTA.
36
37 5 Jean-Philippe Lang
Usage:
38 4 Jean-Philippe Lang
39 1 Jean-Philippe Lang
<pre>
40 5 Jean-Philippe Lang
rdm-mailhandler [options] --url=<Redmine URL> --key=<API key>
41 1 Jean-Philippe Lang
42 5 Jean-Philippe Lang
Required:
43
  -u, --url                      URL of the Redmine server
44
  -k, --key                      Redmine API key
45
  
46
General options:
47
  -h, --help                     show this help
48
  -v, --verbose                  show extra information
49
  -V, --version                  show version information and exit
50 1 Jean-Philippe Lang
51 5 Jean-Philippe Lang
Issue attributes control options:
52
  -p, --project=PROJECT          identifier of the target project
53
  -t, --tracker=TRACKER          name of the target tracker
54
      --category=CATEGORY        name of the target category
55
      --priority=PRIORITY        name of the target priority
56
  -o, --allow-override=ATTRS     allow email content to override attributes
57
                                 specified by previous options
58
                                 ATTRS is a comma separated list of attributes
59 6 Jean-Philippe Lang
</pre>
60
61 1 Jean-Philippe Lang
Examples:
62 6 Jean-Philippe Lang
63
<pre>
64 5 Jean-Philippe Lang
  # No project specified. Emails MUST contain the 'Project' keyword:
65
  rdm-mailhandler --url http://redmine.domain.foo --key secret
66
  
67
  # Fixed project and default tracker specified, but emails can override
68
  # both tracker and priority attributes:
69
  rdm-mailhandler --url https://domain.foo/redmine --key secret \\
70
                  --project foo \\
71
                  --tracker bug \\
72
                  --allow-override tracker,priority
73
</pre>
74
75
Here is an example for a Postfix alias:
76
77
<pre>
78
foo: "|/path/to/rdm-mailhandler.rb --url http://redmine.domain --key secret --project foo"
79
</pre> 
80 1 Jean-Philippe Lang
81
h3. Fetching emails from an IMAP server
82
83
A rake task (@redmine:email:receive_imap@) can be used to fetch incoming emails from an IMAP server.
84
85 6 Jean-Philippe Lang
<pre>
86
Available IMAP options:
87
  host=HOST                IMAP server host (default: 127.0.0.1)
88
  port=PORT                IMAP server port (default: 143)
89
  ssl=SSL                  Use SSL? (default: false)
90
  username=USERNAME        IMAP account
91
  password=PASSWORD        IMAP password
92
  folder=FOLDER            IMAP folder to read (default: INBOX)
93 1 Jean-Philippe Lang
94 6 Jean-Philippe Lang
Issue attributes control options:
95
  project=PROJECT          identifier of the target project
96
  tracker=TRACKER          name of the target tracker
97
  category=CATEGORY        name of the target category
98
  priority=PRIORITY        name of the target priority
99
  allow_override=ATTRS     allow email content to override attributes
100
                           specified by previous options
101
                           ATTRS is a comma separated list of attributes
102
  
103
</pre>
104 1 Jean-Philippe Lang
105 6 Jean-Philippe Lang
Examples:
106 1 Jean-Philippe Lang
107 6 Jean-Philippe Lang
<pre>
108
  # No project specified. Emails MUST contain the 'Project' keyword:
109
  
110 11 Thomas Lecavelier
  rake redmine:email:receive_imap RAILS_ENV="production" \\
111 6 Jean-Philippe Lang
    host=imap.foo.bar username=redmine@somenet.foo password=xxx
112 1 Jean-Philippe Lang
113
114 6 Jean-Philippe Lang
  # Fixed project and default tracker specified, but emails can override
115
  # both tracker and priority attributes:
116
  
117 11 Thomas Lecavelier
  rake redmine:email:receive_imap RAILS_ENV="production" \\
118 6 Jean-Philippe Lang
    host=imap.foo.bar username=redmine@somenet.foo password=xxx ssl=1 \\
119
    project=foo \\
120
    tracker=bug \\
121
    allow_override=tracker,priority
122 1 Jean-Philippe Lang
</pre>
123
124 6 Jean-Philippe Lang
125 1 Jean-Philippe Lang
Emails that are ignored (unknown user, unknown project...) are marked as 'Seen' but are not deleted from the IMAP server.
126
127
h3. Reading emails from standard input
128
129
A rake task (@redmine:email:receive@) can be used to read a single raw email from the standard input.
130
131 6 Jean-Philippe Lang
<pre>
132
Issue attributes control options:
133
  project=PROJECT          identifier of the target project
134
  tracker=TRACKER          name of the target tracker
135
  category=CATEGORY        name of the target category
136
  priority=PRIORITY        name of the target priority
137
  allow_override=ATTRS     allow email content to override attributes
138
                           specified by previous options
139
                           ATTRS is a comma separated list of attributes
140
</pre>
141 1 Jean-Philippe Lang
142 6 Jean-Philippe Lang
Examples:
143 1 Jean-Philippe Lang
144 6 Jean-Philippe Lang
<pre>
145
  # No project specified. Emails MUST contain the 'Project' keyword:
146
  rake redmine:email:read RAILS_ENV="production" < raw_email
147 1 Jean-Philippe Lang
148 6 Jean-Philippe Lang
  # Fixed project and default tracker specified, but emails can override
149
  # both tracker and priority attributes:
150
  rake redmine:email:read RAILS_ENV="production" \\
151
                  project=foo \\
152
                  tracker=bug \\
153
                  allow_override=tracker,priority < raw_email
154
</pre>
155 1 Jean-Philippe Lang
156
157
h2. How it works
158
159 12 Eric Davis
When receiving an email, Redmine uses the From address of the email to find the corresponding user. Emails received from unknown or locked users are ignored.
160 1 Jean-Philippe Lang
161
If the email subject contains something like "Re: *[xxxxxxx !#123]*", the email is processed as a reply and a note is added to issue !#123. Otherwise, a new issue is created.
162 3 Jean-Philippe Lang
163 1 Jean-Philippe Lang
If you don't use the @project@ option when reading emails, users have to specify in the email body which project the issue should be added to. This can be done by inserting a line in the email body like this: @"Project: foo"@.
164
165
Example (email body):
166
167
<pre>
168
This is a new ticket that will be added to project foo.
169
Here we have the ticket description
170
[...]
171
172
Project: foo
173
</pre>
174
175
Of course, user permissions are checked and this email would be ignored if the user who sent this email is not allowed to add issues to project foo.
176 8 Jean-Philippe Lang
177
Based on the options you use when receiving emails (see @allow-override@ option), users may be able to override some attributes when submitting an issue.
178 12 Eric Davis
This can be done by using the following keywords in the email body (just like @Project@): @Tracker@, @Category@, @Priority@, @Status@.
179 8 Jean-Philippe Lang
180
Example:
181
182
<pre>
183
This is a new ticket that overrides a few attributes
184
[...]
185
186
Project: foo
187 1 Jean-Philippe Lang
Tracker: Bug
188 8 Jean-Philippe Lang
Priority: Urgent
189 12 Eric Davis
Status: Resolved
190 8 Jean-Philippe Lang
</pre>