Настройка электронной почты

Вы просматриваете документацию Apigee Edge .
Перейдите к документации Apigee X.
информация

По умолчанию портал служб разработчиков отправляет электронные письма в ответ на определенные события. Например, когда на портале регистрируется новый разработчик, портал автоматически отправляет разработчику приветственное электронное письмо. Или, если разработчик потеряет свой пароль, он может запросить электронное письмо с временным паролем.

Как поставщик API вы можете контролировать все аспекты электронных писем, генерируемых порталом, в том числе:

  • Форматирование автоматических электронных писем, отправляемых порталом
  • Указание SMTP-сервера, используемого порталом
  • Добавление правил для генерации писем в ответ на события на портале

Отправка электронной почты с облачного портала

Конфигурацию электронной почты по умолчанию для облачного портала, развернутого на Pantheon или Acquia, следует использовать только в непроизводственных средах. Электронная почта, отправленная с анонимного облачного сервера, может быть заблокирована или помечена как спам.

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

Отправка электронной почты с локального портала

По умолчанию почта отправляется с помощью функции PHP mail() . PHP пытается отправить электронную почту с помощью sendmail в локальной системе, что можно настроить в файле PHP php.ini .

Для производственных порталов вы можете использовать модуль SMTP, описанный ниже, для отправки электронной почты через SMTP-сервер или сервер компании.

Настройка SMTP-сервера

Портал разработчика требует настройки SMTP-сервера для отправки сообщений электронной почты. Чтобы настроить SMTP-сервер, необходимо сначала включить модуль поддержки аутентификации SMTP Drupal на портале разработчика.

После настройки SMTP-сервера все электронные письма, отправляемые порталом разработчика, используют SMTP-сервер. К этим электронным письмам относятся электронные письма, отправленные новым разработчикам, электронные письма, отправленные разработчикам, которые потеряли свой пароль, а также электронные письма, отправленные разработчикам с заблокированными учетными записями.

Чтобы настроить SMTP-сервер :

  1. Войдите на свой портал как пользователь с правами администратора или создания контента.
  2. Выберите «Модули» в меню администрирования Drupal.
    Откроется страница Модули.
  3. Включите модуль поддержки аутентификации SMTP .
  4. Сохраните конфигурацию.
  5. После включения модуля выберите «Настроить» в разделе «Поддержка аутентификации SMTP» на странице «Модули».
    Появится страница конфигурации поддержки аутентификации SMTP.
  6. В разделе «Включить или выключить этот модуль» выберите « Вкл.» .
  7. В области настроек SMTP-сервера введите следующую информацию:
    • Адрес SMTP-сервера . Например, для исходящего SMTP-сервера Gmail используйте smtp.gmail.com.
    • При необходимости введите адрес резервного SMTP-сервера . Это значение не является обязательным.
    • Введите порт SMTP . Значение этого порта может отличаться в зависимости от выбранного протокола шифрования. Например, для Gmail порт — 465 при использовании SSL и 587 для TLS.
    • Выберите протокол шифрования: None , SSL или TLS .
  8. В области SMTP-аутентификация укажите имя пользователя и пароль, используемые для SMTP-аутентификации. Это должны быть действительные имя пользователя и пароль на SMTP-сервере.
  9. В разделе «Параметры электронной почты» введите адрес электронной почты и имя пользователя, создавшего сообщение электронной почты. Эти значения соответствуют адресу «От» электронного письма.
  10. При необходимости в разделе «Отправить тестовое сообщение электронной почты» введите адрес электронной почты, на который портал отправит тестовое сообщение.
  11. Сохраните конфигурацию.
    При сохранении конфигурации создается тестовое сообщение электронной почты и отображаются все ошибки конфигурации. Проверьте папку «Входящие» адреса электронной почты тестового сообщения, чтобы убедиться, что оно получено.
  12. Выберите Конфигурация > Система > Информация о сайте в меню администрирования Drupal.
  13. В разделе «Сведения о сайте» установите в качестве адреса электронной почты тот же адрес электронной почты, который вы указали на шаге 9.
    Некоторые модули Drupal, генерирующие электронные письма, используют это поле для определения адреса «От» электронного письма, а не значения на странице поддержки аутентификации SMTP.
  14. Сохраните конфигурацию.

Настройка и форматирование уведомлений по электронной почте

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

Вы также можете контролировать адрес «От» электронных писем.

Чтобы настроить уведомления по электронной почте:

  1. Войдите на свой портал как пользователь с правами администратора или создания контента.
  2. Выберите Конфигурация > Люди > Настройки учетной записи в меню администрирования Drupal. Откроется страница настроек учетной записи.
  3. Выберите тип уведомления по электронной почте в разделе «Электронная почта» на странице настроек учетных записей. Например, вы можете выбрать «Добро пожаловать (не требуется одобрение)», при этом электронное письмо будет отправлено, когда учетная запись разработчика будет автоматически одобрена в процессе регистрации разработчика.

  4. Отредактируйте тему и текст уведомления по электронной почте.
    Поместите курсор в поле, например «Тема» , а затем выберите ссылку «Просмотреть доступные токены» в нижней части формы, чтобы просмотреть список токенов, которые можно использовать в поле. Появится всплывающее окно, позволяющее выбрать токен для добавления, например [user:name] , который соответствует имени пользователя разработчика.
  5. Нажмите Сохранить конфигурацию .

Вы также можете изменить имя и адрес «От» в уведомлении по электронной почте.

Чтобы изменить имя и адрес «От»:

  1. Войдите на свой портал как пользователь с правами администратора или создания контента.
  2. Выберите Конфигурация > Система > Поддержка аутентификации SMTP в меню администрирования Drupal. Откроется страница поддержки аутентификации SMTP.
  3. Укажите адрес электронной почты «От» в поле «Адрес электронной почты ».
  4. Укажите имя «От» в поле «Имя отправителя электронной почты» .
  5. Нажмите Сохранить конфигурацию .
  6. Выберите Конфигурация > Система > Информация о сайте в меню администрирования Drupal.
  7. В поле «Адрес электронной почты» укажите тот же адрес электронной почты, который вы использовали на шаге 3.
  8. Нажмите Сохранить конфигурацию .

Создание электронного письма при возникновении события

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

В этом разделе приведен пример создания правила для создания электронного письма, когда разработчик регистрирует приложение. При необходимости измените эту процедуру, чтобы генерировать электронные письма для других событий.

Чтобы создать электронное письмо, когда разработчик создает приложение:

  1. Войдите на свой портал как пользователь с правами администратора или создания контента.
  2. Выберите «Модули» в меню администрирования Drupal.
  3. Убедитесь, что модуль пользовательского интерфейса «Правила» включен.
  4. Выберите Конфигурация > Рабочий процесс > Правила в меню администрирования Drupal. Откроется страница «Правила».
  5. Нажмите кнопку Добавить новое правило .
  6. На странице новых правил укажите:
    • Имя правила, например «Правило отправки электронной почты».
    • При необходимости укажите любые теги, используемые для категоризации правил поиска.
    • В раскрывающемся списке Реагировать на событие выберите Devconnect > При создании приложения разработчика.
  7. Сохраните правило.
    При сохранении правила открывается форма редактирования Правил с тремя панелями: «События» (которые вы только что создали), «Условия» и «Действия» .
  8. В разделе «Действия» выберите «Добавить действие» .
  9. В раскрывающемся списке «Выберите действие для добавления» выберите «Система» > «Отправить почту» .
    Этот выбор открывает страницу, на которой можно отформатировать электронное письмо. Используйте эту форму, чтобы указать поля «Кому», «Тема», «Сообщение» и другие поля электронного письма.

    Разверните ссылку Шаблоны замены под каждым полем, чтобы просмотреть список шаблонов, которые можно использовать в этом поле. Например, если вы развернете Шаблоны замены в поле Кому, вы увидите список шаблонов, включающий [app:developer] . Если вы укажете этот шаблон в поле «Кому», электронное письмо будет отправлено создателю приложения.
  10. Задайте поля, как показано ниже:
  11. Выберите Сохранить , чтобы вернуться на страницу редактирования правила.
  12. Выберите Сохранить изменения .

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

Subject: App test email app created

App: test email app
API products: PremiumWeatherAPI, weatherapikey-Product
Created at: Mon, 01/27/2014 - 10:16