@ -5,15 +5,11 @@ depending on the content of the e-mail.
## Setup
Receiving e-mails is done via a rake task that fetches e-mails from an
e-mail server, parses them and performs actions depending on the content
of the e-mail. This rake task can be executed manually or automatically,
e.g. with the help of a Cron job.
Receiving e-mails is done via a rake task that fetches e-mails from an e-mail server, parses them and performs actions depending on the content of the e-mail. This rake task can be executed manually or automatically, e.g. with the help of a Cron job.
### IMAP
The rake task `redmine:email:receive_imap` fetches e-mails via IMAP and
parses them.
The rake task `redmine:email:receive_imap` fetches e-mails via IMAP and parses them.
Example:
```bash
@ -46,8 +42,7 @@ Available arguments that change how the work packages are handled:
### POP3
The rake task `redmine:email:receive_pop3` fetches e-mails via IMAP and
parses them.
The rake task `redmine:email:receive_pop3` fetches e-mails via IMAP and parses them.
@ -75,11 +70,8 @@ Available arguments that change how the work packages are handled:
| `allow_override` | specifies which attributes may be overwritten though specified by previous options. Comma separated list|
If you set a default value it will be used when creating a work package.
But then no other value is possible (even when you update the work package) unless you specify this with the use
of `allow_override`. Some attributes (like `type, status, priority`) are
only changeable if you specify this via `allow_override`. But notice:
Some attributes have to specified in another format here, e.g. Assignee
can be allowed to be overriden with `allow_override=assigned_to`.
But then no other value is possible (even when you update the work package) unless you specify this with the use of `allow_override`. Some attributes (like `type, status, priority`) are only changeable if you specify this via `allow_override`. But notice: Some attributes have to specified in another format here, e.g. Assignee can be allowed to be overriden with `allow_override=assigned_to`.
## Format of the Emails
@ -88,17 +80,9 @@ can be allowed to be overriden with `allow_override=assigned_to`.
#### Attributes
The Attributes you can use in your e-mail are the same whether
you create or update a work package. Only the project is a bit special:
If you create a work package and do not specify the project via an environment variable you pass
along to the rake task you have to put it into the e-mail. If you
specify it via an environment variable or you update
a work package you do not need to specify it.
The Attributes you can use in your e-mail are the same whether you create or update a work package. Only the project is a bit special: If you create a work package and do not specify the project via an environment variable you pass along to the rake task you have to put it into the e-mail. If you specify it via an environment variable or you update a work package you do not need to specify it.
The subject of the work package that shall be created is derived from
the subject of the e-mail. The body of the e-mail gets parsed and all
lines that contain recognized keys are removed. What is left will become
the description.
The subject of the work package that shall be created is derived from the subject of the e-mail. The body of the e-mail gets parsed and all lines that contain recognized keys are removed. What is left will become the description.
Other available keys for the e-mail are:
@ -114,20 +98,15 @@ Other available keys for the e-mail are:
| 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`
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.**
**Notice: The keys are not case-sensitive but the values you want to set are.**
#### Attachments
If you create or update a work package via e-mail the attachments of the
e-mail will be attached to the relevant work package.
If you create or update a work package via e-mail the attachments of the e-mail will be attached to the relevant work package.
#### Watchers
If you create a work package via e-mail and sent it to another e-mail
(to or bcc) OpenProject will search for a user with this e-mail and add it
as watcher.
If you create a work package via e-mail and sent it to another e-mail (to or bcc) OpenProject will search for a user with this e-mail and add it as watcher.