Update documentation about incoming emails
This commit is contained in:
Frederic Guillot
parent
e74c9f9c1e
commit
09455778f8
|
|
@ -18,28 +18,17 @@ All complicated works are already handled by those services.
|
|||
Incoming emails workflow
|
||||
------------------------
|
||||
|
||||
1. You send an email to a specific address, for example **something+myproject@inbound.mydomain.tld**
|
||||
1. You send an email to a specific address, for example **myproject@inbound.mydomain.tld**
|
||||
2. Your email is forwarded to the third-party SMTP servers
|
||||
3. The SMTP provider call the Kanboard web hook with the email in JSON or multipart/form-data formats
|
||||
4. Kanboard parses the received email and create the task to the right project
|
||||
|
||||
Note: New tasks are automatically created in the first column.
|
||||
|
||||
Email format
|
||||
------------
|
||||
|
||||
- The local part of the email address must use the plus separator, for example **kanboard+project123**
|
||||
- The string defined after the plus sign must match a project identifier, for example **project123** is the identifier of the project **Project 123**
|
||||
- The email subject becomes the task title
|
||||
- The email body becomes the task description (Markdown format)
|
||||
|
||||
Incoming emails can be written in text or HTML formats.
|
||||
**Kanboard is able to convert simple HTML emails to Markdown**.
|
||||
|
||||
Security and requirements
|
||||
-------------------------
|
||||
Notes
|
||||
-----
|
||||
|
||||
- The Kanboard web hook is protected by a random token
|
||||
- The sender email address must match a Kanboard user
|
||||
- The Kanboard project must have a unique identifier, for example **MYPROJECT**
|
||||
- The Kanboard user must be a member of the project
|
||||
- Kanboard is able to convert only simple HTML emails to Markdown
|
||||
- New tasks are automatically created in the first column
|
||||
- Refer to the documentation of each plugin for the configuration
|
||||
|
|
|
|||
|
|
@ -19,43 +19,18 @@
|
|||
Обработка входящих email сообщений[¶](#incoming-emails-workflow "Ссылка на этот заголовок")
|
||||
-------------------------------------------------------------------------------------------
|
||||
|
||||
|
||||
1. Вы отправляете email сообщение на определенный адрес, например **something+myproject@inbound.mydomain.tld**
|
||||
1. Вы отправляете email сообщение на определенный адрес, например **myproject@inbound.mydomain.tld**
|
||||
2. Email сообщение перенаправляется на SMTP сервер
|
||||
3. SMTP провайдер передает в веб сервис Канборда email сообщение в JSON формате или в формате multipart/form-data
|
||||
4. Канборд обрабатывает полученное email сообщение и создает задачу в указанном проекте
|
||||
|
||||
**Заметка**: Новые задачи автоматически создаются в первой колонке.
|
||||
|
||||
|
||||
Формат email сообщения[¶](#email-format "Ссылка на этот заголовок")
|
||||
-------------------------------------------------------------------
|
||||
|
||||
- Email адрес до знака **@** должен содержать разделитель **плюс**, например **kanboard+project123**
|
||||
- Строка следующая после знака плюс означает **Идентификатор проекта**, например, проект **Проект 123** может иметь идентификатор проекта **project123**. Идентификатор проекта можно задать в свойствах проекта **Меню** -\> **Настройки** -\> **Изменить проект** -\> **Идентификатор**. **Идентификатор** должен быть из цифр и латинских букв.
|
||||
- Тема из email сообщения становится названием задачи
|
||||
- Текст email сообщения становится описанием задачи (в формате Markdown)
|
||||
|
||||
Email сообщения могут быть написаны в текстовом или HTML формате. **Канборд сам переконвертирует формат сообщения в Markdown**
|
||||
|
||||
|
||||
Безопастность и требования[¶](#security-and-requirements "Ссылка на этот заголовок")
|
||||
------------------------------------------------------------------------------------
|
||||
|
||||
- Веб транслятор Канборд защищен случайным ключом
|
||||
- Email адрес отправителя должен быть такой же как и у пользователя Канборд
|
||||
- Проект в Канборде должен иметь уникальный идентификатор
|
||||
- Отправитель email сообщения должен быть участником проекта
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
[Русская документация Kanboard](http://kanboard.ru/doc/)
|
||||
Notes
|
||||
-----
|
||||
|
||||
- Веб транслятор Канборд защищен случайным ключом
|
||||
- Email адрес отправителя должен быть такой же как и у пользователя Канборд
|
||||
- Проект в Канборде должен иметь уникальный идентификатор
|
||||
- Отправитель email сообщения должен быть участником проекта
|
||||
- Email сообщения могут быть написаны в текстовом или HTML формате. **Канборд сам переконвертирует формат сообщения в Markdown**
|
||||
- Заметка**: Новые задачи автоматически создаются в первой колонке
|
||||
- Refer to the documentation of each plugin for the configuration
|
||||
|
|
|
|||
Loading…
Reference in New Issue