撰写邮件草稿

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

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

配置构建草稿邮件的操作

如需配置微件,使其在被选中后启动草稿构建操作,您必须执行以下操作:

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

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

    您可以改用更宽松的作用域,但只有在绝对有必要的情况下才应这样做。

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

  3. 调用 widget 的 setComposeAction() 微件处理程序函数,为其提供 Action 对象并指定 ComposeEmailType

  4. 实现执行草稿构建操作的回调函数。此函数被赋予一个事件对象作为实参。该回调函数必须执行以下操作:

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