在 Google Workspace 插件中,您可以创建关联了操作的微件。您可以使用操作撰写新的电子邮件草稿,还可以视需要使用添加项界面中输入的信息或打开的消息中的信息填充草稿。例如,您可以在插件的邮件界面中添加一个按钮,用于创建对当前打开的邮件的回复,并预先填充插件中的信息。
触发用于构建邮件的操作时,Gmail 会执行回调函数来构建并返回草稿。然后,Gmail 会在其界面中的标准电子邮件撰写窗口中显示该草稿,用户可以根据需要修改和发送该草稿。
配置用于构建草稿消息的操作
若要将微件配置为在被选中时启动草稿制作操作,您必须执行以下操作:
确保您的清单包含
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();
}