Project

General

Profile

RedmineReceivingEmails » History » Version 45

Mischa The Evil, 2011-11-28 04:56
Small changes regarding s:parameter/option and added some prepositions.

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 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
  -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 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
<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
81
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
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
*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
91 1 Jean-Philippe Lang
h3. Fetching emails from an IMAP server
92
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
*/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
</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
101
<code>
102
*/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
</code>
104
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
  port=PORT                IMAP server port (default: 143)
115
  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
                           to MAILBOX instead of deleting them
121
  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
  tracker=TRACKER          name of the target tracker
128
  category=CATEGORY        name of the target category
129
  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
</pre>
134
135 20 Kurt Miebach
Examples for the rake command:
136 1 Jean-Philippe Lang
137 6 Jean-Philippe Lang
<pre>
138
  # No project specified. Emails MUST contain the 'Project' keyword:
139
  
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
144 6 Jean-Philippe Lang
  # Fixed project and default tracker specified, but emails can override
145
  # both tracker and priority attributes:
146
  
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
    project=foo \\
150
    tracker=bug \\
151
    allow_override=tracker,priority
152 18 Eric Davis
153
  # Move successful emails to the 'read' mailbox and failed emails to
154
  # the 'failed' mailbox
155
  
156 1 Jean-Philippe Lang
  rake redmine:email:receive_imap RAILS_ENV="production" \\
157
    host=imap.foo.bar username=redmine@somenet.foo password=xxx \\
158
    move_on_success=read move_on_failure=failed
159
160
</pre>
161
162
163 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.
164 1 Jean-Philippe Lang
165 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.
166 29 Jean-Philippe Lang
167
h3. Fetching emails from a POP3 server
168
169
_Only available in trunk and future 1.0._
170
171
A rake task (@redmine:email:receive_pop3@) can be used to fetch incoming emails from a POP3 server.
172
173
Available POP3 options:
174
<pre>
175
  host=HOST                POP3 server host (default: 127.0.0.1)
176
  port=PORT                POP3 server port (default: 110)
177
  username=USERNAME        POP3 account
178
  password=PASSWORD        POP3 password
179
  apop=1                   use APOP authentication (default: false)
180
  delete_unprocessed=1     delete messages that could not be processed
181
                           successfully from the server (default
182
                           behaviour is to leave them on the server)
183
</pre>
184
185
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
189
A rake task (@redmine:email:receive@) can be used to read a single raw email from the standard input.
190
191 6 Jean-Philippe Lang
<pre>
192
Issue attributes control options:
193
  project=PROJECT          identifier of the target project
194
  tracker=TRACKER          name of the target tracker
195
  category=CATEGORY        name of the target category
196
  priority=PRIORITY        name of the target priority
197
  allow_override=ATTRS     allow email content to override attributes
198
                           specified by previous options
199
                           ATTRS is a comma separated list of attributes
200
</pre>
201 1 Jean-Philippe Lang
202 6 Jean-Philippe Lang
Examples:
203 1 Jean-Philippe Lang
204 6 Jean-Philippe Lang
<pre>
205
  # No project specified. Emails MUST contain the 'Project' keyword:
206
  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
  # both tracker and priority attributes:
210
  rake redmine:email:read RAILS_ENV="production" \\
211
                  project=foo \\
212
                  tracker=bug \\
213
                  allow_override=tracker,priority < raw_email
214
</pre>
215 23 Roland ...
216 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.
217 1 Jean-Philippe Lang
218 44 Mischa The Evil
h3. Enabling unknown users to create issues by email
219 1 Jean-Philippe Lang
220 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:
221 1 Jean-Philippe Lang
<pre>
222 44 Mischa The Evil
unknown_user=ACTION     how to handle emails from an unknown user where ACTION can be one of the following values:
223
                        ignore: the email is ignored (default)
224
                        accept: the sender is considered as an anonymous user and the email is accepted
225
                        create: a user account is created for the sender (username/password are sent back to the user) and the email is accepted
226
</pre>
227 1 Jean-Philippe Lang
228 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.
229
230 45 Mischa The Evil
You can disable permission checking using the 'no_permission_check' option:
231 44 Mischa The Evil
<pre>
232 1 Jean-Philippe Lang
no_permission_check=1   disable permission checking when receiving the email
233
</pre>
234
235 44 Mischa The Evil
This, together with the 'unknown_user', provides the ability to let anyone submit emails to a private project. For example:
236
<pre>
237
rdm-mailhandler --unknown_user accept --no-permission-check --project=foo
238
</pre>
239
240
will let anyone submit emails to a private project 'foo'.
241
242 45 Mischa The Evil
TODO: Is this true and is this related to the @no_permission_check@ option?:
243 44 Mischa The Evil
> Since Redmine 0.9 project doesn't have to be public, but authentication required in Administration-> Settings->Authentication tab has to be unchecked.
244 1 Jean-Philippe Lang
245
h2. How it works
246
247 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.
248 1 Jean-Philippe Lang
249
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.
250 3 Jean-Philippe Lang
251 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.
252 38 Dave Thomas
253 15 Jean-Philippe Lang
h3. Target project
254
255 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.
256 1 Jean-Philippe Lang
257 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"@.
258
259 1 Jean-Philippe Lang
Example (email body):
260
261
<pre>
262 28 Ethan Fremen
This is a new issue that will be added to project foo.
263
Here we have the issue description
264 1 Jean-Philippe Lang
[...]
265
266
Project: foo
267
</pre>
268
269 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.
270
Example:
271
272
<pre>
273
  # Create issues on project foo by default
274
  rake redmine:email:receive_imap [...] project=foo allow_override=project
275
</pre>
276
277 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.
278 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.
279 15 Jean-Philippe Lang
280
h3. Issue attributes
281 8 Jean-Philippe Lang
282 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.
283 12 Eric Davis
This can be done by using the following keywords in the email body (just like @Project@): @Tracker@, @Category@, @Priority@, @Status@.
284 8 Jean-Philippe Lang
285 16 Jean-Philippe Lang
Example (email body):
286 8 Jean-Philippe Lang
287
<pre>
288 28 Ethan Fremen
This is a new issue that overrides a few attributes
289 8 Jean-Philippe Lang
[...]
290
291
Project: foo
292 1 Jean-Philippe Lang
Tracker: Bug
293 8 Jean-Philippe Lang
Priority: Urgent
294 12 Eric Davis
Status: Resolved
295 8 Jean-Philippe Lang
</pre>
296 15 Jean-Philippe Lang
297 1 Jean-Philippe Lang
h3. Watchers
298
299
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.
300 16 Jean-Philippe Lang
301 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.
302 41 Miguel Filho
303 16 Jean-Philippe Lang
h3. Email format and attachments
304
305
Redmine tries to use the plain text part of the email to fill the description of the issue.
306
If a HTML-only email is received, HTML tags are removed from its body.
307
308
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.