Skip to content

Настройка SMTP-уведомлений

Базовые настройки SMTP

Для активации SMTP:

  1. Войдите в Apiary в качестве администратора.
  2. В меню слева выберите Администрирование > SMTP.
  3. Активируйте SMTP.

  4. Заполните следующие поля:

    • Адрес — IP-адрес или имя хоста сервера SMTP;
    • Порт — номер порта сервера SMTP;
    • Имя пользовтаеля — логин отправителя;
    • Пароль — пароль отправителя;
    • Безопасность — использование протокола безопасности (NONE, STARTTLS, SSL/TLS);
    • От кого — почтовый адрес, с которого вы будете получать уведомления.

  5. Чтобы применить настройки, нажмите Сохранить.

  6. Чтобы проверить правильность всех настроек SMTP, нажмите + Проверить конфигурацию электронной почты. С помощью этой опции вы можете отправить тестовое письмо на свой почтовый ящик:

    • Кому — адрес e-mail, на который будет отправлено тестовое письмо;
    • Тема — тема письма;
    • Сообщение — текст письма.

  7. Нажмите Отправить пробный e-mail, чтобы отправить письмо.

Абсолютные ссылки

Для формирования абсолютной ссылки в письме необходимо
выполнить реконфигурацию.

Добавьте опцию f.deck.base.url и укажите в ней доменное имя.

Пример:

f.deck.base.url = http[s]://Apiary.example.com[:port_number]

Чтобы изменения вступили в силу, нужно выполнить реконфигурацию.

Добавление пользовательских шаблонов писем

Чтобы добавить пользовательские шаблоны писем в Apiary, создайте новую директорию на машине, где он установлен:

mkdir /opt/letter-templates

В новую директорию загрузите свой шаблон письма. Важно: имя шаблона должно быть email_notifications.json.

Теперь нужно изменить конфигурацию.

Добавьте опцию f.notification.template.dir и в ней укажите путь до шаблона письма:

f.notification.template.dir = /opt/letter-templates

Чтобы изменения вступили в силу, нужно выполнить реконфигурацию.

Формат шаблона письма

Шаблон письма:

"email_new_issue":{
  "subject": "[{{product}}] New issue in project {{project.name}}: {{issue.name}}",
  "body": "There is 1 new issue \n{% if project %}\n{{deck_base_url}}/projects/{{project.id}} ({{ project.name }})\n{% endif %}\n{% if issue %}\n{{deck_base_url}}/projects/{{project.id}}/issues?issueId={{issue.id}} ({{ issue.name }}) {{ issue.status }}\n{% endif %} {% if issue %}\n{{ issue.name }}\n{% endif %}\n{% if issue and issue.description %} {{issue.description}}\n{% endif %}"
  },
"email_issue_status_change":{ 
  "subject": "{{product}}] New chat message in {{project.name}}: {{issue.name}}", 
  "body": "There is 1 new chat message \n{% if project %}\n{{deck_base_url}}/projects/{{project.id}} ({{ project.name }})\n{% endif %}\n{% if issue %}\n{{deck_base_url}}/projects/{{project.id}}/issues?issueId={{issue.id}} ({{ issue.name }}) {{ issue.status }}\n{% endif %} {% if issue %}\n{{ issue.name }}\n{% endif %}\n{% if issue and issue.description %} {{issue.description}}\n{% endif %}" 
  }
}

Вы можете использовать предустановленные переменные, чтобы добавить в письмо информацию о проекте, ишах, пользователях и т. д.

Пример:

  • product — название Apiary;

  • deck_base_url — абсолютная ссылка на проект или ишу:

  • {{deck_base_url}}/projects/{{project.id}} — абсолютная ссылка на ID проекта;

  • {{deck_base_url}}/projects/{{project.id}}/issues?issueId={{issue.id}} — абсолютная ссылка на ID иши;

  • user — информация о пользователе:

  • id — ID пользователя (пример: {{user.id}});
  • login — логин пользователя (пример: {{user.login}});
  • first_name — имя пользователя (пример: {{user.first_name}});
  • last_name — фамилия пользователя (пример: {{user.last_name}});
  • email — E-mail пользователя (пример: {{user.email}});
  • is_admin — роль пользователя - администратор (пример: {{user.is_admin}});
  • is_bot — пользователь-бот (пример: {{user.is_bot}});

  • created — дата создания пользователя (пример: {{user.created}});

  • issue — информация об ише:

  • id — ID иши (пример: {{issue.id}});
  • project_id — ID проекта, в котором зарегистрирована иша (пример: {{issue.project_id}});
  • name — название иши (пример: {{issue.name}});
  • sla — автоматически установленное значение SLA (пример: {{issue.sla}});
  • sla_manual_set — вручную установленное значение SLA (пример: {{issue.sla_manual_set}});
  • created — дата создания иши (пример: {{issue.created}});

  • completed — дата устранения иши (пример: {{issue.completed}});

  • project — информация о проекте:

  • id — ID проекта (пример: {{project.id}});
  • name — имя проекта (пример: {{project.name}});
  • description — описание проекта (пример: {{project.description}});
  • connection_name — имя соединения проекта (пример: {{project.connection_name}});
  • start_date — дата начала проекта (пример: {{project.start_date}});
  • completion_date — дата окончания проекта (пример: {{project.completion_date}});
  • scope — общая информация о проекте (пример: {{project.scope}});
  • project_type — тип проекта (пример: {{project.project_type}}).

Уведомления

В Apiary существуют следующие типы уведомлений:

  1. Веб-уведомления — эти уведомления отображаются в веб-интерфейсе при появлении соответствующих событий:

    • Новая иша — добавлена новая иша;
    • Новое сообщение — новое сообщение в чате иши;
    • Изменился статус иши — изменен статус иши.

  2. E-mail уведомления — e-mail отправляется при появлении соответствующих событий. Для использования этой опции необходимо активировать SMTP-уведомления:

    • Новая иша на эл.почту — добавлена новая иша;
    • Новое сообщение на эл.почту — новое сообщение в чате иши;
    • Изменился статус иши на эл.почту — изменен статус иши.

Чтобы просмотреть и настроить Уведомления:

  1. Нажмите на иконку Feed в правом верхнем углу страницы:
    Notifications view

  2. Нажмите на активное уведомление на вкладке События, и вы будете перенаправлены в ишу:
    Notification events

  3. Перейдите на вкладку Настройки.

  4. Включите или отключите необходимые уведомления с помощью кнопок.
    Notification settings