Update documentation about incoming emails

This commit is contained in:
Frederic Guillot
2017-10-27 14:00:14 -07:00
parent e74c9f9c1e
commit 09455778f8
2 changed files with 16 additions and 52 deletions

View File

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