RedmineReceivingEmails » History » Version 18

Eric Davis, 2009-01-12 05:02
Added documentation for moving emails in IMAP from r2220

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 7 Jean-Philippe Lang
* Fetching emails from an IMAP 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 4 Jean-Philippe Lang
Copy @rdm-mailhandler.rb@ to your mail server 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 1 Jean-Philippe Lang
A rake task (@redmine:email:receive_imap@) can be used to fetch incoming emails from an IMAP server.
84 1 Jean-Philippe Lang
85 6 Jean-Philippe Lang
<pre>
86 6 Jean-Philippe Lang
Available IMAP options:
87 6 Jean-Philippe Lang
  host=HOST                IMAP server host (default: 127.0.0.1)
88 6 Jean-Philippe Lang
  port=PORT                IMAP server port (default: 143)
89 6 Jean-Philippe Lang
  ssl=SSL                  Use SSL? (default: false)
90 6 Jean-Philippe Lang
  username=USERNAME        IMAP account
91 6 Jean-Philippe Lang
  password=PASSWORD        IMAP password
92 6 Jean-Philippe Lang
  folder=FOLDER            IMAP folder to read (default: INBOX)
93 1 Jean-Philippe Lang
94 6 Jean-Philippe Lang
Issue attributes control options:
95 6 Jean-Philippe Lang
  project=PROJECT          identifier of the target project
96 6 Jean-Philippe Lang
  tracker=TRACKER          name of the target tracker
97 6 Jean-Philippe Lang
  category=CATEGORY        name of the target category
98 6 Jean-Philippe Lang
  priority=PRIORITY        name of the target priority
99 6 Jean-Philippe Lang
  allow_override=ATTRS     allow email content to override attributes
100 6 Jean-Philippe Lang
                           specified by previous options
101 6 Jean-Philippe Lang
                           ATTRS is a comma separated list of attributes
102 6 Jean-Philippe Lang
  
103 6 Jean-Philippe Lang
</pre>
104 1 Jean-Philippe Lang
105 18 Eric Davis
These options are available on trunk or the upcoming 0.8.1
106 18 Eric Davis
107 18 Eric Davis
<pre>
108 18 Eric Davis
  move_on_success=MAILBOX  move emails that were successfully received
109 18 Eric Davis
                           to MAILBOX instead of deleting them
110 18 Eric Davis
  move_on_failure=MAILBOX  move emails that were ignored to MAILBOX
111 18 Eric Davis
</pre>
112 18 Eric Davis
113 6 Jean-Philippe Lang
Examples:
114 1 Jean-Philippe Lang
115 6 Jean-Philippe Lang
<pre>
116 6 Jean-Philippe Lang
  # No project specified. Emails MUST contain the 'Project' keyword:
117 6 Jean-Philippe Lang
  
118 11 Thomas Lecavelier
  rake redmine:email:receive_imap RAILS_ENV="production" \\
119 6 Jean-Philippe Lang
    host=imap.foo.bar username=redmine@somenet.foo password=xxx
120 1 Jean-Philippe Lang
121 1 Jean-Philippe Lang
122 6 Jean-Philippe Lang
  # Fixed project and default tracker specified, but emails can override
123 6 Jean-Philippe Lang
  # both tracker and priority attributes:
124 6 Jean-Philippe Lang
  
125 11 Thomas Lecavelier
  rake redmine:email:receive_imap RAILS_ENV="production" \\
126 6 Jean-Philippe Lang
    host=imap.foo.bar username=redmine@somenet.foo password=xxx ssl=1 \\
127 6 Jean-Philippe Lang
    project=foo \\
128 6 Jean-Philippe Lang
    tracker=bug \\
129 6 Jean-Philippe Lang
    allow_override=tracker,priority
130 18 Eric Davis
131 18 Eric Davis
  # Move successful emails to the 'read' mailbox and failed emails to
132 18 Eric Davis
  # the 'failed' mailbox
133 18 Eric Davis
  
134 18 Eric Davis
  rake redmine:email:receive_imap RAILS_ENV="production" \\
135 18 Eric Davis
    host=imap.foo.bar username=redmine@somenet.foo password=xxx \\
136 18 Eric Davis
    move_on_success=read move_on_failure=failed
137 18 Eric Davis
138 1 Jean-Philippe Lang
</pre>
139 1 Jean-Philippe Lang
140 6 Jean-Philippe Lang
141 1 Jean-Philippe Lang
Emails that are ignored (unknown user, unknown project...) are marked as 'Seen' but are not deleted from the IMAP server.
142 1 Jean-Philippe Lang
143 1 Jean-Philippe Lang
h3. Reading emails from standard input
144 1 Jean-Philippe Lang
145 1 Jean-Philippe Lang
A rake task (@redmine:email:receive@) can be used to read a single raw email from the standard input.
146 1 Jean-Philippe Lang
147 6 Jean-Philippe Lang
<pre>
148 6 Jean-Philippe Lang
Issue attributes control options:
149 6 Jean-Philippe Lang
  project=PROJECT          identifier of the target project
150 6 Jean-Philippe Lang
  tracker=TRACKER          name of the target tracker
151 6 Jean-Philippe Lang
  category=CATEGORY        name of the target category
152 6 Jean-Philippe Lang
  priority=PRIORITY        name of the target priority
153 6 Jean-Philippe Lang
  allow_override=ATTRS     allow email content to override attributes
154 6 Jean-Philippe Lang
                           specified by previous options
155 6 Jean-Philippe Lang
                           ATTRS is a comma separated list of attributes
156 6 Jean-Philippe Lang
</pre>
157 1 Jean-Philippe Lang
158 6 Jean-Philippe Lang
Examples:
159 1 Jean-Philippe Lang
160 6 Jean-Philippe Lang
<pre>
161 6 Jean-Philippe Lang
  # No project specified. Emails MUST contain the 'Project' keyword:
162 6 Jean-Philippe Lang
  rake redmine:email:read RAILS_ENV="production" < raw_email
163 1 Jean-Philippe Lang
164 6 Jean-Philippe Lang
  # Fixed project and default tracker specified, but emails can override
165 6 Jean-Philippe Lang
  # both tracker and priority attributes:
166 6 Jean-Philippe Lang
  rake redmine:email:read RAILS_ENV="production" \\
167 6 Jean-Philippe Lang
                  project=foo \\
168 6 Jean-Philippe Lang
                  tracker=bug \\
169 6 Jean-Philippe Lang
                  allow_override=tracker,priority < raw_email
170 6 Jean-Philippe Lang
</pre>
171 1 Jean-Philippe Lang
172 1 Jean-Philippe Lang
173 1 Jean-Philippe Lang
h2. How it works
174 1 Jean-Philippe Lang
175 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.
176 1 Jean-Philippe Lang
177 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.
178 3 Jean-Philippe Lang
179 15 Jean-Philippe Lang
h3. Target project
180 15 Jean-Philippe Lang
181 16 Jean-Philippe Lang
The target project can be specified using the @project@ option when receiving emails.
182 1 Jean-Philippe Lang
183 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"@.
184 16 Jean-Philippe Lang
185 1 Jean-Philippe Lang
Example (email body):
186 1 Jean-Philippe Lang
187 1 Jean-Philippe Lang
<pre>
188 1 Jean-Philippe Lang
This is a new ticket that will be added to project foo.
189 1 Jean-Philippe Lang
Here we have the ticket description
190 1 Jean-Philippe Lang
[...]
191 1 Jean-Philippe Lang
192 1 Jean-Philippe Lang
Project: foo
193 1 Jean-Philippe Lang
</pre>
194 1 Jean-Philippe Lang
195 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.
196 16 Jean-Philippe Lang
Example:
197 16 Jean-Philippe Lang
198 16 Jean-Philippe Lang
<pre>
199 16 Jean-Philippe Lang
  # Create issues on project foo by default
200 16 Jean-Philippe Lang
  rake redmine:email:receive_imap [...] project=foo allow_override=project
201 16 Jean-Philippe Lang
</pre>
202 16 Jean-Philippe Lang
203 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.
204 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.
205 15 Jean-Philippe Lang
206 15 Jean-Philippe Lang
h3. Issue attributes
207 8 Jean-Philippe Lang
208 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.
209 12 Eric Davis
This can be done by using the following keywords in the email body (just like @Project@): @Tracker@, @Category@, @Priority@, @Status@.
210 8 Jean-Philippe Lang
211 16 Jean-Philippe Lang
Example (email body):
212 8 Jean-Philippe Lang
213 8 Jean-Philippe Lang
<pre>
214 8 Jean-Philippe Lang
This is a new ticket that overrides a few attributes
215 8 Jean-Philippe Lang
[...]
216 8 Jean-Philippe Lang
217 8 Jean-Philippe Lang
Project: foo
218 1 Jean-Philippe Lang
Tracker: Bug
219 8 Jean-Philippe Lang
Priority: Urgent
220 12 Eric Davis
Status: Resolved
221 8 Jean-Philippe Lang
</pre>
222 15 Jean-Philippe Lang
223 1 Jean-Philippe Lang
h3. Watchers
224 1 Jean-Philippe Lang
225 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.
226 16 Jean-Philippe Lang
227 16 Jean-Philippe Lang
h3. Email format and attachments
228 16 Jean-Philippe Lang
229 16 Jean-Philippe Lang
Redmine tries to use the plain text part of the email to fill the description of the issue.
230 16 Jean-Philippe Lang
If a HTML-only email is received, HTML tags are removed from its body.
231 16 Jean-Philippe Lang
232 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.