OpenProject is able to receive incoming emails and create and update work packages and reply in forums depending on the content of the email. If you’re using the Enterprise cloud you can skip the Setup section, as the settings are already configured.
Receiving emails is done via a rake task that fetches emails from an email server, parses them and performs actions depending on the content of the email. This rake task can be executed manually or automatically, e.g. with the help of a Cron job.
The rake task
redmine:email:receive_imap fetches emails via IMAP and parses them.
openproject run bundle exec rake redmine:email:receive_imap host='imap.gmail.com' username='test_user' password='password' port=993 ssl=true allow_override=type,project project=test_project
The docker installation has a “cron-like” daemon that will imitate the above cron job. You need to specify the following ENV variables (e.g., to your env list file)
IMAP_SSLset to true or false depending on whether the ActionMailer IMAP connection requires implicit TLS/SSL
IMAP_HOSTset to the IMAP host and port of your connection
Optional ENV variables:
IMAP_CHECK_INTERVAL=600Interval in seconds to check for new mails (defaults to 10minutes)
IMAP_ALLOW_OVERRIDEAttributes writable (true for all), comma-separated list as specified in
Available arguments for this rake task that specify the email behavior are
| ||address of the email server|
| ||the name of the user that is used to connect to the email server|
| ||the password of the user|
| ||the port that is used to connect to the email server|
| ||specifies if SSL should be used when connecting to the email server|
| ||the folder to fetch emails from (default: INBOX)|
| ||the folder emails that were successfully parsed are moved to (instead of deleted)|
| ||the folder emails that were ignored are moved to|
Available arguments that change how the work packages are handled:
| ||identifier of the target project|
| ||name of the target tracker|
| ||name of the target category|
| ||name of the target priority|
| ||name of the target status|
| ||name of the target version|
| ||name of the target type|
| ||name of the target priority|
| ||ignore: email is ignored (default), accept: accept as anonymous user, create: create a user account|
| ||specifies which attributes may be overwritten though specified by previous options. Comma separated list|
Please note: It’s important to use the plain text editor of your email client (instead of the HTML editor) to avoid misinterpretations (e.g. for the project name).
The address the mail is sent from must match an existing account in order to map the user action. If a matching account is found, the mail handler impersonates the user to create the ticket.
If no matching account is found, the mail is rejected. To override this behavior and allow unknown mail address to create work packages, set the option
no_permission_check=1 and specify with
Note: This feature only provides a mapping of mail to user account, it does not authenticate the user based on the mail. Since you can easily spoof mail addresses, you should not rely on the authenticity of work packages created that way.
Users with mail suffixes
If you’re used to using mail accounts with suffix support such as Google Mail, where you can specify
firstname.lastname@example.org, you will receive mails to that account but respond with your regular account
email@example.com . To mitigate this, OpenProject by default will expand searching for mail addresses
account@domain to accounts
account+suffix@domain through regex searching the mail column. If you do not wish that behavior or want to customize the prefix, alter the setting
mail_suffix_separators by running
bundle exec rails runner "Setting.mail_suffix_separators = ''"
The Attributes you can use in your email are the same whether you create or update a work package.
project attribute is a bit special:
You must either add
project to the set of allowed overridden attributes with
allow_override=project,.. in order to use it in a mail, OR set it as fixed variable with
The subject of the work package that shall be created is derived from the subject of the email. The body of the email gets parsed and all lines that contain recognized keys are removed. What is left will become the description.
Other available keys for the email are:
|Project||sets the project. Use the project identifier||Project:test_project|
|Assignee||sets the assignee. Use the email or login of the user||Assignee:firstname.lastname@example.org|
|Type||sets the type||type:Milestone|
|Version||sets the version||version:v4.1.0|
|Start date||sets the start date||start date:2015-02-28|
|Due date||sets the finish date|
|Done ratio||sets the done ratio. Use a number||Done ratio:40|
|Status||sets the status||Status:closed|
|priority||sets the priority||priority:High|
If you want to set a custom field just use the name as it is displayed in your browser, e.g.
Custom field:new value
Notice: The keys are not case-sensitive but the values you want to set are.
If you create or update a work package via email the attachments of the email will be attached to the relevant work package.
If you create a work package via email and sent it to another email (to or bcc) OpenProject will search for a user with this email and add it as watcher.
In the administrator’s setting you can specify lines after which an email will not be parsed anymore. That is useful if you want to reply to an email automatically sent to you from OpenProject. E.g. you could set it to
--Truncate here-- and insert this line into your email below the updates you want to perform. Find out more here.