Project

General

Profile

RedmineReceivingEmails » History » Version 52

Jean-Philippe Lang, 2012-06-20 20:59

1 40 Etienne Massip
h1. Receiving emails
2 1 Jean-Philippe Lang
3 4 Jean-Philippe Lang
{{>toc}}
4
5 40 Etienne Massip
As of 0.8.0, Redmine can be configured to allow issue creation or comments via email.
6 1 Jean-Philippe Lang
7 40 Etienne Massip
h2. Setup
8 1 Jean-Philippe Lang
9 40 Etienne Massip
You can configure Redmine to receive emails in one of the following ways:
10 7 Jean-Philippe Lang
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 29 Jean-Philippe Lang
* Fetching emails from an IMAP or POP3 server:
17 7 Jean-Philippe Lang
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 46 Jean-Philippe Lang
36
37
38
39
40
41
42
43 26 Ian Smith-Heisters
Copy @rdm-mailhandler.rb@ to your mail server, make sure its permissions allow execution, and configure your MTA.
44 4 Jean-Philippe Lang
45 5 Jean-Philippe Lang
Usage:
46 4 Jean-Philippe Lang
47 1 Jean-Philippe Lang
<pre>
48 5 Jean-Philippe Lang
rdm-mailhandler [options] --url=<Redmine URL> --key=<API key>
49 1 Jean-Philippe Lang
50 5 Jean-Philippe Lang
Required:
51
  -u, --url                      URL of the Redmine server
52
  -k, --key                      Redmine API key
53
  
54
General options:
55
  -h, --help                     show this help
56
  -v, --verbose                  show extra information
57
  -V, --version                  show version information and exit
58 1 Jean-Philippe Lang
59 5 Jean-Philippe Lang
Issue attributes control options:
60
  -p, --project=PROJECT          identifier of the target project
61
  -t, --tracker=TRACKER          name of the target tracker
62
      --category=CATEGORY        name of the target category
63
      --priority=PRIORITY        name of the target priority
64
  -o, --allow-override=ATTRS     allow email content to override attributes
65
                                 specified by previous options
66
                                 ATTRS is a comma separated list of attributes
67 6 Jean-Philippe Lang
</pre>
68
69 50 Jean-Philippe Lang
See [[RedmineReceivingEmails#Issue-attributes|Issue-attributes]] for a list of values that can be used for the @--allow-override@ option.
70
71 1 Jean-Philippe Lang
Examples:
72 6 Jean-Philippe Lang
73
<pre>
74 5 Jean-Philippe Lang
  # No project specified. Emails MUST contain the 'Project' keyword:
75
  rdm-mailhandler --url http://redmine.domain.foo --key secret
76
  
77
  # Fixed project and default tracker specified, but emails can override
78
  # both tracker and priority attributes:
79
  rdm-mailhandler --url https://domain.foo/redmine --key secret \\
80
                  --project foo \\
81
                  --tracker bug \\
82
                  --allow-override tracker,priority
83
</pre>
84
85 35 Justin Clarke
Here is an example for a Postfix local alias (which is usually specified in @/etc/aliases@):
86 5 Jean-Philippe Lang
87
<pre>
88 1 Jean-Philippe Lang
foo: "|/path/to/rdm-mailhandler.rb --url http://redmine.domain --key secret --project foo"
89 35 Justin Clarke
</pre>
90
91
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:
92
93 36 Justin Clarke
* create a mapping in @/etc/virtual@ like: @ foo@example.org foo@
94 35 Justin Clarke
* modify @/etc/postfix/main.cf@ to specify a transport file: @transport_maps = hash:/etc/postfix/transport@
95 36 Justin Clarke
* within the transport file add a line like: @ foo@example.org local:@
96 35 Justin Clarke
97
*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.
98 1 Jean-Philippe Lang
99 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]]
100
101 1 Jean-Philippe Lang
h3. Fetching emails from an IMAP server
102
103 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:
104 1 Jean-Philippe Lang
105 21 Kurt Miebach
<code>
106
*/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 
107
</code>
108 20 Kurt Miebach
109 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.
110
111
<code>
112
*/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 
113
</code>
114
115 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. 
116 20 Kurt Miebach
117 25 Roland ...
For Windows as server "pycron":http://www.kalab.com/freeware/pycron/pycron.htm can be used to schedule a fetch task.
118 20 Kurt Miebach
119 6 Jean-Philippe Lang
It can be necessary that you open the firewall on the machine for outgoing TCP connections to IMAP port 143.
120 1 Jean-Philippe Lang
121 6 Jean-Philippe Lang
Available IMAP options:
122 20 Kurt Miebach
<pre>
123 6 Jean-Philippe Lang
  host=HOST                IMAP server host (default: 127.0.0.1)
124
  port=PORT                IMAP server port (default: 143)
125
  ssl=SSL                  Use SSL? (default: false)
126 1 Jean-Philippe Lang
  username=USERNAME        IMAP account
127 6 Jean-Philippe Lang
  password=PASSWORD        IMAP password
128 1 Jean-Philippe Lang
  folder=FOLDER            IMAP folder to read (default: INBOX)
129 29 Jean-Philippe Lang
  move_on_success=MAILBOX  move emails that were successfully received
130
                           to MAILBOX instead of deleting them
131
  move_on_failure=MAILBOX  move emails that were ignored to MAILBOX
132 1 Jean-Philippe Lang
</pre>
133 29 Jean-Philippe Lang
134 1 Jean-Philippe Lang
Issue attributes control options:
135 20 Kurt Miebach
<pre>
136 6 Jean-Philippe Lang
  project=PROJECT          identifier of the target project
137
  tracker=TRACKER          name of the target tracker
138
  category=CATEGORY        name of the target category
139
  priority=PRIORITY        name of the target priority
140 18 Eric Davis
  allow_override=ATTRS     allow email content to override attributes
141 1 Jean-Philippe Lang
                           specified by previous options
142 18 Eric Davis
                           ATTRS is a comma separated list of attributes
143
</pre>
144
145 51 Jean-Philippe Lang
See [[RedmineReceivingEmails#Issue-attributes|Issue-attributes]] for a list of values that can be used for the @--allow-override@ option.
146
147 20 Kurt Miebach
Examples for the rake command:
148 1 Jean-Philippe Lang
149 6 Jean-Philippe Lang
<pre>
150
  # No project specified. Emails MUST contain the 'Project' keyword:
151
  
152 11 Thomas Lecavelier
  rake redmine:email:receive_imap RAILS_ENV="production" \\
153 6 Jean-Philippe Lang
    host=imap.foo.bar username=redmine@somenet.foo password=xxx
154 1 Jean-Philippe Lang
155
156 6 Jean-Philippe Lang
  # Fixed project and default tracker specified, but emails can override
157
  # both tracker and priority attributes:
158
  
159 11 Thomas Lecavelier
  rake redmine:email:receive_imap RAILS_ENV="production" \\
160 6 Jean-Philippe Lang
    host=imap.foo.bar username=redmine@somenet.foo password=xxx ssl=1 \\
161
    project=foo \\
162
    tracker=bug \\
163
    allow_override=tracker,priority
164 18 Eric Davis
165
  # Move successful emails to the 'read' mailbox and failed emails to
166
  # the 'failed' mailbox
167
  
168 1 Jean-Philippe Lang
  rake redmine:email:receive_imap RAILS_ENV="production" \\
169
    host=imap.foo.bar username=redmine@somenet.foo password=xxx \\
170
    move_on_success=read move_on_failure=failed
171
172
</pre>
173
174
175 37 Benjamin Haskell
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 emission account.
176 1 Jean-Philippe Lang
177 45 Mischa The Evil
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 a parameter.
178 29 Jean-Philippe Lang
179
h3. Fetching emails from a POP3 server
180
181
_Only available in trunk and future 1.0._
182
183
A rake task (@redmine:email:receive_pop3@) can be used to fetch incoming emails from a POP3 server.
184
185
Available POP3 options:
186
<pre>
187
  host=HOST                POP3 server host (default: 127.0.0.1)
188
  port=PORT                POP3 server port (default: 110)
189
  username=USERNAME        POP3 account
190
  password=PASSWORD        POP3 password
191
  apop=1                   use APOP authentication (default: false)
192
  delete_unprocessed=1     delete messages that could not be processed
193
                           successfully from the server (default
194
                           behaviour is to leave them on the server)
195
</pre>
196
197
See the IMAP rake task above for issue attributes control options.
198 23 Roland ...
199 1 Jean-Philippe Lang
h3. Reading emails from standard input
200
201
A rake task (@redmine:email:receive@) can be used to read a single raw email from the standard input.
202
203 6 Jean-Philippe Lang
<pre>
204
Issue attributes control options:
205
  project=PROJECT          identifier of the target project
206
  tracker=TRACKER          name of the target tracker
207
  category=CATEGORY        name of the target category
208
  priority=PRIORITY        name of the target priority
209
  allow_override=ATTRS     allow email content to override attributes
210
                           specified by previous options
211
                           ATTRS is a comma separated list of attributes
212
</pre>
213 1 Jean-Philippe Lang
214 52 Jean-Philippe Lang
See [[RedmineReceivingEmails#Issue-attributes|Issue-attributes]] for a list of values that can be used for the @allow-override@ option.
215
216 6 Jean-Philippe Lang
Examples:
217 1 Jean-Philippe Lang
218 6 Jean-Philippe Lang
<pre>
219
  # No project specified. Emails MUST contain the 'Project' keyword:
220
  rake redmine:email:read RAILS_ENV="production" < raw_email
221 1 Jean-Philippe Lang
222 6 Jean-Philippe Lang
  # Fixed project and default tracker specified, but emails can override
223
  # both tracker and priority attributes:
224
  rake redmine:email:read RAILS_ENV="production" \\
225
                  project=foo \\
226
                  tracker=bug \\
227
                  allow_override=tracker,priority < raw_email
228
</pre>
229 23 Roland ...
230 45 Mischa The Evil
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 a parameter.
231 1 Jean-Philippe Lang
232 44 Mischa The Evil
h3. Enabling unknown users to create issues by email
233 1 Jean-Philippe Lang
234 44 Mischa The Evil
Redmine has a feature that provides the ability to accept incoming emails from unknown users. In order to use this feature, an extra parameter has to be included:
235 1 Jean-Philippe Lang
<pre>
236 44 Mischa The Evil
unknown_user=ACTION     how to handle emails from an unknown user where ACTION can be one of the following values:
237
                        ignore: the email is ignored (default)
238
                        accept: the sender is considered as an anonymous user and the email is accepted
239
                        create: a user account is created for the sender (username/password are sent back to the user) and the email is accepted
240
</pre>
241 1 Jean-Philippe Lang
242 44 Mischa The Evil
Permissions have to be consistent with the chosen option. E.g. if you choose 'create', the 'Non member' role must have the 'Add issues' permission so that an issue can be created by an unknown user via email. If you choose 'accept', the 'Anonymous' role must have this permission.
243
244 45 Mischa The Evil
You can disable permission checking using the 'no_permission_check' option:
245 44 Mischa The Evil
<pre>
246 1 Jean-Philippe Lang
no_permission_check=1   disable permission checking when receiving the email
247
</pre>
248
249 44 Mischa The Evil
This, together with the 'unknown_user', provides the ability to let anyone submit emails to a private project. For example:
250
<pre>
251
rdm-mailhandler --unknown_user accept --no-permission-check --project=foo
252
</pre>
253
254
will let anyone submit emails to a private project 'foo'.
255
256 45 Mischa The Evil
TODO: Is this true and is this related to the @no_permission_check@ option?:
257 47 Brett Zamir
> Since Redmine 0.9 the project doesn't have to be public, but authentication required in the Administration-> Settings->Authentication tab has to be unchecked.
258 1 Jean-Philippe Lang
259
h2. How it works
260
261 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.
262 1 Jean-Philippe Lang
263
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.
264 3 Jean-Philippe Lang
265 43 Mischa The Evil
Note that, in order to create an issue, all required custom fields must be provided. Without them, issue creation will fail. As an alternative you can ensure that every custom field has a default value which is then used during issue creation.
266 38 Dave Thomas
267 15 Jean-Philippe Lang
h3. Target project
268
269 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.
270 1 Jean-Philippe Lang
271 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"@.
272
273 1 Jean-Philippe Lang
Example (email body):
274
275
<pre>
276 28 Ethan Fremen
This is a new issue that will be added to project foo.
277
Here we have the issue description
278 1 Jean-Philippe Lang
[...]
279
280
Project: foo
281
</pre>
282
283 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.
284
Example:
285
286
<pre>
287
  # Create issues on project foo by default
288
  rake redmine:email:receive_imap [...] project=foo allow_override=project
289
</pre>
290
291 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.
292 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.
293 15 Jean-Philippe Lang
294
h3. Issue attributes
295 8 Jean-Philippe Lang
296 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.
297 48 Daniel Caillibaud
This can be done by using the following keywords in the email body : @Project@, @Tracker@, @Category@, @Priority@, @Status@.
298
299
The values available are the ones of the context. E.g. Status available (for this Tracker and this Project) are labels in the localized language, exactly as displayed in the user interface (even with spaces, without quoting).
300 8 Jean-Philippe Lang
301 16 Jean-Philippe Lang
Example (email body):
302 8 Jean-Philippe Lang
303
<pre>
304 28 Ethan Fremen
This is a new issue that overrides a few attributes
305 8 Jean-Philippe Lang
[...]
306
307
Project: foo
308 1 Jean-Philippe Lang
Tracker: Bug
309 8 Jean-Philippe Lang
Priority: Urgent
310 12 Eric Davis
Status: Resolved
311 8 Jean-Philippe Lang
</pre>
312 15 Jean-Philippe Lang
313 49 Jean-Philippe Lang
Valid attribute values that can used with the @allow-override@ option are:@ project, tracker, status, priority, category, assigned_to, fixed_version@ (aka. Target version),@ start_date, due_date, estimated_hours, done_ratio@.
314
315 1 Jean-Philippe Lang
h3. Watchers
316
317
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.
318 16 Jean-Philippe Lang
319 42 Mischa The Evil
Watchers are added only when the issue is created. To or Cc fields are ignored on replies. See #7017 and #8009.
320 41 Miguel Filho
321 16 Jean-Philippe Lang
h3. Email format and attachments
322
323
Redmine tries to use the plain text part of the email to fill the description of the issue.
324
If a HTML-only email is received, HTML tags are removed from its body.
325
326
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.