RedmineReceivingEmails » History » Revision 26
« Previous |
Revision 26/93
(diff)
| Next »
Ian Smith-Heisters, 2009-08-01 20:50
Receiving emails¶
- Table of contents
- Receiving emails
As of 0.8.0, Redmine can be configured to allow issue creation or comments via email.
Setup¶
You can configure Redmine to receive emails in one of the following ways:
- Forwarding emails from your email server:
- Pros: works with a remote mail server, email are processed instantly, fast (no environment reloading)
- Cons: needs some configuration on your mail transfer agent (eg. Postfix, Sendmail...)
- Fetching emails from an IMAP server:
- Pros: easy to setup, no need to configure your MTA, works with a remote mail server
- Cons: emails are not processed instantly (a cron job needs to be added to read emails periodically)
- Reading emails from standard input:
- Pros: fine for testing purpose
- Cons: slow (the environment is reloaded each time an email is read), needs some configuration on your MTA
Forwarding emails from your email server¶
A standalone script can be used to forward incoming emails from your mail server.
This script reads a raw email from the standard input and forward it to Redmine via a HTTP request.
It can be found in your redmine directory: extra/mail_handler/rdm-mailhandler.rb
.
In order to use it, you have to enable the API that receive emails:
Go to Application settings -> Incoming emails, check Enable WS for incoming emails and enter or generate a secret key.
Copy rdm-mailhandler.rb
to your mail server, make sure its permissions allow execution, and configure your MTA.
Usage:
rdm-mailhandler [options] --url=<Redmine URL> --key=<API key> Required: -u, --url URL of the Redmine server -k, --key Redmine API key General options: -h, --help show this help -v, --verbose show extra information -V, --version show version information and exit Issue attributes control options: -p, --project=PROJECT identifier of the target project -t, --tracker=TRACKER name of the target tracker --category=CATEGORY name of the target category --priority=PRIORITY name of the target priority -o, --allow-override=ATTRS allow email content to override attributes specified by previous options ATTRS is a comma separated list of attributes
Examples:
# No project specified. Emails MUST contain the 'Project' keyword: rdm-mailhandler --url http://redmine.domain.foo --key secret # Fixed project and default tracker specified, but emails can override # both tracker and priority attributes: rdm-mailhandler --url https://domain.foo/redmine --key secret \\ --project foo \\ --tracker bug \\ --allow-override tracker,priority
Here is an example for a Postfix alias:
foo: "|/path/to/rdm-mailhandler.rb --url http://redmine.domain --key secret --project foo"
Fetching emails from an IMAP server¶
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:
*/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
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.
For Windows as server pycron can be used to schedule a fetch task.
It can be necessary that you open the firewall on the machine for outgoing TCP connections to IMAP port 143.
Available IMAP options:
host=HOST IMAP server host (default: 127.0.0.1) port=PORT IMAP server port (default: 143) ssl=SSL Use SSL? (default: false) username=USERNAME IMAP account password=PASSWORD IMAP password folder=FOLDER IMAP folder to read (default: INBOX)
Issue attributes control options:
project=PROJECT identifier of the target project tracker=TRACKER name of the target tracker category=CATEGORY name of the target category priority=PRIORITY name of the target priority allow_override=ATTRS allow email content to override attributes specified by previous options ATTRS is a comma separated list of attributes
These options are available on trunk or the upcoming 0.8.1
move_on_success=MAILBOX move emails that were successfully received to MAILBOX instead of deleting them move_on_failure=MAILBOX move emails that were ignored to MAILBOX
Examples for the rake command:
# No project specified. Emails MUST contain the 'Project' keyword: rake redmine:email:receive_imap RAILS_ENV="production" \\ host=imap.foo.bar username=redmine@somenet.foo password=xxx # Fixed project and default tracker specified, but emails can override # both tracker and priority attributes: rake redmine:email:receive_imap RAILS_ENV="production" \\ host=imap.foo.bar username=redmine@somenet.foo password=xxx ssl=1 \\ project=foo \\ tracker=bug \\ allow_override=tracker,priority # Move successful emails to the 'read' mailbox and failed emails to # the 'failed' mailbox rake redmine:email:receive_imap RAILS_ENV="production" \\ host=imap.foo.bar username=redmine@somenet.foo password=xxx \\ move_on_success=read move_on_failure=failed
Emails that are ignored (unknown user, unknown project...) are marked as 'Seen' but are not deleted from the IMAP server.
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.
Reading emails from standard input¶
A rake task (redmine:email:receive
) can be used to read a single raw email from the standard input.
Issue attributes control options: project=PROJECT identifier of the target project tracker=TRACKER name of the target tracker category=CATEGORY name of the target category priority=PRIORITY name of the target priority allow_override=ATTRS allow email content to override attributes specified by previous options ATTRS is a comma separated list of attributes
Examples:
# No project specified. Emails MUST contain the 'Project' keyword: rake redmine:email:read RAILS_ENV="production" < raw_email # Fixed project and default tracker specified, but emails can override # both tracker and priority attributes: rake redmine:email:read RAILS_ENV="production" \\ project=foo \\ tracker=bug \\ allow_override=tracker,priority < raw_email
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.
How it works¶
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.
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.
Target project¶
The target project can be specified using the project
option when receiving emails.
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"
.
Example (email body):
This is a new ticket that will be added to project foo. Here we have the ticket description [...] Project: foo
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.
Example:
# Create issues on project foo by default rake redmine:email:receive_imap [...] project=foo allow_override=project
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.
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.
Issue attributes¶
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.
This can be done by using the following keywords in the email body (just like Project
): Tracker
, Category
, Priority
, Status
.
Example (email body):
This is a new ticket that overrides a few attributes [...] Project: foo Tracker: Bug Priority: Urgent Status: Resolved
Watchers¶
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.
Email format and attachments¶
Redmine tries to use the plain text part of the email to fill the description of the issue.
If a HTML-only email is received, HTML tags are removed from its body.
Email attachments are automatically attached to the issue, unless their size exceeds the maximum attachment size defined in the application settings.
Updated by Ian Smith-Heisters about 15 years ago · 26 revisions