RedmineReceivingEmails » History » Version 89

Go MAEDA, 2018-01-21 12:47
Deleted "Issue attributes control options" from "Reading emails from standard input" to eliminate duplicate description

1 40 Etienne Massip
h1. Receiving emails
2 1 Jean-Philippe Lang
3 4 Jean-Philippe Lang
{{>toc}}
4 4 Jean-Philippe Lang
5 77 Go MAEDA
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 84 Go MAEDA
This script reads a raw email from the standard input and forwards 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 85 Go MAEDA
Copy @rdm-mailhandler.rb@ to your mail server, make sure its permissions allow execution (@chmod +x rdm-mailhandler.rb@), 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 78 Go MAEDA
Usage: rdm-mailhandler.rb [options] --url=<Redmine URL> --key=<API key>
49 1 Jean-Philippe Lang
50 82 Go MAEDA
Required arguments:
51 82 Go MAEDA
    -u, --url URL               URL of the Redmine server
52 82 Go MAEDA
    -k, --key KEY               Redmine API key
53 82 Go MAEDA
54 82 Go MAEDA
General options:
55 82 Go MAEDA
        --key-file FILE         full path to a file that contains your Redmine
56 82 Go MAEDA
                                API key (use this option instead of --key if
57 82 Go MAEDA
                                you don't want the key to appear in the command
58 82 Go MAEDA
                                line)
59 82 Go MAEDA
        --no-check-certificate  do not check server certificate
60 82 Go MAEDA
        --certificate-bundle FILE
61 78 Go MAEDA
                                certificate bundle to use
62 76 Jannik Lorenz
    -h, --help                  show this help
63 76 Jannik Lorenz
    -v, --verbose               show extra information
64 76 Jannik Lorenz
    -V, --version               show version information and exit
65 1 Jean-Philippe Lang
66 78 Go MAEDA
User and permissions options:
67 76 Jannik Lorenz
        --unknown-user ACTION   how to handle emails from an unknown user
68 1 Jean-Philippe Lang
                                ACTION can be one of the following values:
69 1 Jean-Philippe Lang
                                * ignore: email is ignored (default)
70 76 Jannik Lorenz
                                * accept: accept as anonymous user
71 76 Jannik Lorenz
                                * create: create a user account
72 1 Jean-Philippe Lang
        --no-permission-check   disable permission checking when receiving
73 78 Go MAEDA
                                the email
74 78 Go MAEDA
        --default-group GROUP   add created user to GROUP (none by default)
75 76 Jannik Lorenz
                                GROUP can be a comma separated list of groups
76 76 Jannik Lorenz
        --no-account-notice     don't send account information to the newly
77 76 Jannik Lorenz
                                created user
78 76 Jannik Lorenz
        --no-notification       disable email notifications for the created
79 1 Jean-Philippe Lang
                                user
80 1 Jean-Philippe Lang
81 1 Jean-Philippe Lang
Issue attributes control options:
82 76 Jannik Lorenz
        --project-from-subaddress ADDR
83 81 Go MAEDA
                                select project from subaddress of ADDR found
84 78 Go MAEDA
                                in To, Cc, Bcc headers
85 1 Jean-Philippe Lang
    -p, --project PROJECT       identifier of the target project
86 1 Jean-Philippe Lang
    -s, --status STATUS         name of the target status
87 1 Jean-Philippe Lang
    -t, --tracker TRACKER       name of the target tracker
88 76 Jannik Lorenz
        --category CATEGORY     name of the target category
89 1 Jean-Philippe Lang
        --priority PRIORITY     name of the target priority
90 78 Go MAEDA
        --assigned-to ASSIGNEE  assignee (username or group name)
91 78 Go MAEDA
        --fixed-version VERSION name of the target version
92 78 Go MAEDA
        --private               create new issues as private
93 78 Go MAEDA
    -o, --allow-override ATTRS  allow email content to set attributes values
94 76 Jannik Lorenz
                                ATTRS is a comma separated list of attributes
95 78 Go MAEDA
                                or 'all' to allow all attributes to be
96 78 Go MAEDA
                                overridable (see below for details)
97 6 Jean-Philippe Lang
</pre>
98 5 Jean-Philippe Lang
99 5 Jean-Philippe Lang
See [[RedmineReceivingEmails#Issue-attributes|Issue-attributes]] for a list of values that can be used for the @--allow-override@ option.
100 5 Jean-Philippe Lang
101 5 Jean-Philippe Lang
Examples:
102 5 Jean-Philippe Lang
103 5 Jean-Philippe Lang
<pre>
104 5 Jean-Philippe Lang
  # No project specified. Emails MUST contain the 'Project' keyword:
105 86 Go MAEDA
  rdm-mailhandler.rb --url http://redmine.domain.foo --key secret
106 5 Jean-Philippe Lang
  
107 5 Jean-Philippe Lang
  # Fixed project and default tracker specified, but emails can override
108 5 Jean-Philippe Lang
  # both tracker and priority attributes:
109 86 Go MAEDA
  rdm-mailhandler.rb --url https://domain.foo/redmine --key secret \\
110 86 Go MAEDA
                     --project foo \\
111 86 Go MAEDA
                     --tracker bug \\
112 86 Go MAEDA
                     --allow-override tracker,priority
113 1 Jean-Philippe Lang
</pre>
114 54 Art Kuo
115 55 Art Kuo
Here is an example for a Postfix local alias entry:
116 35 Justin Clarke
117 35 Justin Clarke
<pre>
118 35 Justin Clarke
foo: "|/path/to/rdm-mailhandler.rb --url http://redmine.domain --key secret --project foo"
119 36 Justin Clarke
</pre>
120 35 Justin Clarke
121 36 Justin Clarke
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.
122 35 Justin Clarke
123 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:
124 1 Jean-Philippe Lang
125 75 Baz T.Miner
* create a mapping in @/etc/virtual@ like: @ foo@example.org foo@
126 34 Thomas Guyot-Sionnest
* modify @/etc/postfix/main.cf@ to specify a transport file: @transport_maps = hash:/etc/postfix/transport@
127 1 Jean-Philippe Lang
* within the transport file add a line like: @ foo@example.org local:@
128 1 Jean-Philippe Lang
129 20 Kurt Miebach
*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.
130 1 Jean-Philippe Lang
131 68 Denis Savitskiy
h3. Fetching emails from an IMAP server
132 20 Kurt Miebach
133 33 Jürgen Hörmann
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:
134 33 Jürgen Hörmann
135 68 Denis Savitskiy
<pre>
136 33 Jürgen Hörmann
*/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 
137 68 Denis Savitskiy
</pre>
138 33 Jürgen Hörmann
139 22 Kurt Miebach
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.
140 20 Kurt Miebach
141 25 Roland ...
<pre>
142 20 Kurt Miebach
*/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 
143 6 Jean-Philippe Lang
</pre>
144 1 Jean-Philippe Lang
145 6 Jean-Philippe Lang
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. 
146 20 Kurt Miebach
147 6 Jean-Philippe Lang
For Windows as server "pycron":http://www.kalab.com/freeware/pycron/pycron.htm can be used to schedule a fetch task.
148 6 Jean-Philippe Lang
149 6 Jean-Philippe Lang
It can be necessary that you open the firewall on the machine for outgoing TCP connections to IMAP port 143.
150 72 Sebastian Paluch
151 1 Jean-Philippe Lang
Available IMAP options:
152 6 Jean-Philippe Lang
<pre>
153 1 Jean-Philippe Lang
  host=HOST                IMAP server host (default: 127.0.0.1)
154 29 Jean-Philippe Lang
  port=PORT                IMAP server port (default: 143)
155 29 Jean-Philippe Lang
  ssl=SSL                  Use SSL? (default: false)
156 29 Jean-Philippe Lang
  starttls=STARTTLS        Use STARTTLS? (default: false)
157 1 Jean-Philippe Lang
  username=USERNAME        IMAP account
158 29 Jean-Philippe Lang
  password=PASSWORD        IMAP password
159 1 Jean-Philippe Lang
  folder=FOLDER            IMAP folder to read (default: INBOX)
160 20 Kurt Miebach
  move_on_success=MAILBOX  move emails that were successfully received
161 6 Jean-Philippe Lang
                           to MAILBOX instead of deleting them
162 6 Jean-Philippe Lang
  move_on_failure=MAILBOX  move emails that were ignored to MAILBOX
163 6 Jean-Philippe Lang
</pre>
164 6 Jean-Philippe Lang
165 88 Go MAEDA
User and permissions options:
166 88 Go MAEDA
<pre>
167 88 Go MAEDA
  unknown_user=ACTION      how to handle emails from an unknown user
168 88 Go MAEDA
                           ACTION can be one of the following values:
169 88 Go MAEDA
                           ignore: email is ignored (default)
170 88 Go MAEDA
                           accept: accept as anonymous user
171 88 Go MAEDA
                           create: create a user account
172 88 Go MAEDA
  no_permission_check=1    disable permission checking when receiving
173 88 Go MAEDA
                           the email
174 88 Go MAEDA
  no_account_notice=1      disable new user account notification
175 88 Go MAEDA
  default_group=foo,bar    adds created user to foo and bar groups
176 88 Go MAEDA
</pre>
177 88 Go MAEDA
178 18 Eric Davis
Issue attributes control options:
179 18 Eric Davis
<pre>
180 18 Eric Davis
  project=PROJECT          identifier of the target project
181 88 Go MAEDA
  project_from_subaddress=ADDR
182 88 Go MAEDA
                           select project from subaddress of ADDR found
183 88 Go MAEDA
                           in To, Cc, Bcc headers
184 88 Go MAEDA
  status=STATUS            name of the target status
185 53 Jean-Philippe Lang
  tracker=TRACKER          name of the target tracker
186 1 Jean-Philippe Lang
  category=CATEGORY        name of the target category
187 1 Jean-Philippe Lang
  priority=PRIORITY        name of the target priority
188 88 Go MAEDA
  assigned_to=ASSIGNEE     assignee (username or group name)
189 88 Go MAEDA
  fixed_version=VERSION    name of the target version
190 88 Go MAEDA
  private                  create new issues as private
191 88 Go MAEDA
  allow_override=ATTRS     allow email content to set attributes values
192 20 Kurt Miebach
                           ATTRS is a comma separated list of attributes
193 88 Go MAEDA
                           or 'all' to allow all attributes to be overridable
194 6 Jean-Philippe Lang
</pre>
195 6 Jean-Philippe Lang
196 6 Jean-Philippe Lang
See [[RedmineReceivingEmails#Issue-attributes|Issue-attributes]] for a list of values that can be used for the @allow-override@ option.
197 11 Thomas Lecavelier
198 6 Jean-Philippe Lang
Examples for the rake command:
199 1 Jean-Philippe Lang
200 1 Jean-Philippe Lang
<pre>
201 6 Jean-Philippe Lang
  # No project specified. Emails MUST contain the 'Project' keyword:
202 6 Jean-Philippe Lang
  
203 6 Jean-Philippe Lang
  rake redmine:email:receive_imap RAILS_ENV="production" \\
204 11 Thomas Lecavelier
    host=imap.foo.bar username=redmine@somenet.foo password=xxx
205 6 Jean-Philippe Lang
206 6 Jean-Philippe Lang
207 6 Jean-Philippe Lang
  # Fixed project and default tracker specified, but emails can override
208 6 Jean-Philippe Lang
  # both tracker and priority attributes:
209 18 Eric Davis
  
210 18 Eric Davis
  rake redmine:email:receive_imap RAILS_ENV="production" \\
211 18 Eric Davis
    host=imap.foo.bar username=redmine@somenet.foo password=xxx ssl=1 \\
212 18 Eric Davis
    project=foo \\
213 1 Jean-Philippe Lang
    tracker=bug \\
214 1 Jean-Philippe Lang
    allow_override=tracker,priority
215 1 Jean-Philippe Lang
216 1 Jean-Philippe Lang
  # Move successful emails to the 'read' mailbox and failed emails to
217 1 Jean-Philippe Lang
  # the 'failed' mailbox
218 1 Jean-Philippe Lang
  
219 1 Jean-Philippe Lang
  rake redmine:email:receive_imap RAILS_ENV="production" \\
220 37 Benjamin Haskell
    host=imap.foo.bar username=redmine@somenet.foo password=xxx \\
221 1 Jean-Philippe Lang
    move_on_success=read move_on_failure=failed
222 45 Mischa The Evil
223 29 Jean-Philippe Lang
</pre>
224 29 Jean-Philippe Lang
225 29 Jean-Philippe Lang
226 29 Jean-Philippe Lang
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.
227 29 Jean-Philippe Lang
228 29 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 a parameter.
229 29 Jean-Philippe Lang
230 29 Jean-Philippe Lang
h3. Fetching emails from a POP3 server
231 29 Jean-Philippe Lang
232 29 Jean-Philippe Lang
A rake task (@redmine:email:receive_pop3@) can be used to fetch incoming emails from a POP3 server.
233 29 Jean-Philippe Lang
234 29 Jean-Philippe Lang
Available POP3 options:
235 29 Jean-Philippe Lang
<pre>
236 29 Jean-Philippe Lang
  host=HOST                POP3 server host (default: 127.0.0.1)
237 29 Jean-Philippe Lang
  port=PORT                POP3 server port (default: 110)
238 29 Jean-Philippe Lang
  username=USERNAME        POP3 account
239 29 Jean-Philippe Lang
  password=PASSWORD        POP3 password
240 29 Jean-Philippe Lang
  apop=1                   use APOP authentication (default: false)
241 23 Roland ...
  delete_unprocessed=1     delete messages that could not be processed
242 1 Jean-Philippe Lang
                           successfully from the server (default
243 1 Jean-Philippe Lang
                           behaviour is to leave them on the server)
244 1 Jean-Philippe Lang
</pre>
245 1 Jean-Philippe Lang
246 89 Go MAEDA
See the [[RedmineReceivingEmails#Fetching-emails-from-an-IMAP-server|IMAP rake task]] above for issue attributes control options.
247 6 Jean-Philippe Lang
248 6 Jean-Philippe Lang
h3. Reading emails from standard input
249 6 Jean-Philippe Lang
250 6 Jean-Philippe Lang
A rake task (@redmine:email:receive@) can be used to read a single raw email from the standard input.
251 6 Jean-Philippe Lang
252 89 Go MAEDA
See the [[RedmineReceivingEmails#Fetching-emails-from-an-IMAP-server|IMAP rake task]] above for issue attributes control options.
253 1 Jean-Philippe Lang
254 6 Jean-Philippe Lang
Examples:
255 6 Jean-Philippe Lang
256 6 Jean-Philippe Lang
<pre>
257 6 Jean-Philippe Lang
  # No project specified. Emails MUST contain the 'Project' keyword:
258 6 Jean-Philippe Lang
  rake redmine:email:read RAILS_ENV="production" < raw_email
259 6 Jean-Philippe Lang
260 6 Jean-Philippe Lang
  # Fixed project and default tracker specified, but emails can override
261 23 Roland ...
  # both tracker and priority attributes:
262 45 Mischa The Evil
  rake redmine:email:read RAILS_ENV="production" \\
263 1 Jean-Philippe Lang
                  project=foo \\
264 44 Mischa The Evil
                  tracker=bug \\
265 1 Jean-Philippe Lang
                  allow_override=tracker,priority < raw_email
266 44 Mischa The Evil
</pre>
267 1 Jean-Philippe Lang
268 61 Jean-Baptiste Barth
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.
269 44 Mischa The Evil
270 44 Mischa The Evil
h3. Enabling unknown users to create issues by email
271 44 Mischa The Evil
272 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:
273 1 Jean-Philippe Lang
<pre>
274 44 Mischa The Evil
unknown_user=ACTION     how to handle emails from an unknown user where ACTION can be one of the following values:
275 44 Mischa The Evil
                        ignore: the email is ignored (default)
276 60 Philipp erpel
                        accept: the sender is considered as an anonymous user and the email is accepted
277 60 Philipp erpel
                        create: a user account is created for the sender (username/password are sent back to the user) and the email is accepted
278 60 Philipp erpel
</pre>
279 60 Philipp erpel
280 60 Philipp erpel
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.
281 45 Mischa The Evil
282 44 Mischa The Evil
If you receive emails via the rake task, the unknown-user option has to be written as:
283 1 Jean-Philippe Lang
<pre>
284 1 Jean-Philippe Lang
 unknown_user=[ignore|accept|create]
285 1 Jean-Philippe Lang
</pre>
286 57 Antoine Beaupré
287 44 Mischa The Evil
You can disable permission checking using the 'no_permission_check' option:
288 57 Antoine Beaupré
<pre>
289 44 Mischa The Evil
no_permission_check=1   disable permission checking when receiving the email
290 44 Mischa The Evil
</pre>
291 44 Mischa The Evil
292 44 Mischa The Evil
This, together with the 'unknown-user', provides the ability to let anyone submit emails to a private project. For example:
293 45 Mischa The Evil
<pre>
294 86 Go MAEDA
rdm-mailhandler.rb --unknown-user accept --no-permission-check --project=foo
295 1 Jean-Philippe Lang
</pre>
296 58 Terence Mill
297 58 Terence Mill
will let anyone submit emails to a private project 'foo'.
298 58 Terence Mill
299 58 Terence Mill
TODO: Is this true and is this related to the @no_permission_check@ option?:
300 58 Terence Mill
> 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.
301 70 Pierre Maigne
302 70 Pierre Maigne
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:
303 70 Pierre Maigne
<pre>
304 86 Go MAEDA
rdm-mailhandler.rb --unknown-user accept --no-permission-check --project=foo --no-account-notice
305 70 Pierre Maigne
</pre>
306 70 Pierre Maigne
307 70 Pierre Maigne
h3. Schedule email receiving with Rufus Scheduler
308 70 Pierre Maigne
309 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.
310 84 Go MAEDA
This is using less resources and faster than calling the Rake task from a cron (or from the Task Scheduler on Windows).
311 70 Pierre Maigne
312 70 Pierre Maigne
To do that, install rufus-scheduler gem:
313 70 Pierre Maigne
<pre>gem install rufus-scheduler</pre>
314 70 Pierre Maigne
315 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.)
316 70 Pierre Maigne
<pre>
317 70 Pierre Maigne
require 'rubygems'
318 70 Pierre Maigne
require 'rake'
319 70 Pierre Maigne
require 'rufus-scheduler'
320 70 Pierre Maigne
321 70 Pierre Maigne
load File.join(Rails.root, 'Rakefile')
322 70 Pierre Maigne
323 70 Pierre Maigne
ENV['host']='pop.toto.com'
324 70 Pierre Maigne
ENV['port']='110'
325 70 Pierre Maigne
ENV['ssl']='SSL'
326 70 Pierre Maigne
ENV['username']='redmine@toto.com'
327 70 Pierre Maigne
ENV['password']='azerty123456'
328 70 Pierre Maigne
329 70 Pierre Maigne
scheduler = Rufus::Scheduler.new
330 70 Pierre Maigne
# Check emails every 10 mins
331 70 Pierre Maigne
scheduler.interval '10m' do
332 70 Pierre Maigne
  task = Rake.application['redmine:email:receive_pop3']
333 70 Pierre Maigne
  task.reenable
334 70 Pierre Maigne
  task.invoke 
335 70 Pierre Maigne
end
336 1 Jean-Philippe Lang
</pre>
337 1 Jean-Philippe Lang
338 12 Eric Davis
Restart your Redmine instance and your incoming emails will be retrieved on schedule.
339 1 Jean-Philippe Lang
340 1 Jean-Philippe Lang
You can check "Rufus-Scheduler":https://github.com/jmettraux/rufus-scheduler for scheduling syntax.
341 3 Jean-Philippe Lang
342 43 Mischa The Evil
h2. How it works
343 38 Dave Thomas
344 15 Jean-Philippe Lang
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.
345 15 Jean-Philippe Lang
346 79 Go MAEDA
If the email subject contains something like "Re: *[xxxxxxx !#123]*" or "[!#123]", the email is processed as a reply and a note is added to issue !#123. Otherwise, a new issue is created.
347 1 Jean-Philippe Lang
348 16 Jean-Philippe Lang
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.
349 16 Jean-Philippe Lang
350 1 Jean-Philippe Lang
h3. Target project
351 1 Jean-Philippe Lang
352 84 Go MAEDA
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.
353 28 Ethan Fremen
354 28 Ethan Fremen
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"@.
355 1 Jean-Philippe Lang
356 1 Jean-Philippe Lang
Example (email body):
357 1 Jean-Philippe Lang
358 1 Jean-Philippe Lang
<pre>
359 1 Jean-Philippe Lang
This is a new issue that will be added to project foo.
360 16 Jean-Philippe Lang
Here we have the issue description
361 16 Jean-Philippe Lang
[...]
362 16 Jean-Philippe Lang
363 16 Jean-Philippe Lang
Project: foo
364 16 Jean-Philippe Lang
</pre>
365 16 Jean-Philippe Lang
366 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.
367 16 Jean-Philippe Lang
Example:
368 14 Jean-Philippe Lang
369 1 Jean-Philippe Lang
<pre>
370 75 Baz T.Miner
  # Create issues on project foo by default
371 75 Baz T.Miner
  rake redmine:email:receive_imap [...] project=foo allow_override=project
372 75 Baz T.Miner
</pre>
373 75 Baz T.Miner
374 75 Baz T.Miner
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.
375 75 Baz T.Miner
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.
376 75 Baz T.Miner
377 1 Jean-Philippe Lang
h3. Target Project from Email Sub-Address
378 75 Baz T.Miner
379 87 Go MAEDA
This feature was introduced in ver 3.2.0 (SVN rev r14687). It may be preferable to have one mailbox for all incoming emails to a Redmine instance, instead of one per project. When receiving emails at redmine@somenet.foo, an email sent to redmine+foo@somenet.foo will cause the issue to be added to project with identifier foo.
380 75 Baz T.Miner
381 75 Baz T.Miner
To enable this feature add the @project_from_subaddress=redmine@somenet.foo@ to the command e.g.
382 75 Baz T.Miner
383 75 Baz T.Miner
<pre>
384 75 Baz T.Miner
    rake redmine:email:receive_imap [...] project_from_subaddress=redmine@somenet.foo
385 75 Baz T.Miner
</pre> 
386 75 Baz T.Miner
387 75 Baz T.Miner
If a project is included in the command-line then it becomes the default project that will be used for emails sent to @redmine@somenet.foo@. So with the command:
388 75 Baz T.Miner
389 75 Baz T.Miner
<pre>
390 15 Jean-Philippe Lang
    rake redmine:email:receive_imap [...] project=bar project_from_subaddress=redmine@somenet.foo
391 15 Jean-Philippe Lang
</pre> 
392 8 Jean-Philippe Lang
393 74 Deoren Moor
emails to @redmine@somenet.foo@ or @redmine+bar@somenet.foo@ will raise issues in project bar; emails to @redmine+foo@somenet.foo@ will go into project foo.
394 74 Deoren Moor
395 74 Deoren Moor
Some email providers include support for sub-addresses, as per RFCs 3598, 5233. Where this is not supported, forwarding mail addresses to the 'central' address, may work (it does in my case), ie set up an email address forwarding all mails to @redmine@somenet.foo@ from @redmine+foo@somenet.foo@, @redmine+bar@somenet.foo@ etc. This is easy to administer and does not require fetching emails from multiple accounts, each with its own account credentials.
396 74 Deoren Moor
397 74 Deoren Moor
h3. Issue attributes
398 1 Jean-Philippe Lang
399 66 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. 
400 66 Deoren Moor
401 66 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).
402 66 Deoren Moor
403 66 Deoren Moor
Once @allow_override@ has been configured, you can override those attributes by using the appropriate keywords in the email body.
404 1 Jean-Philippe Lang
405 1 Jean-Philippe Lang
Example keyword list:
406 69 Denis Savitskiy
407 69 Denis Savitskiy
* @Project@
408 69 Denis Savitskiy
* @Tracker@
409 80 Sören Weber
* @Status@
410 73 Mathieu Janson
* @Category@
411 1 Jean-Philippe Lang
* @Priority@
412 80 Sören Weber
* @Assigned to@
413 66 Deoren Moor
* @Start date@
414 71 Toshi MARUYAMA
* @Due date@
415 66 Deoren Moor
* @Target version@
416 8 Jean-Philippe Lang
* @Estimated hours@
417 8 Jean-Philippe Lang
* @Done ratio@
418 28 Ethan Fremen
* @<Custom field name>@
419 8 Jean-Philippe Lang
420 8 Jean-Philippe Lang
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).
421 8 Jean-Philippe Lang
422 1 Jean-Philippe Lang
Example (email body):
423 8 Jean-Philippe Lang
424 1 Jean-Philippe Lang
<pre>
425 1 Jean-Philippe Lang
This is a new issue that overrides a few attributes
426 1 Jean-Philippe Lang
[...]
427 1 Jean-Philippe Lang
428 66 Deoren Moor
Project: foo
429 66 Deoren Moor
Tracker: Bug
430 66 Deoren Moor
Priority: Urgent
431 66 Deoren Moor
Status: Resolved
432 66 Deoren Moor
</pre>
433 66 Deoren Moor
434 66 Deoren Moor
The format for keywords differs from the allowed attribute values for the @allow_override@ option:
435 66 Deoren Moor
436 66 Deoren Moor
* @project@
437 66 Deoren Moor
* @tracker@
438 1 Jean-Philippe Lang
* @status@
439 66 Deoren Moor
* @category@
440 80 Sören Weber
* @priority@
441 1 Jean-Philippe Lang
* @assigned_to@
442 66 Deoren Moor
* @start_date@
443 66 Deoren Moor
* @due_date@
444 80 Sören Weber
* @fixed_version@ (aka. Target version)
445 66 Deoren Moor
* @estimated_hours@
446 66 Deoren Moor
* @done_ratio@
447 80 Sören Weber
* @<custom_field_name>@
448 66 Deoren Moor
449 66 Deoren Moor
Multiple attribute values can be specified in order to allow only certain keywords to be used.
450 66 Deoren Moor
451 49 Jean-Philippe Lang
Example:
452 1 Jean-Philippe Lang
453 1 Jean-Philippe Lang
<pre>
454 1 Jean-Philippe Lang
  # Allow overriding project, tracker, status & priority
455 16 Jean-Philippe Lang
  rake redmine:email:receive_imap [...] allow_override=project,tracker,status,priority
456 42 Mischa The Evil
</pre>
457 41 Miguel Filho
458 16 Jean-Philippe Lang
h3. Watchers
459 16 Jean-Philippe Lang
460 16 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.
461 16 Jean-Philippe Lang
462 1 Jean-Philippe Lang
Watchers are added only when the issue is created. To or Cc fields are ignored on replies. See #7017 and #8009.
463 55 Art Kuo
464 55 Art Kuo
h3. Email format and attachments
465 55 Art Kuo
466 1 Jean-Philippe Lang
Redmine tries to use the plain text part of the email to fill the description of the issue.
467 65 Toshi MARUYAMA
If a HTML-only email is received, HTML tags are removed from its body.
468 1 Jean-Philippe Lang
469 1 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.
470 1 Jean-Philippe Lang
471 1 Jean-Philippe Lang
h3. Truncate emails
472 1 Jean-Philippe Lang
473 1 Jean-Philippe Lang
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)
474 87 Go MAEDA
475 87 Go MAEDA
h2. See also
476 87 Go MAEDA
477 87 Go MAEDA
* [[MailhandlerSubAddress|Mailhandler Frontend for SubAddressing]]: How to implement sub-addressing in Redmine <3.2