Redmine

h1. RusRedmineReceivingEmails

{{>toc}}

Начиная с версии 0.8.0, Redmine можно настроить на создание и комментирование задач с помощью email.

h2. Настройка

You can configure Redmine to receive emails in one of the following ways:

Вы можете настроить Redmine для получения электронной почты одним из следующих способов:

* Пересылка электронных писем с вашего почтового сервера:

* Плюсы: работает с удаленнми почтовыми серверами, письма обрабатываются мгновенно, быстро (никакой перезагрузки окружения)

* Минусы: требует некоторых настроек агента передачи почты (например: Postfix, Sendmail...)

* Сбор почты с IMAP или POP3-сервера:

* Плюсы: простота установки, не нужно сконфигурировать MTA, работает с удаленного почтового сервера

* Минусы: письма не обрабатываются мгновенно (должны быть добавлены cron-задания, чтобы получать электронную почту регулярно)

* Чтение электронных писем из стандартного ввода:

* Плюсы: удобно для тестирования

* Минусы: медленный (перезагрузки окружения каждый раз, когда письмо открывается), нуждается в некоторой конфигурации вашего MTA

h3. Отправление писем с сервера

Отдельный скрипт можно использовать для переадресации входящих электронных писем с вашего почтового сервера.

Этот скрипт читает необработанные письма со стандартного ввода и направляет их в Redmine через HTTP-запрос.

Он находится в вашем redmine каталоге: @extra/mail_handler/rdm-mailhandler.rb@.

Чтобы использовать его, вам нужно включить API для получение сообщений электронной почты:

Зайдите _Настройки_ -> _Приём сообщений_, поставьте флажок на *Включить веб-сервис для входящих сообщений* и введите (или сгенерируйте) API ключ.

Скопируйте @rdm-mailhandler.rb@ на ваш почтовый сервер и убедитесь, что он исполненяемый, затем настройте ваш MTA.

Использование:

<pre>

rdm-mailhandler [options] --url=<Redmine URL> --key=<API ключ>

Обязательные:

  -u, --url                      URL сервера Redmine

  -k, --key                      Redmine API ключ

Общие:

  -h, --help                     помощь

  -v, --verbose                  экстра информация

  -V, --version                  информация о версии

Опции управления атрибутами задачи:

  -p, --project=PROJECT          идентификатор проекта

  -t, --tracker=TRACKER          трекер задачи

      --category=CATEGORY        категория задачи

      --priority=PRIORITY        приоритет задачи

  -o, --allow-override=ATTRS     разрешить содержимому письма переопределять

                                 атрибуты, определённые ранее,

                                 ATTRS - список атрибутов, разделённых запятой

</pre>

Примеры:

<pre>

  # Нет определённого проекта. Письма ДОЛЖНЫ содержать ключ 'Project':

  rdm-mailhandler --url http://redmine.domain.foo --key secret

  # Проект и стандартный трекер определены, но письма могут переопределять 

  # оба атрибута:

  rdm-mailhandler --url https://domain.foo/redmine --key secret \\

                  --project foo \\

                  --tracker bug \\

                  --allow-override tracker,priority

</pre>

Here is an example for a Postfix local alias (which is usually specified in @/etc/aliases@):

<pre>

foo: "|/path/to/rdm-mailhandler.rb --url http://redmine.domain --key secret --project foo"

</pre>

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:

* create a mapping in @/etc/virtual@ like: @ foo@example.org foo@

* modify @/etc/postfix/main.cf@ to specify a transport file: @transport_maps = hash:/etc/postfix/transport@

* within the transport file add a line like: @ foo@example.org local:@

*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.

A front-end to rdm-mailhandler.rb has been written to allow specifying projects trough sub-addresses (name+project@example.com). See [[MailhandlerSubAddress]]

h3. 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:

<code>

*/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 

</code>

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.

<code>

*/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 

</code>

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":http://www.kalab.com/freeware/pycron/pycron.htm 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:

<pre>

  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)

  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

</pre>

Issue attributes control options:

<pre>

  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

</pre>

Примеры для rake команды:

<pre>

  # 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

</pre>

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.

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.

h3. Fetching emails from a POP3 server

_Only available in trunk and future 1.0._

A rake task (@redmine:email:receive_pop3@) can be used to fetch incoming emails from a POP3 server.

Доступные опции POP3:

<pre>

  host=HOST                POP3 server host (default: 127.0.0.1)

  port=PORT                POP3 server port (default: 110)

  username=USERNAME        POP3 account

  password=PASSWORD        POP3 password

  apop=1                   use APOP authentication (default: false)

  delete_unprocessed=1     delete messages that could not be processed

                           successfully from the server (default

                           behaviour is to leave them on the server)

</pre>

See the IMAP rake task above for issue attributes control options.

h3. Чтение писем со стандартного ввода

A rake task (@redmine:email:receive@) can be used to read a single raw email from the standard input.

<pre>

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

</pre>

Примеры:

<pre>

  # 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

</pre>

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.

h3. Разрешение анонимным пользоваателям создавать задачи с помощью email

In order to enable this option, extra parameters have to be included.

<pre>

unknown_user=ACTION     how to handle emails from an unknown user ACTION can be one of the following values:

                        ignore: email is ignored (default)

                        accept: accept as anonymous user

                        create: create a user account

no_permission_check=1   disable permission checking when receiving the email

</pre>

Since version 0.9 project doesn't have to be public, but authentication required in Administration-> Settings->Authentication tab has to be unchecked.

h2. Как это работает

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.

h3. Target project

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.

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"@.

Пример (тело письма):

<pre>

This is a new issue that will be added to project foo.

Here we have the issue description

[...]

Project: foo

</pre>

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:

<pre>

  # Create issues on project foo by default

  rake redmine:email:receive_imap [...] project=foo allow_override=project

</pre>

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.

h3. Параметры задачи

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@.

Пример (тело письма):

<pre>

This is a new issue that overrides a few attributes

[...]

Project: foo

Tracker: Bug

Priority: Urgent

Status: Resolved

</pre>

h3. Наблюдатели

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.

h3. Формат письма и вложения

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 [[RedmineSettings#Attachment-max-size|maximum attachment size]] defined in the application settings.