Project

General

Profile

RedmineReceivingEmails » History » Version 34

Thomas Guyot-Sionnest, 2010-07-15 00:04
Add link to MailhandlerSubAddress

1 1 Jean-Philippe Lang
h1. Receiving emails
2
3 4 Jean-Philippe Lang
{{>toc}}
4
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
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 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
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 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]]
82
83 1 Jean-Philippe Lang
h3. Fetching emails from an IMAP server
84
85 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:
86 1 Jean-Philippe Lang
87 21 Kurt Miebach
<code>
88
*/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 
89
</code>
90 20 Kurt Miebach
91 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.
92
93
<code>
94
*/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 
95
</code>
96
97 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. 
98 20 Kurt Miebach
99 25 Roland ...
For Windows as server "pycron":http://www.kalab.com/freeware/pycron/pycron.htm can be used to schedule a fetch task.
100 20 Kurt Miebach
101 6 Jean-Philippe Lang
It can be necessary that you open the firewall on the machine for outgoing TCP connections to IMAP port 143.
102 1 Jean-Philippe Lang
103 6 Jean-Philippe Lang
Available IMAP options:
104 20 Kurt Miebach
<pre>
105 6 Jean-Philippe Lang
  host=HOST                IMAP server host (default: 127.0.0.1)
106
  port=PORT                IMAP server port (default: 143)
107
  ssl=SSL                  Use SSL? (default: false)
108 1 Jean-Philippe Lang
  username=USERNAME        IMAP account
109 6 Jean-Philippe Lang
  password=PASSWORD        IMAP password
110 1 Jean-Philippe Lang
  folder=FOLDER            IMAP folder to read (default: INBOX)
111 29 Jean-Philippe Lang
  move_on_success=MAILBOX  move emails that were successfully received
112
                           to MAILBOX instead of deleting them
113
  move_on_failure=MAILBOX  move emails that were ignored to MAILBOX
114 1 Jean-Philippe Lang
</pre>
115 29 Jean-Philippe Lang
116 1 Jean-Philippe Lang
Issue attributes control options:
117 20 Kurt Miebach
<pre>
118 6 Jean-Philippe Lang
  project=PROJECT          identifier of the target project
119
  tracker=TRACKER          name of the target tracker
120
  category=CATEGORY        name of the target category
121
  priority=PRIORITY        name of the target priority
122 18 Eric Davis
  allow_override=ATTRS     allow email content to override attributes
123 1 Jean-Philippe Lang
                           specified by previous options
124 18 Eric Davis
                           ATTRS is a comma separated list of attributes
125
</pre>
126
127 20 Kurt Miebach
Examples for the rake command:
128 1 Jean-Philippe Lang
129 6 Jean-Philippe Lang
<pre>
130
  # No project specified. Emails MUST contain the 'Project' keyword:
131
  
132 11 Thomas Lecavelier
  rake redmine:email:receive_imap RAILS_ENV="production" \\
133 6 Jean-Philippe Lang
    host=imap.foo.bar username=redmine@somenet.foo password=xxx
134 1 Jean-Philippe Lang
135
136 6 Jean-Philippe Lang
  # Fixed project and default tracker specified, but emails can override
137
  # both tracker and priority attributes:
138
  
139 11 Thomas Lecavelier
  rake redmine:email:receive_imap RAILS_ENV="production" \\
140 6 Jean-Philippe Lang
    host=imap.foo.bar username=redmine@somenet.foo password=xxx ssl=1 \\
141
    project=foo \\
142
    tracker=bug \\
143
    allow_override=tracker,priority
144 18 Eric Davis
145
  # Move successful emails to the 'read' mailbox and failed emails to
146
  # the 'failed' mailbox
147
  
148 1 Jean-Philippe Lang
  rake redmine:email:receive_imap RAILS_ENV="production" \\
149
    host=imap.foo.bar username=redmine@somenet.foo password=xxx \\
150
    move_on_success=read move_on_failure=failed
151
152
</pre>
153
154
155 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.
156 1 Jean-Philippe Lang
157
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.
158 29 Jean-Philippe Lang
159
h3. Fetching emails from a POP3 server
160
161
_Only available in trunk and future 1.0._
162
163
A rake task (@redmine:email:receive_pop3@) can be used to fetch incoming emails from a POP3 server.
164
165
Available POP3 options:
166
<pre>
167
  host=HOST                POP3 server host (default: 127.0.0.1)
168
  port=PORT                POP3 server port (default: 110)
169
  username=USERNAME        POP3 account
170
  password=PASSWORD        POP3 password
171
  apop=1                   use APOP authentication (default: false)
172
  delete_unprocessed=1     delete messages that could not be processed
173
                           successfully from the server (default
174
                           behaviour is to leave them on the server)
175
</pre>
176
177
See the IMAP rake task above for issue attributes control options.
178 23 Roland ...
179 1 Jean-Philippe Lang
h3. Reading emails from standard input
180
181
A rake task (@redmine:email:receive@) can be used to read a single raw email from the standard input.
182
183 6 Jean-Philippe Lang
<pre>
184
Issue attributes control options:
185
  project=PROJECT          identifier of the target project
186
  tracker=TRACKER          name of the target tracker
187
  category=CATEGORY        name of the target category
188
  priority=PRIORITY        name of the target priority
189
  allow_override=ATTRS     allow email content to override attributes
190
                           specified by previous options
191
                           ATTRS is a comma separated list of attributes
192
</pre>
193 1 Jean-Philippe Lang
194 6 Jean-Philippe Lang
Examples:
195 1 Jean-Philippe Lang
196 6 Jean-Philippe Lang
<pre>
197
  # No project specified. Emails MUST contain the 'Project' keyword:
198
  rake redmine:email:read RAILS_ENV="production" < raw_email
199 1 Jean-Philippe Lang
200 6 Jean-Philippe Lang
  # Fixed project and default tracker specified, but emails can override
201
  # both tracker and priority attributes:
202
  rake redmine:email:read RAILS_ENV="production" \\
203
                  project=foo \\
204
                  tracker=bug \\
205
                  allow_override=tracker,priority < raw_email
206
</pre>
207 23 Roland ...
208 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.
209 1 Jean-Philippe Lang
210 32 Ivan Grcic
h3. Enabling anonymous users to create issues by email
211
212
In order to enable this option, extra parameters have to be included.
213
214
<pre>
215
unknown_user=ACTION     how to handle emails from an unknown user ACTION can be one of the following values:
216
                        ignore: email is ignored (default)
217
                        accept: accept as anonymous user
218
                        create: create a user account
219
220
no_permission_check=1   disable permission checking when receiving the email
221
</pre>
222
223
Since version 0.9 project doesn't have to be public, but authentication required in Administration-> Settings->Authentication tab has to be unchecked.
224 1 Jean-Philippe Lang
225
h2. How it works
226
227 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.
228 1 Jean-Philippe Lang
229
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.
230 3 Jean-Philippe Lang
231 15 Jean-Philippe Lang
h3. Target project
232
233 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.
234 1 Jean-Philippe Lang
235 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"@.
236
237 1 Jean-Philippe Lang
Example (email body):
238
239
<pre>
240 28 Ethan Fremen
This is a new issue that will be added to project foo.
241
Here we have the issue description
242 1 Jean-Philippe Lang
[...]
243
244
Project: foo
245
</pre>
246
247 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.
248
Example:
249
250
<pre>
251
  # Create issues on project foo by default
252
  rake redmine:email:receive_imap [...] project=foo allow_override=project
253
</pre>
254
255 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.
256 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.
257 15 Jean-Philippe Lang
258
h3. Issue attributes
259 8 Jean-Philippe Lang
260 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.
261 12 Eric Davis
This can be done by using the following keywords in the email body (just like @Project@): @Tracker@, @Category@, @Priority@, @Status@.
262 8 Jean-Philippe Lang
263 16 Jean-Philippe Lang
Example (email body):
264 8 Jean-Philippe Lang
265
<pre>
266 28 Ethan Fremen
This is a new issue that overrides a few attributes
267 8 Jean-Philippe Lang
[...]
268
269
Project: foo
270 1 Jean-Philippe Lang
Tracker: Bug
271 8 Jean-Philippe Lang
Priority: Urgent
272 12 Eric Davis
Status: Resolved
273 8 Jean-Philippe Lang
</pre>
274 15 Jean-Philippe Lang
275 1 Jean-Philippe Lang
h3. Watchers
276
277
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.
278 16 Jean-Philippe Lang
279
h3. Email format and attachments
280
281
Redmine tries to use the plain text part of the email to fill the description of the issue.
282
If a HTML-only email is received, HTML tags are removed from its body.
283
284
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.