电子邮件

借助 Email 连接器，您可以对 IMAP 数据库执行插入、删除、更新和读取操作。

准备工作

在使用 Email 连接器之前，请先完成以下任务：

  • 在您的 Google Cloud 项目中：
    • 确保已设置网络连接。如需了解网络模式，请参阅网络连接。
    • 向配置连接器的用户授予 roles/connectors.admin IAM 角色。
    • 将以下 IAM 角色授予您要用其来使用连接器的服务账号：
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      服务账号是一种特殊类型的 Google 账号，用于表示需要验证身份并获得授权以访问 Google API 数据的非人类用户。如果您没有服务账号，则必须创建一个服务账号。连接器和服务账号必须属于同一项目。如需了解详情，请参阅创建服务账号。

    • 启用以下服务：
      • secretmanager.googleapis.com (Secret Manager API)
      • connectors.googleapis.com (Connectors API)

      如需了解如何启用服务，请参阅启用服务。

    如果之前没有为您的项目启用这些服务或权限，则在您配置连接器时，系统会提示您启用。

配置连接器

一个连接需专用于一个数据源。这意味着，如果您有许多数据源，则必须为每个数据源创建单独的连接。如需创建连接，请执行以下操作：

  1. 在 Cloud 控制台 中，进入 Integration Connectors > 连接页面，然后选择或创建一个 Google Cloud 项目。

    转到“连接”页面

  2. 点击 + 新建以打开创建连接页面。
  3. 在位置部分中，选择连接的位置。
    1. 区域：从下拉列表中选择一个位置。

      如需查看所有受支持区域的列表，请参阅位置。

    2. 点击下一步。
  4. 在连接详情部分中，完成以下操作：
    1. 连接器：从可用连接器的下拉列表中选择 Email。
    2. 连接器版本：从可用版本的下拉列表中选择一个连接器版本。
    3. 在连接名称字段中，输入连接实例的名称。

      连接名称必须符合以下条件：

      • 连接名称可以使用字母、数字或连字符。
      • 字母必须小写。
      • 连接名称必须以字母开头，以字母或数字结尾。
      • 连接名称不能超过 49 个字符。
    4. （可选）说明： 输入连接的说明。
    5. 您可以选择启用 Cloud Logging，然后选择日志级别。默认情况下，日志级别设置为 Error。
    6. 服务账号：选择具有所需角色的服务账号。
    7. 协议：要连接到的电子邮件服务器类型。有效值为 IMAP 和 POP。
    8. 详细程度：此字段用于确定您要在日志文件中添加的详细程度。有效值的范围为 1 到 5。详细程度越高，记录的所有通信详细信息就越多，包括请求、响应和 SSL 证书。
    9. （可选）配置连接节点设置：

      • 节点数下限：输入连接节点数下限。
      • 节点数上限：输入连接节点数上限。

      节点是处理事务的连接单元（或副本）。 连接处理越多事务就需要越多节点，相反，处理越少事务需要越少节点。 如需了解节点如何影响连接器价格，请参阅连接节点的价格。如果未输入任何值，则默认情况下，节点数下限设置为 2（以便提高可用性），节点数上限设置为 50。

    10. （可选）在高级设置部分，选中使用代理复选框可为连接配置代理服务器并配置以下值：
      • 代理身份验证方案：选择要通过代理服务器进行身份验证的身份验证类型。支持以下身份验证类型：
        • 基本：基本 HTTP 身份验证。
        • 摘要：摘要 HTTP 身份验证。
      • 代理用户：用于向代理服务器进行身份验证的用户名。
      • 代理密码：用户密码的 Secret Manager 密文。
      • 代理 SSL 类型：连接到代理服务器时使用的 SSL 类型。支持以下身份验证类型：
        • 自动：默认设置。如果网址是 HTTPS 网址，则使用“隧道”选项。如果网址是 HTTP 网址，则使用“永不”选项。
        • 始终：连接始终启用 SSL。
        • 永不：连接未启用 SSL。
        • 隧道：连接通过隧道代理建立。代理服务器会打开与远程主机的连接，并且流量会流经该代理。
      • 在代理服务器部分中，输入代理服务器的详细信息。
        1. 点击+ 添加目标。
        2. 选择目标类型。
          • 主机地址：指定目标的主机名或 IP 地址。

            如果要与后端系统建立专用连接，请执行以下操作：

    11. （可选）点击 + 添加标签，以键值对的形式向连接添加标签。
    12. 点击下一步。
  5. 在目标部分中，输入要连接的邮件服务器的名称或地址的详细信息。服务器支持 IMAP 和 POP 协议。
    1. 目标类型：选择目标类型。例如，输入主机地址和端口号。例如，主机地址为 outlook.office365.com，端口为 993。
      • 如需指定目标主机名或 IP 地址，请选择主机地址，然后在主机 1 字段中输入相应地址。
      • 如需建立专用连接，请选择端点连接。在端点连接列表中，选择为后端系统创建的端点连接。

      如果要与后端系统建立公共连接以提高安全性，您可以考虑为连接配置静态出站 IP 地址，然后将防火墙规则配置为仅将特定静态 IP 地址列入许可名单。

    2. 如果您想发送电子邮件，请点击 + 添加目的地，在 SMTPServer 部分中添加 SMTP 服务器详细信息。然后，执行以下操作：
      • 输入主机地址和端口号。例如，主机地址为 smtp-mail.outlook.com，端口为 587。
    3. 点击下一步。
  6. 在身份验证部分中，输入身份验证详细信息。
    1. 选择身份验证类型，然后输入相关详细信息。

      Email 连接支持以下身份验证类型：

      • 用户名和密码

      2. 如需了解如何配置这些身份验证类型，请参阅配置身份验证。

    2. 点击下一步。
  7. 查看：查看您的连接和身份验证详细信息。
  8. 点击创建。

配置身份验证

根据您要使用的身份验证输入详细信息。

  • 用户名和密码
    • 用户名：用于进行身份验证的电子邮件账号的用户。
    • 密码：包含用于进行身份验证的电子邮件账号密码的 Secret Manager Secret。

实体、操作和动作

所有集成连接器都会为所连接应用的对象提供抽象层。您只能通过此抽象访问应用的对象。抽象作为实体、操作和动作向您展示。

  • 实体：实体可以被视为连接的应用或服务中的对象或属性集合。不同连接器的实体定义也会有所不同。例如，在数据库连接器中，表是实体；在文件服务器连接器中，文件夹是实体；在消息传递系统连接器中，队列是实体。

    但可能的情况是，连接器不支持或不具有任何实体，在这种情况下，Entities 列表将为空。

  • 操作：操作是指您可以对实体执行的操作。您可以对实体执行以下任一操作：

    从可用列表中选择一个实体，系统会生成该实体可用的操作列表。如需了解操作的详细说明，请参阅连接器任务的实体操作。不过，如果连接器不支持任何实体操作，则不支持的操作不会列在 Operations 列表中。

  • 动作：动作是可通过连接器接口提供给集成的头等函数。动作可让您对一个或多个实体进行更改，并且动作因连接器而异。通常，操作会包含一些输入参数和一个输出参数。但可能的情况是，连接器不支持任何动作，在这种情况下，Actions 列表将为空。

系统限制

电子邮件连接器每秒每个节点可处理 1 个事务，并会限制超出此限值的任何事务。默认情况下，Integration Connectors 会为连接分配 2 个节点（以提高可用性）。

如需了解适用于 Integration Connectors 的限制，请参阅限制。

操作

本部分列出了连接器支持的操作。如需了解如何配置操作，请参阅操作示例。

MoveEmails 操作

MoveEmails 操作的输入参数

参数名称 数据类型 必需 说明
说明 字符串 是 邮件将移至的邮箱。
邮箱 字符串 是 相应邮件目前所在的邮箱。
ID 字符串 是 此输入表示要操作的消息集。它可以包含单个消息 ID、由两个消息编号（以“:”分隔）指定的范围（例如“1:5”），以及/或者以“,”分隔的各个消息编号（例如“1:5,7,10”）。

如需查看有关如何配置 MoveEmails 操作的示例，请参阅操作示例。

SendMailMessages 操作

SendMailMessages 操作的输入参数

参数名称 数据类型 必需 说明
密送 字符串 否 以英文分号分隔的密送收件人的姓名和电子邮件地址列表。
优先级 字符串 否 邮件消息的优先级。
敏感程度 字符串 否 邮件的敏感度。
附件 字符串 是 邮件中包含的附件文件名的列表（如果从文件中读取，则包含路径），以半角分号分隔。
MessageBody 字符串 是 消息正文。
AttachmentData 字符串 是 以英文分号分隔的列表，其中包含消息中采用 base-64 编码的附件数据。（您仍必须在“附件”中指定文件名。
InlineImage 字符串 是 以英文分号分隔的内嵌图片标识符 (cid) 列表，用于指定要包含在消息中的内嵌图片。
DeliveryNotification 字符串 否 用于接收交付通知的电子邮件地址。
InlineImageData 字符串 是 以半角分号分隔的列表，其中包含要纳入消息中的 base-64 编码图片数据。
CC 字符串 否 以英文分号分隔的抄送收件人的姓名和电子邮件地址列表。
InlineImageContent 字符串 否 要上传的内容（以 InputStream 形式）。
发件人 字符串 否 发件人的电子邮件地址。
收件人 字符串 否 以英文分号分隔的收件人姓名和电子邮件地址列表。
主题 字符串 是 邮件的主题。
AttachmentContent 字符串 否 要上传的内容（以 InputStream 形式）。
字符集 字符串 否 要在消息中使用的字符集。
ReadReceipt 字符串 否 用于接收已读回执的电子邮件地址。
IsHTML 字符串 否 电子邮件是 HTML 格式还是纯文本格式。
重要性 字符串 否 邮件消息的重要性。

如需查看有关如何配置 SendMailMessages 操作的示例，请参阅操作示例。

SetLabels 操作

SetLabels 操作的输入参数

参数名称 数据类型 必需 说明
OperationType 字符串 是 这表示应添加、移除还是替换现有标签列表中的指定标签。
邮箱 字符串 是 相应邮件所在的 Gmail 邮箱。
ID 字符串 是 此输入表示要操作的消息集。它可以包含单个消息 ID、由两个消息编号（以“:”分隔）指定的范围（例如“1:5”），以及/或者以“,”分隔的各个消息编号（例如“1:5,7,10”）。
标签 字符串 是 要为 MessageSet 属性指定的邮件设置的标签列表。此输入应设置为以英文逗号分隔的标签列表。

如需查看有关如何配置 SetLabels 操作的示例，请参阅操作示例。

SetFlag 操作

SetFlag 操作的输入参数

参数名称 数据类型 必需 说明
OperationType 字符串 是 这表示应添加、移除还是替换现有标志列表中的指定标志。
邮箱 字符串 是 相应消息所在的邮箱。
ID 字符串 是 此输入表示要操作的消息集。它可以包含单个消息 ID、由两个消息编号（以“:”分隔）指定的范围（例如“1:5”），以及/或者以“,”分隔的各个消息编号（例如“1:5,7,10”）。
标志 字符串 是 将指定标志设置为邮件集指定的邮件。（例如“已读”“已删除”“草稿”“已标记”）。标志应以英文逗号分隔的列表形式指定（例如 Seen、Deleted、flagged）

如需查看有关如何配置 SetFlag 操作的示例，请参阅操作示例。

示例

操作示例

示例 - 移动电子邮件

  1. 在 Configure connector task 对话框中，点击 Actions。
  2. 选择 MoveEmails 操作，然后点击完成。
  3. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：
     {
"Destination": "Inbox",
"Mailbox": "Archive",
"Id": "1"
}

    4. 如果操作成功，MoveEmails 任务的 connectorOutputPayload 响应形参将具有类似于以下的值：

    [{
"Success": "true",
"rss:title": "Message(s) moved successfully."
}]

示例 - 发送电子邮件

  1. 在 Configure connector task 对话框中，点击 Actions。
  2. 选择 SendMailMessages 操作，然后点击完成。
  3. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：
     {
"MessageBody": "This mail is generated by using action sendmailmessage for outlook server.",
"To": "test97@gmail.com",
"Subject": "Outlook SMTP\n server."
}

    4. 如果操作成功，SendMailMessages 任务的 connectorOutputPayload 响应形参将具有类似于以下的值：

    [{
 "MessageId": "4797386f18288a7441c5317a459b8340e857@outlook.com"
}]

示例 - 发送带附件的邮件

  1. 在 Configure connector task 对话框中，点击 Actions。
  2. 选择 SendMailMessages 操作，然后点击完成。
  3. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：
     {
"MessageBody": "This mail is generated by using action sendmailmessage for outlook server.",
"To": "test97@gmail.com",
"Subject": "Outlook SMTP PDF Mail.",
"Attachment": "Testing.pdf",
"AttachmentData": "JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBvYmoKPDwvTGVuz1xj6j3/gb09Wma83/dLbs7L9N03T/dHh6ArlrRiZdCU98lR5A3h9FD
...[too long to view on UI. Please download the log to view the full content.]
}

    4. 如果操作成功，SendMailMessages 任务的 connectorOutputPayload 响应形参将具有类似于以下的值：

    [{
"MessageId": "1e96993a6053845c65ee44e6b4153d585e@outlook.com"
}]

示例 - 设置标签

  1. 在 Configure connector task 对话框中，点击 Actions。
  2. 选择 SetLabels 操作，然后点击完成。
  3. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：
     {
"Labels": "GoogleCloud_Testing",
"OperationType": "ADD",
"Mailbox": "Inbox",
"Id": "1"
}

    4. 如果操作成功，SetLabels 任务的 connectorOutputPayload 响应形参将具有类似于以下的值：

    [{
"Success": "true",
"rss:title": "Message labels set correctly."
}]

示例 - 设置标志

  1. 在 Configure connector task 对话框中，点击 Actions。
  2. 选择 SetFlag 操作，然后点击完成。
  3. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：
    {
"Mailbox": "Sent",
"Id": "1",
"Flags": "Draft",
"OperationType": "ADD"
}

    4. 如果操作成功，SetFlag 任务的 connectorOutputPayload 响应形参将具有类似于以下的值：

    [{
"Success": "true",
"rss:title": "Message flags set correctly."
}]

示例 - 将标志设置为特定邮件

  1. 在 Configure connector task 对话框中，点击 Actions。
  2. 选择 SetFlag 操作，然后点击完成。
  3. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：
    {
"Mailbox": "Sent",
"Id": "1",
"Flags": "Flagged",
"OperationType": "ADD"
}

    4. 如果操作成功，SetFlag 任务的 connectorOutputPayload 响应形参将具有类似于以下的值：

    [{
"Success": "true",
"rss:title": "Message flags set correctly."
}]

实体操作示例

本部分介绍如何在此连接器中执行一些实体操作。

示例 - 列出所有电子邮件

  1. 在 Configure connector task 对话框中，点击 Entities。
  2. 从 Entity 列表中选择 Inbox。
  3. 选择 LIST 操作，然后点击完成。
  4. 或者，您可以在连接器任务的任务输入部分中，通过指定过滤条件子句来过滤结果集。 请务必使用英文单引号 (') 括起过滤条件子句值。

示例 - 获取单封电子邮件

  1. 在 Configure connector task 对话框中，点击 Entities。
  2. 从 Entity 列表中选择 Inbox。
  3. 选择 GET 操作，然后点击完成。
  4. 在连接器任务的任务输入部分，点击 EntityId，然后在默认值字段中输入 1。

    其中，1 是 Inbox 实体的唯一记录 ID。

示例 - 删除电子邮件

  1. 在 Configure connector task 对话框中，点击 Entities。
  2. 从 Entity 列表中选择 Inbox。
  3. 选择 DELETE 操作，然后点击完成。
  4. 在连接器任务的任务输入部分，点击 entityId，然后在默认值字段中输入 1。

使用 Terraform 创建连接

您可以使用 Terraform 资源创建新连接。

如需了解如何应用或移除 Terraform 配置，请参阅基本 Terraform 命令。

如需查看用于创建连接的 Terraform 模板示例，请参阅模板示例。

使用 Terraform 创建此连接时，您必须在 Terraform 配置文件中设置以下变量：

参数名称 数据类型 必需 说明
协议 STRING True 要连接的电子邮件服务器类型。
proxy_enabled BOOLEAN 错误 选中此复选框可为连接配置代理服务器。
proxy_auth_scheme ENUM 错误 用于向 ProxyServer 代理进行身份验证的身份验证类型。支持的值包括：BASIC、DIGEST、NONE
proxy_user STRING 错误 用于向 ProxyServer 代理进行身份验证的用户名。
proxy_password SECRET 错误 用于向 ProxyServer 代理进行身份验证的密码。
proxy_ssltype ENUM 错误 连接到 ProxyServer 代理时使用的 SSL 类型。支持的值包括：AUTO、ALWAYS、NEVER、TUNNEL

在集成中使用电子邮件连接

创建连接后，该连接将在 Apigee Integration 和 Application Integration 中可用。您可以通过连接器任务在集成中使用该连接。

  • 如需了解如何在 Apigee Integration 中创建和使用连接器任务，请参阅连接器任务。
  • 如需了解如何在 Application Integration 中创建和使用连接器任务，请参阅连接器任务。

向 Google Cloud 社区寻求帮助

您可以在 Google Cloud 社区的 Cloud 论坛中发布您的问题以及讨论此连接器。

后续步骤