RedmineReceivingEmails » History » Version 31

Paul Gresham, 2010-02-23 08:15

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