RedmineReceivingEmails » History » Version 36

Justin Clarke, 2010-08-04 06:58
Fixed some formatting.

1 1 Jean-Philippe Lang
h1. Receiving emails
2 1 Jean-Philippe Lang
3 4 Jean-Philippe Lang
{{>toc}}
4 4 Jean-Philippe Lang
5 17 Jean-Philippe Lang
As of 0.8.0, Redmine can be configured to allow issue creation or comments via email.
6 1 Jean-Philippe Lang
7 1 Jean-Philippe Lang
h2. Setup
8 1 Jean-Philippe Lang
9 7 Jean-Philippe Lang
You can configure Redmine to receive emails in one of the following ways:
10 7 Jean-Philippe Lang
11 7 Jean-Philippe Lang
* Forwarding emails from your email server:
12 7 Jean-Philippe Lang
13 7 Jean-Philippe Lang
  * 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 29 Jean-Philippe Lang
* Fetching emails from an IMAP or POP3 server:
17 7 Jean-Philippe Lang
18 7 Jean-Philippe Lang
  * 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 7 Jean-Philippe Lang
* Reading emails from standard input:
22 7 Jean-Philippe Lang
23 7 Jean-Philippe Lang
  * Pros: fine for testing purpose
24 7 Jean-Philippe Lang
  * Cons: slow (the environment is reloaded each time an email is read), needs some configuration on your MTA
25 4 Jean-Philippe Lang
26 4 Jean-Philippe Lang
h3. Forwarding emails from your email server
27 4 Jean-Philippe Lang
28 4 Jean-Philippe Lang
A standalone script can be used to forward incoming emails from your mail server.
29 4 Jean-Philippe Lang
This script reads a raw email from the standard input and forward it to Redmine via a HTTP request.
30 4 Jean-Philippe Lang
It can be found in your redmine directory: @extra/mail_handler/rdm-mailhandler.rb@.
31 4 Jean-Philippe Lang
32 4 Jean-Philippe Lang
In order to use it, you have to enable the API that receive emails:
33 4 Jean-Philippe Lang
Go to _Application settings_ -> _Incoming emails_, check *Enable WS for incoming emails* and enter or generate a secret key.
34 4 Jean-Philippe Lang
35 26 Ian Smith-Heisters
Copy @rdm-mailhandler.rb@ to your mail server, make sure its permissions allow execution, and configure your MTA.
36 4 Jean-Philippe Lang
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 5 Jean-Philippe Lang
  -u, --url                      URL of the Redmine server
44 5 Jean-Philippe Lang
  -k, --key                      Redmine API key
45 5 Jean-Philippe Lang
  
46 5 Jean-Philippe Lang
General options:
47 5 Jean-Philippe Lang
  -h, --help                     show this help
48 5 Jean-Philippe Lang
  -v, --verbose                  show extra information
49 5 Jean-Philippe Lang
  -V, --version                  show version information and exit
50 1 Jean-Philippe Lang
51 5 Jean-Philippe Lang
Issue attributes control options:
52 5 Jean-Philippe Lang
  -p, --project=PROJECT          identifier of the target project
53 5 Jean-Philippe Lang
  -t, --tracker=TRACKER          name of the target tracker
54 5 Jean-Philippe Lang
      --category=CATEGORY        name of the target category
55 5 Jean-Philippe Lang
      --priority=PRIORITY        name of the target priority
56 5 Jean-Philippe Lang
  -o, --allow-override=ATTRS     allow email content to override attributes
57 5 Jean-Philippe Lang
                                 specified by previous options
58 5 Jean-Philippe Lang
                                 ATTRS is a comma separated list of attributes
59 6 Jean-Philippe Lang
</pre>
60 6 Jean-Philippe Lang
61 1 Jean-Philippe Lang
Examples:
62 6 Jean-Philippe Lang
63 6 Jean-Philippe Lang
<pre>
64 5 Jean-Philippe Lang
  # No project specified. Emails MUST contain the 'Project' keyword:
65 5 Jean-Philippe Lang
  rdm-mailhandler --url http://redmine.domain.foo --key secret
66 5 Jean-Philippe Lang
  
67 5 Jean-Philippe Lang
  # Fixed project and default tracker specified, but emails can override
68 5 Jean-Philippe Lang
  # both tracker and priority attributes:
69 5 Jean-Philippe Lang
  rdm-mailhandler --url https://domain.foo/redmine --key secret \\
70 5 Jean-Philippe Lang
                  --project foo \\
71 5 Jean-Philippe Lang
                  --tracker bug \\
72 5 Jean-Philippe Lang
                  --allow-override tracker,priority
73 5 Jean-Philippe Lang
</pre>
74 5 Jean-Philippe Lang
75 35 Justin Clarke
Here is an example for a Postfix local alias (which is usually specified in @/etc/aliases@):
76 5 Jean-Philippe Lang
77 5 Jean-Philippe Lang
<pre>
78 1 Jean-Philippe Lang
foo: "|/path/to/rdm-mailhandler.rb --url http://redmine.domain --key secret --project foo"
79 35 Justin Clarke
</pre>
80 35 Justin Clarke
81 35 Justin Clarke
If your domain is setup as a virtual mailbox map (so that you use /etc/postfix/virtual_mailbox_maps to do mappings in the form @ user@example.com /path/example.com/user@) you should:
82 35 Justin Clarke
83 36 Justin Clarke
* create a mapping in @/etc/virtual@ like: @ foo@example.org foo@
84 35 Justin Clarke
* modify @/etc/postfix/main.cf@ to specify a transport file: @transport_maps = hash:/etc/postfix/transport@
85 36 Justin Clarke
* within the transport file add a line like: @ foo@example.org local:@
86 35 Justin Clarke
87 35 Justin Clarke
*Explanation:* - When you define virtual_mailbox_maps for a domain the default transport is virtual, which means specifying a local alias in @/etc/postfix/virtual@ will fail (with "unknown user"). To fix this, we override the default transport by specifying a local transport for the email address in question, which means the local alias will resolve correctly, and your script will be executed.
88 1 Jean-Philippe Lang
89 34 Thomas Guyot-Sionnest
A front-end to rdm-mailhandler.rb has been written to allow specifying projects trough sub-addresses (name+project@example.com). See [[MailhandlerSubAddress]]
90 34 Thomas Guyot-Sionnest
91 1 Jean-Philippe Lang
h3. Fetching emails from an IMAP server
92 1 Jean-Philippe Lang
93 20 Kurt Miebach
A rake task (@redmine:email:receive_imap@) can be used to fetch incoming emails from an IMAP server. When you run the rake command from a cron job you can include the switch @-f /path/to/redmine/appdir/Rakefile@ on the rake command, because otherwise the rakefile is not found. This is an example line for a cron file that fetches mails every 30 minutes:
94 1 Jean-Philippe Lang
95 21 Kurt Miebach
<code>
96 21 Kurt Miebach
*/30 * * * * redmineuser rake -f /path/to/redmine/appdir/Rakefile redmine:email:receive_imap RAILS_ENV="production" host=imap.foo.bar username=redmine@somenet.foo password=xxx 
97 21 Kurt Miebach
</code>
98 20 Kurt Miebach
99 33 Jürgen Hörmann
If your setup is working, but you receive mails from the cron daemon, you can suppress the output from the rake command by adding the --silent switch. That should stop cron sending mails on every execution of the command.
100 33 Jürgen Hörmann
101 33 Jürgen Hörmann
<code>
102 33 Jürgen Hörmann
*/30 * * * * redmineuser rake -f /path/to/redmine/appdir/Rakefile --silent redmine:email:receive_imap RAILS_ENV="production" host=imap.foo.bar username=redmine@somenet.foo password=xxx 
103 33 Jürgen Hörmann
</code>
104 33 Jürgen Hörmann
105 22 Kurt Miebach
The command has to go on a single line in your cronfile. Also see the other examples below, which only show the rake commands without the @-f@ option and without the cron part. 
106 20 Kurt Miebach
107 25 Roland ...
For Windows as server "pycron":http://www.kalab.com/freeware/pycron/pycron.htm can be used to schedule a fetch task.
108 20 Kurt Miebach
109 6 Jean-Philippe Lang
It can be necessary that you open the firewall on the machine for outgoing TCP connections to IMAP port 143.
110 1 Jean-Philippe Lang
111 6 Jean-Philippe Lang
Available IMAP options:
112 20 Kurt Miebach
<pre>
113 6 Jean-Philippe Lang
  host=HOST                IMAP server host (default: 127.0.0.1)
114 6 Jean-Philippe Lang
  port=PORT                IMAP server port (default: 143)
115 6 Jean-Philippe Lang
  ssl=SSL                  Use SSL? (default: false)
116 1 Jean-Philippe Lang
  username=USERNAME        IMAP account
117 6 Jean-Philippe Lang
  password=PASSWORD        IMAP password
118 1 Jean-Philippe Lang
  folder=FOLDER            IMAP folder to read (default: INBOX)
119 29 Jean-Philippe Lang
  move_on_success=MAILBOX  move emails that were successfully received
120 29 Jean-Philippe Lang
                           to MAILBOX instead of deleting them
121 29 Jean-Philippe Lang
  move_on_failure=MAILBOX  move emails that were ignored to MAILBOX
122 1 Jean-Philippe Lang
</pre>
123 29 Jean-Philippe Lang
124 1 Jean-Philippe Lang
Issue attributes control options:
125 20 Kurt Miebach
<pre>
126 6 Jean-Philippe Lang
  project=PROJECT          identifier of the target project
127 6 Jean-Philippe Lang
  tracker=TRACKER          name of the target tracker
128 6 Jean-Philippe Lang
  category=CATEGORY        name of the target category
129 6 Jean-Philippe Lang
  priority=PRIORITY        name of the target priority
130 18 Eric Davis
  allow_override=ATTRS     allow email content to override attributes
131 1 Jean-Philippe Lang
                           specified by previous options
132 18 Eric Davis
                           ATTRS is a comma separated list of attributes
133 18 Eric Davis
</pre>
134 18 Eric Davis
135 20 Kurt Miebach
Examples for the rake command:
136 1 Jean-Philippe Lang
137 6 Jean-Philippe Lang
<pre>
138 6 Jean-Philippe Lang
  # No project specified. Emails MUST contain the 'Project' keyword:
139 6 Jean-Philippe Lang
  
140 11 Thomas Lecavelier
  rake redmine:email:receive_imap RAILS_ENV="production" \\
141 6 Jean-Philippe Lang
    host=imap.foo.bar username=redmine@somenet.foo password=xxx
142 1 Jean-Philippe Lang
143 1 Jean-Philippe Lang
144 6 Jean-Philippe Lang
  # Fixed project and default tracker specified, but emails can override
145 6 Jean-Philippe Lang
  # both tracker and priority attributes:
146 6 Jean-Philippe Lang
  
147 11 Thomas Lecavelier
  rake redmine:email:receive_imap RAILS_ENV="production" \\
148 6 Jean-Philippe Lang
    host=imap.foo.bar username=redmine@somenet.foo password=xxx ssl=1 \\
149 6 Jean-Philippe Lang
    project=foo \\
150 6 Jean-Philippe Lang
    tracker=bug \\
151 6 Jean-Philippe Lang
    allow_override=tracker,priority
152 18 Eric Davis
153 18 Eric Davis
  # Move successful emails to the 'read' mailbox and failed emails to
154 18 Eric Davis
  # the 'failed' mailbox
155 18 Eric Davis
  
156 1 Jean-Philippe Lang
  rake redmine:email:receive_imap RAILS_ENV="production" \\
157 1 Jean-Philippe Lang
    host=imap.foo.bar username=redmine@somenet.foo password=xxx \\
158 1 Jean-Philippe Lang
    move_on_success=read move_on_failure=failed
159 1 Jean-Philippe Lang
160 1 Jean-Philippe Lang
</pre>
161 1 Jean-Philippe Lang
162 1 Jean-Philippe Lang
163 31 Paul Gresham
Ignored emails are marked as 'Seen' but are not deleted from the IMAP server--these include unknown user, unknown project and emails from the redmine emmission account.
164 1 Jean-Philippe Lang
165 1 Jean-Philippe Lang
The option _allow_override_ is not only for overriding default values given to rake, but for every attribute in a mail. If you want to override the tracker in your mail you have to add _allow_override=tracker_ as parameter.
166 29 Jean-Philippe Lang
167 29 Jean-Philippe Lang
h3. Fetching emails from a POP3 server
168 29 Jean-Philippe Lang
169 29 Jean-Philippe Lang
_Only available in trunk and future 1.0._
170 29 Jean-Philippe Lang
171 29 Jean-Philippe Lang
A rake task (@redmine:email:receive_pop3@) can be used to fetch incoming emails from a POP3 server.
172 29 Jean-Philippe Lang
173 29 Jean-Philippe Lang
Available POP3 options:
174 29 Jean-Philippe Lang
<pre>
175 29 Jean-Philippe Lang
  host=HOST                POP3 server host (default: 127.0.0.1)
176 29 Jean-Philippe Lang
  port=PORT                POP3 server port (default: 110)
177 29 Jean-Philippe Lang
  username=USERNAME        POP3 account
178 29 Jean-Philippe Lang
  password=PASSWORD        POP3 password
179 29 Jean-Philippe Lang
  apop=1                   use APOP authentication (default: false)
180 29 Jean-Philippe Lang
  delete_unprocessed=1     delete messages that could not be processed
181 29 Jean-Philippe Lang
                           successfully from the server (default
182 29 Jean-Philippe Lang
                           behaviour is to leave them on the server)
183 29 Jean-Philippe Lang
</pre>
184 29 Jean-Philippe Lang
185 29 Jean-Philippe Lang
See the IMAP rake task above for issue attributes control options.
186 23 Roland ...
187 1 Jean-Philippe Lang
h3. Reading emails from standard input
188 1 Jean-Philippe Lang
189 1 Jean-Philippe Lang
A rake task (@redmine:email:receive@) can be used to read a single raw email from the standard input.
190 1 Jean-Philippe Lang
191 6 Jean-Philippe Lang
<pre>
192 6 Jean-Philippe Lang
Issue attributes control options:
193 6 Jean-Philippe Lang
  project=PROJECT          identifier of the target project
194 6 Jean-Philippe Lang
  tracker=TRACKER          name of the target tracker
195 6 Jean-Philippe Lang
  category=CATEGORY        name of the target category
196 6 Jean-Philippe Lang
  priority=PRIORITY        name of the target priority
197 6 Jean-Philippe Lang
  allow_override=ATTRS     allow email content to override attributes
198 6 Jean-Philippe Lang
                           specified by previous options
199 6 Jean-Philippe Lang
                           ATTRS is a comma separated list of attributes
200 6 Jean-Philippe Lang
</pre>
201 1 Jean-Philippe Lang
202 6 Jean-Philippe Lang
Examples:
203 1 Jean-Philippe Lang
204 6 Jean-Philippe Lang
<pre>
205 6 Jean-Philippe Lang
  # No project specified. Emails MUST contain the 'Project' keyword:
206 6 Jean-Philippe Lang
  rake redmine:email:read RAILS_ENV="production" < raw_email
207 1 Jean-Philippe Lang
208 6 Jean-Philippe Lang
  # Fixed project and default tracker specified, but emails can override
209 6 Jean-Philippe Lang
  # both tracker and priority attributes:
210 6 Jean-Philippe Lang
  rake redmine:email:read RAILS_ENV="production" \\
211 6 Jean-Philippe Lang
                  project=foo \\
212 6 Jean-Philippe Lang
                  tracker=bug \\
213 6 Jean-Philippe Lang
                  allow_override=tracker,priority < raw_email
214 6 Jean-Philippe Lang
</pre>
215 23 Roland ...
216 24 Roland ...
The option _allow_override_ is not only for overriding default values given to rake, but for every attribute in a mail. If you want to override the tracker in your mail you have to add _allow_override=tracker_ as parameter.
217 1 Jean-Philippe Lang
218 32 Ivan Grcic
h3. Enabling anonymous users to create issues by email
219 32 Ivan Grcic
220 32 Ivan Grcic
In order to enable this option, extra parameters have to be included.
221 32 Ivan Grcic
222 32 Ivan Grcic
<pre>
223 32 Ivan Grcic
unknown_user=ACTION     how to handle emails from an unknown user ACTION can be one of the following values:
224 32 Ivan Grcic
                        ignore: email is ignored (default)
225 32 Ivan Grcic
                        accept: accept as anonymous user
226 32 Ivan Grcic
                        create: create a user account
227 32 Ivan Grcic
228 32 Ivan Grcic
no_permission_check=1   disable permission checking when receiving the email
229 32 Ivan Grcic
</pre>
230 32 Ivan Grcic
231 32 Ivan Grcic
Since version 0.9 project doesn't have to be public, but authentication required in Administration-> Settings->Authentication tab has to be unchecked.
232 1 Jean-Philippe Lang
233 1 Jean-Philippe Lang
h2. How it works
234 1 Jean-Philippe Lang
235 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.
236 1 Jean-Philippe Lang
237 1 Jean-Philippe Lang
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.
238 3 Jean-Philippe Lang
239 15 Jean-Philippe Lang
h3. Target project
240 15 Jean-Philippe Lang
241 27 Eric Davis
The target project can be specified using the @project@ option when receiving emails.  This should be the identifier of the project and *not* the name.  You can easily find the identifier in the url.
242 1 Jean-Philippe Lang
243 16 Jean-Philippe Lang
If you don't use this option, 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"@.
244 16 Jean-Philippe Lang
245 1 Jean-Philippe Lang
Example (email body):
246 1 Jean-Philippe Lang
247 1 Jean-Philippe Lang
<pre>
248 28 Ethan Fremen
This is a new issue that will be added to project foo.
249 28 Ethan Fremen
Here we have the issue description
250 1 Jean-Philippe Lang
[...]
251 1 Jean-Philippe Lang
252 1 Jean-Philippe Lang
Project: foo
253 1 Jean-Philippe Lang
</pre>
254 1 Jean-Philippe Lang
255 16 Jean-Philippe Lang
You can set a default project using the @project@ option and let users override this default project by using the @allow-override@ option when receiving emails.
256 16 Jean-Philippe Lang
Example:
257 16 Jean-Philippe Lang
258 16 Jean-Philippe Lang
<pre>
259 16 Jean-Philippe Lang
  # Create issues on project foo by default
260 16 Jean-Philippe Lang
  rake redmine:email:receive_imap [...] project=foo allow_override=project
261 16 Jean-Philippe Lang
</pre>
262 16 Jean-Philippe Lang
263 14 Jean-Philippe Lang
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.
264 16 Jean-Philippe Lang
Make sure that the target project doesn't use *required* custom fields with no default value for its issues, otherwise the creation of the issue will fail.
265 15 Jean-Philippe Lang
266 15 Jean-Philippe Lang
h3. Issue attributes
267 8 Jean-Philippe Lang
268 1 Jean-Philippe Lang
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.
269 12 Eric Davis
This can be done by using the following keywords in the email body (just like @Project@): @Tracker@, @Category@, @Priority@, @Status@.
270 8 Jean-Philippe Lang
271 16 Jean-Philippe Lang
Example (email body):
272 8 Jean-Philippe Lang
273 8 Jean-Philippe Lang
<pre>
274 28 Ethan Fremen
This is a new issue that overrides a few attributes
275 8 Jean-Philippe Lang
[...]
276 8 Jean-Philippe Lang
277 8 Jean-Philippe Lang
Project: foo
278 1 Jean-Philippe Lang
Tracker: Bug
279 8 Jean-Philippe Lang
Priority: Urgent
280 12 Eric Davis
Status: Resolved
281 8 Jean-Philippe Lang
</pre>
282 15 Jean-Philippe Lang
283 1 Jean-Philippe Lang
h3. Watchers
284 1 Jean-Philippe Lang
285 1 Jean-Philippe Lang
If the user who sends the email has the 'Add issue watchers' permission, users that are in To or Cc field of the email are automatically added as watchers of the created issue.
286 16 Jean-Philippe Lang
287 16 Jean-Philippe Lang
h3. Email format and attachments
288 16 Jean-Philippe Lang
289 16 Jean-Philippe Lang
Redmine tries to use the plain text part of the email to fill the description of the issue.
290 16 Jean-Philippe Lang
If a HTML-only email is received, HTML tags are removed from its body.
291 16 Jean-Philippe Lang
292 16 Jean-Philippe Lang
Email attachments are automatically attached to the issue, unless their size exceeds the [[RedmineSettings#Attachment-max-size|maximum attachment size]] defined in the application settings.