RedmineReceivingEmails » History » Version 74

Deoren Moor, 2015-10-19 15:24
Updated Issue attributes section with changes applied in #20543#note-3 (r14680, r14681).

1 40 Etienne Massip
h1. Receiving emails
2 1 Jean-Philippe Lang
3 4 Jean-Philippe Lang
{{>toc}}
4 4 Jean-Philippe Lang
5 55 Art Kuo
As of 0.8.0, Redmine can be configured to allow issue creation or comments via email. It is also able to recognize and incorporate email replies to forum messages.
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 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 46 Jean-Philippe Lang
36 46 Jean-Philippe Lang
37 46 Jean-Philippe Lang
38 46 Jean-Philippe Lang
39 46 Jean-Philippe Lang
40 46 Jean-Philippe Lang
41 46 Jean-Philippe Lang
42 46 Jean-Philippe Lang
43 59 Filou Centrinov
Copy @rdm-mailhandler.rb@ to your mail server, make sure its permissions allow execution, and configure your MTA (Mail Transport Agent).
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 5 Jean-Philippe Lang
  -u, --url                      URL of the Redmine server
52 5 Jean-Philippe Lang
  -k, --key                      Redmine API key
53 5 Jean-Philippe Lang
  
54 5 Jean-Philippe Lang
General options:
55 5 Jean-Philippe Lang
  -h, --help                     show this help
56 5 Jean-Philippe Lang
  -v, --verbose                  show extra information
57 5 Jean-Philippe Lang
  -V, --version                  show version information and exit
58 1 Jean-Philippe Lang
59 5 Jean-Philippe Lang
Issue attributes control options:
60 5 Jean-Philippe Lang
  -p, --project=PROJECT          identifier of the target project
61 5 Jean-Philippe Lang
  -t, --tracker=TRACKER          name of the target tracker
62 5 Jean-Philippe Lang
      --category=CATEGORY        name of the target category
63 5 Jean-Philippe Lang
      --priority=PRIORITY        name of the target priority
64 5 Jean-Philippe Lang
  -o, --allow-override=ATTRS     allow email content to override attributes
65 5 Jean-Philippe Lang
                                 specified by previous options
66 5 Jean-Philippe Lang
                                 ATTRS is a comma separated list of attributes
67 6 Jean-Philippe Lang
</pre>
68 6 Jean-Philippe Lang
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 50 Jean-Philippe Lang
71 1 Jean-Philippe Lang
Examples:
72 6 Jean-Philippe Lang
73 6 Jean-Philippe Lang
<pre>
74 5 Jean-Philippe Lang
  # No project specified. Emails MUST contain the 'Project' keyword:
75 5 Jean-Philippe Lang
  rdm-mailhandler --url http://redmine.domain.foo --key secret
76 5 Jean-Philippe Lang
  
77 5 Jean-Philippe Lang
  # Fixed project and default tracker specified, but emails can override
78 5 Jean-Philippe Lang
  # both tracker and priority attributes:
79 5 Jean-Philippe Lang
  rdm-mailhandler --url https://domain.foo/redmine --key secret \\
80 5 Jean-Philippe Lang
                  --project foo \\
81 5 Jean-Philippe Lang
                  --tracker bug \\
82 5 Jean-Philippe Lang
                  --allow-override tracker,priority
83 5 Jean-Philippe Lang
</pre>
84 5 Jean-Philippe Lang
85 54 Art Kuo
Here is an example for a Postfix local alias entry:
86 5 Jean-Philippe Lang
87 5 Jean-Philippe Lang
<pre>
88 1 Jean-Philippe Lang
foo: "|/path/to/rdm-mailhandler.rb --url http://redmine.domain --key secret --project foo"
89 1 Jean-Philippe Lang
</pre>
90 54 Art Kuo
91 55 Art Kuo
This line should go in the aliases file, which is usually specified in @/etc/aliases@. If the location is unknown, use the command @postconf alias_maps@ to find out. After updating the aliases file, be sure to run @newaliases@ to alert Postfix of the new entry.
92 35 Justin Clarke
93 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:
94 35 Justin Clarke
95 36 Justin Clarke
* create a mapping in @/etc/virtual@ like: @ foo@example.org foo@
96 35 Justin Clarke
* modify @/etc/postfix/main.cf@ to specify a transport file: @transport_maps = hash:/etc/postfix/transport@
97 36 Justin Clarke
* within the transport file add a line like: @ foo@example.org local:@
98 35 Justin Clarke
99 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.
100 1 Jean-Philippe Lang
101 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]]
102 34 Thomas Guyot-Sionnest
103 1 Jean-Philippe Lang
h3. Fetching emails from an IMAP server
104 1 Jean-Philippe Lang
105 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:
106 1 Jean-Philippe Lang
107 68 Denis Savitskiy
<pre>
108 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 
109 68 Denis Savitskiy
</pre>
110 20 Kurt Miebach
111 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.
112 33 Jürgen Hörmann
113 68 Denis Savitskiy
<pre>
114 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 
115 68 Denis Savitskiy
</pre>
116 33 Jürgen Hörmann
117 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. 
118 20 Kurt Miebach
119 25 Roland ...
For Windows as server "pycron":http://www.kalab.com/freeware/pycron/pycron.htm can be used to schedule a fetch task.
120 20 Kurt Miebach
121 6 Jean-Philippe Lang
It can be necessary that you open the firewall on the machine for outgoing TCP connections to IMAP port 143.
122 1 Jean-Philippe Lang
123 6 Jean-Philippe Lang
Available IMAP options:
124 20 Kurt Miebach
<pre>
125 6 Jean-Philippe Lang
  host=HOST                IMAP server host (default: 127.0.0.1)
126 6 Jean-Philippe Lang
  port=PORT                IMAP server port (default: 143)
127 6 Jean-Philippe Lang
  ssl=SSL                  Use SSL? (default: false)
128 72 Sebastian Paluch
  starttls=STARTTLS        Use STARTTLS? (default: false)
129 1 Jean-Philippe Lang
  username=USERNAME        IMAP account
130 6 Jean-Philippe Lang
  password=PASSWORD        IMAP password
131 1 Jean-Philippe Lang
  folder=FOLDER            IMAP folder to read (default: INBOX)
132 29 Jean-Philippe Lang
  move_on_success=MAILBOX  move emails that were successfully received
133 29 Jean-Philippe Lang
                           to MAILBOX instead of deleting them
134 29 Jean-Philippe Lang
  move_on_failure=MAILBOX  move emails that were ignored to MAILBOX
135 1 Jean-Philippe Lang
</pre>
136 29 Jean-Philippe Lang
137 1 Jean-Philippe Lang
Issue attributes control options:
138 20 Kurt Miebach
<pre>
139 6 Jean-Philippe Lang
  project=PROJECT          identifier of the target project
140 6 Jean-Philippe Lang
  tracker=TRACKER          name of the target tracker
141 6 Jean-Philippe Lang
  category=CATEGORY        name of the target category
142 6 Jean-Philippe Lang
  priority=PRIORITY        name of the target priority
143 18 Eric Davis
  allow_override=ATTRS     allow email content to override attributes
144 1 Jean-Philippe Lang
                           specified by previous options
145 18 Eric Davis
                           ATTRS is a comma separated list of attributes
146 18 Eric Davis
</pre>
147 18 Eric Davis
148 53 Jean-Philippe Lang
See [[RedmineReceivingEmails#Issue-attributes|Issue-attributes]] for a list of values that can be used for the @allow-override@ option.
149 51 Jean-Philippe Lang
150 20 Kurt Miebach
Examples for the rake command:
151 1 Jean-Philippe Lang
152 6 Jean-Philippe Lang
<pre>
153 6 Jean-Philippe Lang
  # No project specified. Emails MUST contain the 'Project' keyword:
154 6 Jean-Philippe Lang
  
155 11 Thomas Lecavelier
  rake redmine:email:receive_imap RAILS_ENV="production" \\
156 6 Jean-Philippe Lang
    host=imap.foo.bar username=redmine@somenet.foo password=xxx
157 1 Jean-Philippe Lang
158 1 Jean-Philippe Lang
159 6 Jean-Philippe Lang
  # Fixed project and default tracker specified, but emails can override
160 6 Jean-Philippe Lang
  # both tracker and priority attributes:
161 6 Jean-Philippe Lang
  
162 11 Thomas Lecavelier
  rake redmine:email:receive_imap RAILS_ENV="production" \\
163 6 Jean-Philippe Lang
    host=imap.foo.bar username=redmine@somenet.foo password=xxx ssl=1 \\
164 6 Jean-Philippe Lang
    project=foo \\
165 6 Jean-Philippe Lang
    tracker=bug \\
166 6 Jean-Philippe Lang
    allow_override=tracker,priority
167 18 Eric Davis
168 18 Eric Davis
  # Move successful emails to the 'read' mailbox and failed emails to
169 18 Eric Davis
  # the 'failed' mailbox
170 18 Eric Davis
  
171 1 Jean-Philippe Lang
  rake redmine:email:receive_imap RAILS_ENV="production" \\
172 1 Jean-Philippe Lang
    host=imap.foo.bar username=redmine@somenet.foo password=xxx \\
173 1 Jean-Philippe Lang
    move_on_success=read move_on_failure=failed
174 1 Jean-Philippe Lang
175 1 Jean-Philippe Lang
</pre>
176 1 Jean-Philippe Lang
177 1 Jean-Philippe Lang
178 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.
179 1 Jean-Philippe Lang
180 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.
181 29 Jean-Philippe Lang
182 29 Jean-Philippe Lang
h3. Fetching emails from a POP3 server
183 29 Jean-Philippe Lang
184 29 Jean-Philippe Lang
_Only available in trunk and future 1.0._
185 29 Jean-Philippe Lang
186 29 Jean-Philippe Lang
A rake task (@redmine:email:receive_pop3@) can be used to fetch incoming emails from a POP3 server.
187 29 Jean-Philippe Lang
188 29 Jean-Philippe Lang
Available POP3 options:
189 29 Jean-Philippe Lang
<pre>
190 29 Jean-Philippe Lang
  host=HOST                POP3 server host (default: 127.0.0.1)
191 29 Jean-Philippe Lang
  port=PORT                POP3 server port (default: 110)
192 29 Jean-Philippe Lang
  username=USERNAME        POP3 account
193 29 Jean-Philippe Lang
  password=PASSWORD        POP3 password
194 29 Jean-Philippe Lang
  apop=1                   use APOP authentication (default: false)
195 29 Jean-Philippe Lang
  delete_unprocessed=1     delete messages that could not be processed
196 29 Jean-Philippe Lang
                           successfully from the server (default
197 29 Jean-Philippe Lang
                           behaviour is to leave them on the server)
198 29 Jean-Philippe Lang
</pre>
199 29 Jean-Philippe Lang
200 29 Jean-Philippe Lang
See the IMAP rake task above for issue attributes control options.
201 23 Roland ...
202 1 Jean-Philippe Lang
h3. Reading emails from standard input
203 1 Jean-Philippe Lang
204 1 Jean-Philippe Lang
A rake task (@redmine:email:receive@) can be used to read a single raw email from the standard input.
205 1 Jean-Philippe Lang
206 6 Jean-Philippe Lang
<pre>
207 6 Jean-Philippe Lang
Issue attributes control options:
208 6 Jean-Philippe Lang
  project=PROJECT          identifier of the target project
209 6 Jean-Philippe Lang
  tracker=TRACKER          name of the target tracker
210 6 Jean-Philippe Lang
  category=CATEGORY        name of the target category
211 6 Jean-Philippe Lang
  priority=PRIORITY        name of the target priority
212 6 Jean-Philippe Lang
  allow_override=ATTRS     allow email content to override attributes
213 6 Jean-Philippe Lang
                           specified by previous options
214 6 Jean-Philippe Lang
                           ATTRS is a comma separated list of attributes
215 6 Jean-Philippe Lang
</pre>
216 1 Jean-Philippe Lang
217 52 Jean-Philippe Lang
See [[RedmineReceivingEmails#Issue-attributes|Issue-attributes]] for a list of values that can be used for the @allow-override@ option.
218 52 Jean-Philippe Lang
219 6 Jean-Philippe Lang
Examples:
220 1 Jean-Philippe Lang
221 6 Jean-Philippe Lang
<pre>
222 6 Jean-Philippe Lang
  # No project specified. Emails MUST contain the 'Project' keyword:
223 6 Jean-Philippe Lang
  rake redmine:email:read RAILS_ENV="production" < raw_email
224 1 Jean-Philippe Lang
225 6 Jean-Philippe Lang
  # Fixed project and default tracker specified, but emails can override
226 6 Jean-Philippe Lang
  # both tracker and priority attributes:
227 6 Jean-Philippe Lang
  rake redmine:email:read RAILS_ENV="production" \\
228 6 Jean-Philippe Lang
                  project=foo \\
229 6 Jean-Philippe Lang
                  tracker=bug \\
230 6 Jean-Philippe Lang
                  allow_override=tracker,priority < raw_email
231 6 Jean-Philippe Lang
</pre>
232 23 Roland ...
233 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.
234 1 Jean-Philippe Lang
235 44 Mischa The Evil
h3. Enabling unknown users to create issues by email
236 1 Jean-Philippe Lang
237 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:
238 1 Jean-Philippe Lang
<pre>
239 61 Jean-Baptiste Barth
unknown_user=ACTION     how to handle emails from an unknown user where ACTION can be one of the following values:
240 44 Mischa The Evil
                        ignore: the email is ignored (default)
241 44 Mischa The Evil
                        accept: the sender is considered as an anonymous user and the email is accepted
242 44 Mischa The Evil
                        create: a user account is created for the sender (username/password are sent back to the user) and the email is accepted
243 44 Mischa The Evil
</pre>
244 1 Jean-Philippe Lang
245 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.
246 44 Mischa The Evil
247 60 Philipp erpel
If you receive emails via the rake task, the unknown-user option has to be written as:
248 60 Philipp erpel
<pre>
249 60 Philipp erpel
 unknown_user=[ignore|accept|create]
250 60 Philipp erpel
</pre>
251 60 Philipp erpel
252 45 Mischa The Evil
You can disable permission checking using the 'no_permission_check' option:
253 44 Mischa The Evil
<pre>
254 1 Jean-Philippe Lang
no_permission_check=1   disable permission checking when receiving the email
255 1 Jean-Philippe Lang
</pre>
256 1 Jean-Philippe Lang
257 57 Antoine Beaupré
This, together with the 'unknown-user', provides the ability to let anyone submit emails to a private project. For example:
258 44 Mischa The Evil
<pre>
259 57 Antoine Beaupré
rdm-mailhandler --unknown-user accept --no-permission-check --project=foo
260 44 Mischa The Evil
</pre>
261 44 Mischa The Evil
262 44 Mischa The Evil
will let anyone submit emails to a private project 'foo'.
263 44 Mischa The Evil
264 45 Mischa The Evil
TODO: Is this true and is this related to the @no_permission_check@ option?:
265 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.
266 1 Jean-Philippe Lang
267 58 Terence Mill
If you do not want an "new account notification email" sent to every newly created user by rdm-mailhandler you must add the option "--no-account-notice". Is implemneted with version#60 in issue #11498. Now an example:
268 58 Terence Mill
<pre>
269 58 Terence Mill
rdm-mailhandler --unknown-user accept --no-permission-check --project=foo --no-account-notice
270 58 Terence Mill
</pre>
271 58 Terence Mill
272 70 Pierre Maigne
h3. Schedule email receiving with Rufus Scheduler
273 70 Pierre Maigne
274 70 Pierre Maigne
Instead of using a cron to trigger the Rake task to retrieve incoming email, you can use Rufus Scheduler which will run the Rake task in the same process as Redmine.
275 70 Pierre Maigne
This is using less ressources and faster than calling the Rake task from a cron (or from the Task Scheduler on Windows).
276 70 Pierre Maigne
277 70 Pierre Maigne
To do that, install rufus-scheduler gem:
278 70 Pierre Maigne
<pre>gem install rufus-scheduler</pre>
279 70 Pierre Maigne
280 70 Pierre Maigne
Create a what_you_want.rb file in /config/initializers/ and put the following content in your file. (Here for a POP3 account. Change it with your own parameters and own task.)
281 70 Pierre Maigne
<pre>
282 70 Pierre Maigne
require 'rubygems'
283 70 Pierre Maigne
require 'rake'
284 70 Pierre Maigne
require 'rufus-scheduler'
285 70 Pierre Maigne
286 70 Pierre Maigne
load File.join(Rails.root, 'Rakefile')
287 70 Pierre Maigne
288 70 Pierre Maigne
ENV['host']='pop.toto.com'
289 70 Pierre Maigne
ENV['port']='110'
290 70 Pierre Maigne
ENV['ssl']='SSL'
291 70 Pierre Maigne
ENV['username']='redmine@toto.com'
292 70 Pierre Maigne
ENV['password']='azerty123456'
293 70 Pierre Maigne
294 70 Pierre Maigne
scheduler = Rufus::Scheduler.new
295 70 Pierre Maigne
# Check emails every 10 mins
296 70 Pierre Maigne
scheduler.interval '10m' do
297 70 Pierre Maigne
  task = Rake.application['redmine:email:receive_pop3']
298 70 Pierre Maigne
  task.reenable
299 70 Pierre Maigne
  task.invoke 
300 70 Pierre Maigne
end
301 70 Pierre Maigne
</pre>
302 70 Pierre Maigne
303 70 Pierre Maigne
Restart your Redmine instance and your incoming emails will be retrieved on schedule.
304 70 Pierre Maigne
305 70 Pierre Maigne
You can check "Rufus-Scheduler":https://github.com/jmettraux/rufus-scheduler for scheduling syntax.
306 70 Pierre Maigne
307 1 Jean-Philippe Lang
h2. How it works
308 1 Jean-Philippe Lang
309 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.
310 1 Jean-Philippe Lang
311 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.
312 3 Jean-Philippe Lang
313 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.
314 38 Dave Thomas
315 15 Jean-Philippe Lang
h3. Target project
316 15 Jean-Philippe Lang
317 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.
318 1 Jean-Philippe Lang
319 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"@.
320 16 Jean-Philippe Lang
321 1 Jean-Philippe Lang
Example (email body):
322 1 Jean-Philippe Lang
323 1 Jean-Philippe Lang
<pre>
324 28 Ethan Fremen
This is a new issue that will be added to project foo.
325 28 Ethan Fremen
Here we have the issue description
326 1 Jean-Philippe Lang
[...]
327 1 Jean-Philippe Lang
328 1 Jean-Philippe Lang
Project: foo
329 1 Jean-Philippe Lang
</pre>
330 1 Jean-Philippe Lang
331 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.
332 16 Jean-Philippe Lang
Example:
333 16 Jean-Philippe Lang
334 16 Jean-Philippe Lang
<pre>
335 16 Jean-Philippe Lang
  # Create issues on project foo by default
336 16 Jean-Philippe Lang
  rake redmine:email:receive_imap [...] project=foo allow_override=project
337 16 Jean-Philippe Lang
</pre>
338 16 Jean-Philippe Lang
339 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.
340 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.
341 15 Jean-Philippe Lang
342 15 Jean-Philippe Lang
h3. Issue attributes
343 8 Jean-Philippe Lang
344 74 Deoren Moor
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. 
345 74 Deoren Moor
346 74 Deoren Moor
Note: prior to Redmine version:"3.2.0" (#20543) some attributes were _always_ overridable, but this was not documented. This behavior has been changed and all attributes have to be explicitly listed with the @allow_override@ option to be overridable. For those who want all attributes to be overridable, @allow_override=all@ can now be used (#20543).
347 74 Deoren Moor
348 74 Deoren Moor
Once @allow_override@ has been configured, you can override those attributes by using the appropriate keywords in the email body.
349 1 Jean-Philippe Lang
350 66 Deoren Moor
Example keyword list:
351 66 Deoren Moor
352 66 Deoren Moor
* @Project@
353 66 Deoren Moor
* @Tracker@
354 66 Deoren Moor
* @Category@
355 1 Jean-Philippe Lang
* @Priority@
356 1 Jean-Philippe Lang
* @Status@
357 69 Denis Savitskiy
* @Start date@
358 69 Denis Savitskiy
* @Due date@
359 69 Denis Savitskiy
* @Target version@
360 73 Mathieu Janson
* @Estimated hours@
361 69 Denis Savitskiy
* @Done ratio@
362 69 Denis Savitskiy
* @<Custom field name>@
363 66 Deoren Moor
364 71 Toshi MARUYAMA
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 or system default language (even with spaces, without quoting).
365 66 Deoren Moor
366 8 Jean-Philippe Lang
Example (email body):
367 8 Jean-Philippe Lang
368 28 Ethan Fremen
<pre>
369 8 Jean-Philippe Lang
This is a new issue that overrides a few attributes
370 8 Jean-Philippe Lang
[...]
371 8 Jean-Philippe Lang
372 1 Jean-Philippe Lang
Project: foo
373 8 Jean-Philippe Lang
Tracker: Bug
374 1 Jean-Philippe Lang
Priority: Urgent
375 1 Jean-Philippe Lang
Status: Resolved
376 1 Jean-Philippe Lang
</pre>
377 1 Jean-Philippe Lang
378 66 Deoren Moor
The format for keywords differs from the allowed attribute values for the @allow_override@ option:
379 66 Deoren Moor
380 66 Deoren Moor
* @project@
381 66 Deoren Moor
* @tracker@
382 66 Deoren Moor
* @status@
383 66 Deoren Moor
* @priority@
384 66 Deoren Moor
* @category@
385 66 Deoren Moor
* @assigned_to@
386 66 Deoren Moor
* @fixed_version@ (aka. Target version)
387 66 Deoren Moor
* @start_date@
388 66 Deoren Moor
* @due_date@
389 66 Deoren Moor
* @estimated_hours@
390 66 Deoren Moor
* @done_ratio@
391 66 Deoren Moor
392 66 Deoren Moor
Multiple attribute values can be specified in order to allow only certain keywords to be used.
393 66 Deoren Moor
394 66 Deoren Moor
Example:
395 66 Deoren Moor
396 66 Deoren Moor
<pre>
397 66 Deoren Moor
  # Allow overriding project, tracker, status & priority
398 66 Deoren Moor
  rake redmine:email:receive_imap [...] allow_override=project,tracker,status,priority
399 66 Deoren Moor
</pre>
400 49 Jean-Philippe Lang
401 1 Jean-Philippe Lang
h3. Watchers
402 1 Jean-Philippe Lang
403 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.
404 16 Jean-Philippe Lang
405 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.
406 41 Miguel Filho
407 16 Jean-Philippe Lang
h3. Email format and attachments
408 16 Jean-Philippe Lang
409 16 Jean-Philippe Lang
Redmine tries to use the plain text part of the email to fill the description of the issue.
410 16 Jean-Philippe Lang
If a HTML-only email is received, HTML tags are removed from its body.
411 1 Jean-Philippe Lang
412 55 Art Kuo
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.
413 55 Art Kuo
414 55 Art Kuo
h3. Truncate emails
415 1 Jean-Philippe Lang
416 65 Toshi MARUYAMA
The Administrator's settings may be used to automatically truncate emails, for example to eliminate quoted messages in forum replies. To do this, set the outgoing email header to something like @--Reply above this line--@ in the Email notifications settings. Then in the Incoming emails settings, enter the same line into the box "Truncate emails after one of these lines." (It is also possible to allow regex to be truncated, using the patch attached to #5864)