Отправитель

---

Описывает все свойства данного отправителя. Данный плагин предоставляет возможность отправлять пользователям различные виды сообщений, будь то электронные письма или телефонные сообщения.

• Тип: object. Обязательны: name. Наличие дополнительных свойств: Недопустимо.
  • name: Тип: string. Дополнительно: Имя экземпляра плагина. Имя хранилища. Имя используется для того, чтобы в дальнейшем ссылаться на данный отправитель. Минимальная длина: 1.

  Допустим один из вариантов конфига

  Конфигурация email отправителя.

  • Тип: object. Конфигурация email отправителя. Служит для задания свойств отправителя. Обязательны: type, config. Наличие дополнительных свойств: Недопустимо.
    • type: Константа: email. Тип отправителя. Необходим, чтобы дать Aureole понять, какой из отправителей использовать.
    • config: Тип: object. Конфигурация отаправителя. Описывает все свойства данного отправителя. Обязательны: host, username, password, from, templates. Наличие дополнительных свойств: Недопустимо.
      • host: Тип: string. Хост. Хост сервера электронной почты.
      • username: Тип: string. Дополнительно: Формат: Email. Имя пользователя. Имя пользователя для аутентификации на сервере электронной почты.
      • password: Тип: string. Пароль пользователя. Пароль пользователя для аутентификации на сервере электронной почты. Минимальная длина: 1.
      • insecure_skip_verify: Тип: boolean. Значение по-умолчанию: False. Флаг отключения проверки сертификатов. Если включен, то при установлении соединения не будут проверяться сертификаты.
      • from: Тип: string. Дополнительно: Формат: Email. Аккаунт отправителя. Аккаунт, от чьего имени будут отправляться письма этим отправителем.
      • bcc: Тип: array. Значение по-умолчанию: []. Список скрытых вторичных получателей письма. Список аккаунтов, которым будет направляться копия письма. Эти пользователи не показываются другим получателям. Элементы должны быть уникальными.
        • Элементы: Тип: string. Дополнительно: Формат: Email.
      • cc: Тип: array. Значение по-умолчанию: []. Список вторичных получателей письма. Список аккаунтов, которым будет направляться копия письма. Эти пользователи видят и знают о наличии друг друга. Элементы должны быть уникальными.
        • Элементы: Тип: string. Дополнительно: Формат: Email.
      • templates: Тип: object. Перечисление шаблонов. Список шаблонов, которые могут быть использованы для отправки сообщений через этот отправитель. Минимальное кол-во свойств: 1.
        • regex(".+"): Тип: string. Дополнительно: Путь к файлу, Расширение файла: txt,html. Минимальная длина: 1.

    Пример конфига

    senders:
      - type: "email"
        name: email
        config:
          host: smtp.gmail.com:587
          username: username@example.com
          password: ${SMTP_PASSWORD}
          from: app@example.com
          templates:
            txt_tmpl: lab/templates/default.txt
            html_tmpl: lab/templates/default.html
    

  Конфигурация twilio отправителя.

  • Тип: object. Конфигурация twilio отправителя. Служит для задания свойств отправителя. Обязательны: type, config. Наличие дополнительных свойств: Недопустимо.
    • type: Константа: twilio. Тип отправителя. Необходим, чтобы дать Aureole понять, какой из отправителей использовать.
    • config: Тип: object. Конфигурация отправителя. Описывает все свойства данного отправителя. Обязательны: account_sid, auth_token, from, templates. Наличие дополнительных свойств: Недопустимо.
      • account_sid: Тип: string. Идентификатор аккаунта. Идентификатор, полученный при регистрации аккаунт у провайдера. Минимальная длина: 1.
      • auth_token: Тип: string. Токен аккаунта. Токен, полученный при регистрации аккаунт у провайдера. Минимальная длина: 1.
      • from: Тип: string. Дополнительно: Формат: телефон. Номер телефона аккаунта. Номер, полученный при регистрации аккаунт у провайдера. От имени этого номера будут приходить сообщения. Минимальная длина: 1.
      • templates: Тип: object. Перечисление шаблонов. Список шаблонов, которые могут быть использованы для отправки сообщений через этот отправитель. Минимальное кол-во свойств: 1.
        • regex(".+"): Тип: string. Дополнительно: Путь к файлу, Расширение файла: txt,html. Минимальная длина: 1.

    Пример конфига

    senders:
      - type: "twilio"
        name: twilio
        config:
          account_sid: ${TEST_TWILIO_ACCOUNT_SID}
          auth_token: ${TEST_TWILIO_AUTH_TOKEN}
          from: ${TEST_TWILIO_PHONE_NUMBER}
          templates:
            phone_otp: lab/templates/phone_otp.txt