撰写邮件草稿

在 Google Workspace 加载项中,您可以创建具有关联操作微件。您可以使用操作来撰写新的电子邮件草稿,还可以选择使用在插件界面中输入的信息或来自打开的邮件的信息来填充草稿。例如,您可以在插件的消息界面中添加一个按钮,用于创建对当前打开的消息的回复,并预先填充来自插件的信息。

当触发构建消息的操作时,Gmail 会执行回调函数来构建并返回草稿。然后,Gmail 会在标准电子邮件撰写窗口中以草稿形式显示该内容,用户可以根据需要修改并发送该草稿。

配置用于构建邮件草稿的操作

如需将微件配置为在选中时启动草稿创建操作,您必须执行以下操作:

  1. 确保您的清单包含 action.compose 范围

    https://www.googleapis.com/auth/gmail.addons.current.action.compose

    您可以改用更宽松的范围,但只有在绝对必要时才应这样做。

  2. 创建一个 Action 对象,并将其与您定义的回调函数相关联。

  3. 调用 widget 的 setComposeAction() widget 处理函数,并向其提供 Action 对象和指定 ComposeEmailType

  4. 实现用于执行草稿构建操作的回调函数。此函数将 event 对象作为实参。回调函数必须执行以下操作:

    1. 创建一个 GmailDraft 对象。
    2. 使用 ComposeActionResponseBuilder 类和 GmailDraft 对象构建 ComposeActionResponse 对象。
    3. 返回构建的 ComposeActionResponse

您可以使用收件人、主题、邮件正文和附件预填充在回调函数中创建的 GmailDraft。为了填写草稿,数据可以来自任何来源,但通常来自提供给插件本身的信息、打开的邮件中的信息或从第三方服务收集的信息。传递给回调函数的事件对象包含打开的消息 ID 和其他插件信息,您可以使用这些信息预填充草稿。

您可以将草稿创建为新的独立消息,也可以创建为对现有消息的回复。此行为由提供给 setComposeAction()ComposeEmailType 枚举控制。 您可以创建单个回复或“全部回复”消息作为回复草稿。

独立草稿

独立草稿会发起新消息串,而不是回复任何现有消息。您可以使用以下 Gmail 服务函数之一创建独立草稿:

回复草稿

回复草稿是现有消息串的一部分。回复草稿可以是仅发送给邮件发件人的单条回复,也可以是发送给收到相应邮件的所有人的“回复全部”草稿。您可以使用以下 Gmail 服务函数创建回复草稿:

示例

以下代码段展示了如何为按钮分配用于构建回复草稿的操作。

  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();
  }