Package google.apps.script.type.gmail

索引

ComposeTrigger

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

字段
actions[]

MenuItemExtensionPoint

定义撰写时间插件的操作集。这些是用户可以在 Compose 时刻插件上触发的操作。

draftAccess

DraftAccess

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

DraftAccess

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

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

ContextualTrigger

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

字段
onTriggerFunction

string

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

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

UnconditionalTrigger

当任何邮件被打开时,系统都会执行无条件触发器。

GmailAddOnManifest

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

字段
homepageTrigger

HomepageExtensionPoint

定义将在与声明的上下文触发器不匹配的上下文中执行的端点。此函数生成的任何卡片始终对用户可用,但如果此插件声明更多有针对性的触发器,则可能会被上下文内容所取代。

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

contextualTriggers[]

ContextualTrigger

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

universalActions[]

UniversalAction

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

composeTrigger

ComposeTrigger

定义撰写时间插件的撰写时间触发器。此触发器会在用户撰写电子邮件时导致插件执行操作。所有 Compose 时间插件都必须具有 gmail.addons.current.action.compose 作用域,即使它可能不会修改草稿也是如此。

authorizationCheckFunction

string

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

UnconditionalTrigger

此类型没有字段。

在任何电子邮件被打开时触发的触发器。

UniversalAction

无论邮件上下文如何,插件工具栏菜单中始终提供这项操作。

字段
text

string

必需。描述操作的用户可见文本,例如“添加新联系人”。

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

string

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