配置电子邮件

您正在查看的是 Apigee Edge 文档。
转到 Apigee X 文档
信息

默认情况下,开发者服务门户会针对某些事件发送电子邮件。例如,当新开发者在该门户上注册时,该门户会自动向该开发者发送一封欢迎电子邮件。或者,如果开发者丢失了密码,可以请求发送一封包含临时密码的电子邮件。

作为 API 提供方,您可以控制该门户生成的电子邮件的各个方面,包括:

  • 设置门户自动发送的电子邮件的格式
  • 指定门户使用的 SMTP 服务器
  • 添加规则以生成电子邮件以响应门户上的事件

从云端门户发送电子邮件

在 Pantheon 或 Acquia 部署的云端门户的默认电子邮件配置只能在非生产环境中使用。匿名云服务器发送的电子邮件可能会遭到屏蔽或被标记为垃圾邮件。

对于生产门户,请使用以下选项之一发送电子邮件:

从本地门户发送电子邮件

默认情况下,使用 PHP mail() 函数发送邮件。PHP 会尝试在本地系统上使用 sendmail 发送电子邮件,该系统可以在 PHP 的 php.ini 文件中进行配置。

对于生产门户,您可以使用下述 SMTP 模块,通过 SMTP 服务器或公司服务器发送电子邮件。

配置 SMTP 服务器

开发者门户要求您配置 SMTP 服务器才能发送电子邮件。如需配置 SMTP 服务器,您必须先在开发者门户上启用 Drupal SMTP 身份验证支持模块

配置 SMTP 服务器后,开发者门户发送的所有电子邮件都将使用 SMTP 服务器。这些电子邮件包括发送给新开发者的电子邮件、发送给密码丢失的开发者的电子邮件,以及发送给账号被屏蔽的开发者的电子邮件。

要配置 SMTP 服务器,请执行以下操作

  1. 以拥有管理员或内容创建权限的用户身份登录门户。
  2. 在 Drupal 管理菜单中选择模块
    系统随即会打开“模块”页面。
  3. 启用 SMTP 身份验证支持模块。
  4. 保存配置。
  5. 启用该模块后,在“模块”页面上的“SMTP 身份验证支持”条目中选择配置
    系统会显示“SMTP 身份验证支持”配置页面。
  6. 打开或关闭此模块下,选择开启
  7. 在“SMTP 服务器设置”部分,输入以下信息:
    • SMTP 服务器地址。例如,对于 Gmail 外发 SMTP 服务器,请使用 smtp.gmail.com。
    • (可选)输入备用 SMTP 服务器地址。此值并非必填项。
    • 输入 SMTP 端口。此端口的值可能会因所选加密协议而异。例如,对于 Gmail,使用 SSL 时,端口为 465,对于 TLS,端口为 587。
    • 选择加密协议为SSLTLS
  8. SMTP 身份验证区域,指定用于 SMTP 身份验证的用户名和密码。这必须是 SMTP 服务器上的有效用户名和密码。
  9. 电子邮件选项下,输入生成电子邮件的用户的电子邮件地址和姓名。这些值对应于电子邮件的“发件人”地址。
  10. (可选)在发送测试电子邮件下,输入门户发送测试邮件的电子邮件地址。
  11. 保存配置。
    保存配置会生成测试电子邮件,并显示所有配置错误。检查测试邮件所用电子邮件地址的收件箱,确保邮件顺利送达。
  12. 在 Drupal 管理菜单中,依次选择配置 > 系统 > 网站信息
  13. 网站详细信息下,将电子邮件地址设置为您在第 9 步中指定的电子邮件地址。
    某些生成电子邮件的 Drupal 模块会使用此字段来确定电子邮件的“发件人”地址,而不是“SMTP 身份验证支持”页面上显示的值。
  14. 保存配置。

配置电子邮件通知并设置其格式

您可以配置为了响应特定活动(例如注册、删除、屏蔽和取消屏蔽开发者帐号等)而发送的各种电子邮件通知。

您还可以控制电子邮件的“发件人”地址。

如要配置电子邮件通知,请执行以下操作

  1. 以拥有管理员或内容创建权限的用户身份登录门户。
  2. 在 Drupal 管理菜单中,依次选择配置 > 用户 > 帐号设置。此操作会打开“帐号设置”页面。
  3. 在“帐号设置”页的“电子邮件”部分选择电子邮件通知类型。 例如,您可以选择“欢迎(无需获得批准)”,这样一来,当开发者帐号在开发者注册过程中自动获得批准时,系统就会发送电子邮件。

  4. 修改电子邮件通知的主题正文
    将光标置于某个字段(如 Subject)中,然后选择表单底部的 Browse available tokens 链接,查看您可以在该字段中使用的令牌列表。此时会出现一个弹出式窗口,您可以在其中选择要添加的令牌,例如 [user:name],它对应于开发者的用户名。
  5. 点击 Save configuration(保存配置)。

您也可以更改电子邮件通知中的“发件人”姓名和地址。

如需更改“发件人”姓名和地址,请执行以下操作

  1. 以拥有管理员或内容创建权限的用户身份登录门户。
  2. 在 Drupal 管理菜单中,依次选择配置 > 系统 > SMTP 身份验证支持。系统会打开“SMTP 身份验证支持”页面。
  3. 电子邮件发件人地址字段中指定“发件人”电子邮件地址。
  4. 发件人姓名字段中指定“发件人”名称。
  5. 点击 Save configuration(保存配置)。
  6. 在 Drupal 管理菜单中,依次选择配置 > 系统 > 网站信息
  7. 在“电子邮件地址”字段中指定您在步骤 3 中使用的电子邮件地址。
  8. 点击 Save configuration(保存配置)。

在事件发生时生成电子邮件

规则的一种常见用途是生成电子邮件以响应事件。该门户内置支持为预定义事件(例如新开发者注册帐号时)生成电子邮件。不过,您可以添加自己的规则来生成电子邮件。例如,您可以在开发者添加、移除或修改应用时生成电子邮件。

本部分举例说明了如何创建规则以在开发者注册应用时生成电子邮件。请根据需要修改此过程,以便为其他事件生成电子邮件。

如需在开发者创建应用时生成电子邮件,请按以下步骤操作

  1. 以拥有管理员或内容创建权限的用户身份登录门户。
  2. 在 Drupal 管理菜单中选择模块
  3. 确保已启用规则界面模块。
  4. 在 Drupal 管理菜单中,依次选择配置 > 工作流 > 规则。系统随即会打开“规则”页面。
  5. 选择添加新规则按钮。
  6. 在新规则页面上,指定以下内容:
    • 规则名称,例如“发送电子邮件规则”。
    • (可选)指定用于对搜索规则进行分类的任何标记
    • React on event 下拉列表中,依次选择 Devconnect > 在创建开发者应用后。
  7. 保存规则。
    保存规则后,系统会打开规则修改表单,其中包含三个窗格:事件(您刚刚创建)、条件操作
  8. 操作下,选择添加操作
  9. Select the Action to Add 下拉列表中,依次选择 系统 > 发送邮件
    选择此选项会打开一个页面,供您设置电子邮件的格式。使用此表单指定电子邮件的“收件人”“主题”“邮件正文”和其他字段。

    展开每个字段下的替换模式链接,查看您可以在该字段中使用的模式列表。例如,如果展开“替换”字段下的“替换”模式,您将看到包含 [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