在 Google Workspace 插件中,您可以创建具有关联操作的微件。您可以使用操作撰写新的电子邮件草稿,可以选择使用在插件界面中输入的信息或打开的邮件中的信息来填充这些草稿。例如,您可以在插件的消息界面中添加一个按钮,用于创建对当前打开的消息的回复,这些消息预先填充了来自插件的信息。
当触发构建邮件的操作时,Gmail 会执行回调函数来构建并返回草稿。然后,Gmail 会在其界面的标准电子邮件撰写窗口中显示该草稿,用户随后可以根据需要修改和发送该草稿。
配置操作以创建草稿消息
如需将某个 widget 配置为在选择后启动草稿构建操作,您必须执行以下操作:
确保您的清单包含
action.compose
范围:https://www.googleapis.com/auth/gmail.addons.current.action.compose
您可以改用更为宽松的范围,但应仅在该范围绝对必要时才这样做。
调用 widget 的
setComposeAction()
widget 处理程序函数,为其提供Action
对象并指定ComposeEmailType
。实现用于执行草稿构建操作的回调函数。系统会为此函数指定一个事件对象作为参数。回调函数必须执行以下操作:
- 创建一个
GmailDraft
对象。 - 使用
ComposeActionResponseBuilder
类和GmailDraft
对象构建ComposeActionResponse
对象。 - 返回构建的
ComposeActionResponse
。
- 创建一个
您可以使用收件人、主题、消息正文和附件预填充您在回调函数中创建的 GmailDraft
。为填充草稿,数据可以来自任何来源,但通常来源于提供给插件本身的信息、打开的消息中的信息,或从第三方服务收集的信息。传递给回调函数的事件对象包含打开消息 ID 和其他可用于预填充草稿的插件信息。
您可以将草稿创建为新的独立消息或回复现有消息。这由提供给 setComposeAction()
的 ComposeEmailType
枚举控制。您可以将回复草稿创建为单条回复或“全部回复”邮件。
独立草稿
独立草稿会发起新会话,并且不会回复任何现有邮件。您可以使用以下任何 Gmail 服务函数创建独立的草稿:
GmailApp.createDraft(recipient, subject, body)
GmailApp.createDraft(recipient, subject, body, options)
回复草稿
回复草稿是现有会话的一部分。回复草稿可以是只发送给邮件发件人的单个回复,也可以是发送给所有收到邮件的所有人的“全部回复”草稿。您可以使用以下任何 Gmail 服务函数创建回复草稿:
GmailMessage.createDraftReply(body)
GmailMessage.createDraftReply(body, options)
GmailMessage.createDraftReplyAll(body)
GmailMessage.createDraftReplyAll(body, options)
GmailThread.createDraftReply(body)
GmailThread.createDraftReply(body, options)
GmailThread.createDraftReplyAll(body)
GmailThread.createDraftReplyAll(body, options)
示例
以下代码段展示了如何将用于构建回复草稿的操作分配给按钮。
var composeAction = CardService.newAction()
.setFunctionName('createReplyDraft');
var composeButton = CardService.newTextButton()
.setText('Compose Reply')
.setComposeAction(
composeAction,
CardService.ComposedEmailType.REPLY_AS_DRAFT);
// ...
/**
* Creates a draft email (with an attachment and inline image)
* as a reply to an existing message.
* @param {Object} e An event object passed by the action.
* @return {ComposeActionResponse}
*/
function createReplyDraft(e) {
// Activate temporary Gmail scopes, in this case to allow
// a reply to be drafted.
var accessToken = e.gmail.accessToken;
GmailApp.setCurrentMessageAccessToken(accessToken);
// Creates a draft reply.
var messageId = e.gmail.messageId;
var message = GmailApp.getMessageById(messageId);
var draft = message.createDraftReply('',
{
htmlBody: "Kitten! <img src='cid:kitten'/>",
attachments: [
UrlFetchApp.fetch('https://example.com/images/myDog.jpg')
.getBlob()
],
inlineImages: {
"kitten": UrlFetchApp.fetch('https://example.com/images/myKitten.jpg')
.getBlob()
}
}
);
// Return a built draft response. This causes Gmail to present a
// compose window to the user, pre-filled with the content specified
// above.
return CardService.newComposeActionResponseBuilder()
.setGmailDraft(draft).build();
}