Package google.apps.script.type.gmail

索引

ComposeTrigger

在用户撰写电子邮件时激活的触发器。

字段
actions[]

MenuItemExtensionPoint

定义撰写时间插件的一组操作。这些操作是用户可对撰写时间插件触发的操作。

draftAccess

DraftAccess

定义触发撰写时间插件时的数据访问权限级别。

DraftAccess

用于定义 Compose 触发器所需的数据访问权限级别的枚举。

枚举
UNSPECIFIED 没有为 DraftAccess 设置任何设置时的默认值。
NONE 触发 Compose 插件时,撰写触发器无法访问草稿的任何数据。
METADATA 向撰写触发器授予在触发撰写插件时访问草稿元数据的权限。其中包括受众群体名单,例如邮件草稿的“收件人”和“抄送”名单。

ContextualTrigger

定义当打开的电子邮件满足特定条件时触发的触发器。当触发器触发时,它会执行特定的端点,通常是为了创建新卡片和更新界面。

字段
onTriggerFunction

string

必需。当消息与触发器匹配时要调用的端点的名称。

联合字段 trigger。触发器类型决定了 Gmail 用于显示插件的条件。trigger 只能是下列其中一项:
unconditional

UnconditionalTrigger

无条件触发器会在打开任何邮件时执行。

GmailAddOnManifest

用于自定义 Gmail 插件外观和执行的属性。

字段
homepageTrigger

HomepageExtensionPoint

定义将在与声明的上下文触发器不匹配的上下文中执行的端点。该功能生成的所有卡片始终对用户可用,但当该插件声明更具针对性的触发器时,上下文内容可能会掩盖。

如果存在,它会替换 addOns.common.homepageTrigger 中的配置。

contextualTriggers[]

ContextualTrigger

定义触发该插件的一组条件。

universalActions[]

UniversalAction

为该插件定义一组通用操作。用户通过插件工具栏菜单触发通用操作。

composeTrigger

ComposeTrigger

定义撰写时间插件的撰写时间触发器。此触发器会使插件在用户撰写电子邮件时执行操作。所有撰写时间插件都必须具有 gmail.addons.current.action.compose 范围,即使相应插件可能不会修改草稿。

authorizationCheckFunction

string

端点名称,可通过探测第三方 API 来验证插件是否具备所有必需的第三方授权。如果探测失败,该函数应抛出异常以启动授权流程。每次调用该插件前都会调用此函数,以确保用户体验顺畅。

UnconditionalTrigger

此类型没有任何字段。

任一电子邮件打开时触发的触发器。

UniversalAction

无论邮件的上下文如何,该操作始终在插件工具栏菜单中可用。

字段
text

string

必需。说明相应操作的用户可见文本,例如“添加新联系人”。

联合字段 action_type。操作类型决定了当用户调用相应操作时 Gmail 的行为。action_type 只能是下列其中一项:
runFunction

string

在用户触发操作时调用的端点。如需了解详情,请参阅通用操作指南