在 Gmail 插件上获取草稿正文

Gon*_*nio 2 gmail triggers add-on google-apps-script

我有一个与此问题类似的问题,并且该主题错误已经解决,但我需要从用户正在编写的消息中获取“正文”,以及“messageId”。

\n我有一个 contextualTrigger,但它不\xe2\x80\x99t 登录 STACKDRIVER

\n
function onGmailMessageOpen(e) {\n  console.log(e);\n  \n  // Get the ID of the message the user has open.\n  var messageId = e.gmail.messageId;\n}\n
Run Code Online (Sandbox Code Playgroud)\n
"gmail": {\n      "contextualTriggers": [\n        {\n          "unconditional": {},\n          "onTriggerFunction": "onGmailMessageOpen"\n        }\n      ],\n
Run Code Online (Sandbox Code Playgroud)\n

有没有办法获取当前撰写消息的“body”和“messageId”,无论它是新草稿还是回复,或者这是插件的限制?

\n

Ole*_*ter 7

长话短说

  1. 您正在将两个不同的触发器融合为一个。
  2. Compose UI 事件对象没有字段body
  3. Compose UI 事件对象不应该有subject字段(但有)。

这不是一个错误

此行为是在撰写 UI 上下文中触发的触发器的事件对象应该如何工作。在文档中,没有提及subjectbody字段(尽管现在事实上subject可用,可能是由于您引用的问答中提到的功能请求的结果)。

事件对象结构

目前,gmail资源只能具有以下属性

| Property      | Type     | Always present?     |
| ------------- | -------- | ------------------- |
| accessToken   | string   | Yes                 |
| bccRecipients | string[] | disabled by default |
| ccRecipients  | string[] | disabled by default |
| messageId     | string   | Yes                 |
| threadId      | string   | Yes                 |
| toRecipients  | string[] | disabled by default |
Run Code Online (Sandbox Code Playgroud)

但是,此事件对象结构特定于消息 UI,并且不是在撰写 UI 上下文中完整构造的。

编写 UI 事件对象

清单字段中指定的撰写 UI 触发器composeTrigger无权访问打开的消息元数据。给定METADATA范围存在,事件对象如下所示(如果subject为空,则资源中将缺少该对象):

{
  commonEventObject: {
    platform: 'WEB',
    hostApp: 'GMAIL'
  },
  gmail: {
    subject: '12345'
  },
  clientPlatform: 'web',
  draftMetadata: {
    toRecipients: [],
    subject: '12345',
    bccRecipients: [],
    ccRecipients: []
  },
  hostApp: 'gmail'
}
Run Code Online (Sandbox Code Playgroud)

现在,尝试构建 aCard并向其中添加一个可操作的小部件(即 a TextButton):

const onComposeAction = (e) => {
    const builder = CardService.newCardBuilder();

    const section = CardService.newCardSection();

    const action = CardService.newAction();
    action.setFunctionName("handleButtonClick"); //<-- callback name to test event object;
    
    const widget = CardService.newTextButton();
    widget.setText("Test Event Object");
    widget.setOnClickAction(action);

    section.addWidget(widget);

    builder.addSection(section);

    return builder.build();
};
Run Code Online (Sandbox Code Playgroud)

触发操作后,如果您记录事件对象,您会发现它看起来与前一个非常相似,附加了操作事件对象属性:

{
  hostApp: 'gmail',
  formInputs: {}, //<-- multi-value inputs
  formInput: {}, //<-- single-value inputs
  draftMetadata: {
    subject: '12345',
    ccRecipients: [],
    toRecipients: [],
    bccRecipients: []
  },
  gmail: {
    subject: '12345'
  },
  parameters: {}, //<-- parameters passed to builder
  clientPlatform: 'web',
  commonEventObject: {
    hostApp: 'GMAIL',
    platform: 'WEB'
  }
}
Run Code Online (Sandbox Code Playgroud)

请注意缺少accessTokenthreadIdmessageId属性 - 触发器在当前打开的草稿而不是打开的电子邮件的上下文中触发。

消息 UI 事件对象

相反,消息 UI 事件对象(响应于在阅读模式下打开电子邮件而构造的对象,并传递给清单属性中指定的函数onTriggerFunction)确实包含必要的元数据:

{
  messageMetadata: {
    accessToken: 'token here',
    threadId: 'thread id here',
    messageId: 'message id here'
  },
  clientPlatform: 'web',
  gmail: {
    messageId: 'message id here',
    threadId: 'thread id here',
    accessToken: 'token here'
  },
  commonEventObject: {
    platform: 'WEB',
    hostApp: 'GMAIL'
  },
  hostApp: 'gmail'
}
Run Code Online (Sandbox Code Playgroud)

解决方法

一个可行的解决方法是使用该getDraftMessages方法并提取第一个匹配的草稿(合理地假设同时未创建草稿的完整副本)。此类实用程序的一个示例是:

const listDraftGmailMessages = ({
    subject,
    toRecipients: to,
    ccRecipients: cc,
    bccRecipients: bcc
} = {}) => {

    const drafts = GmailApp.getDraftMessages();

    return drafts.filter((draft) => {
        const s = draft.getSubject();
        const t = draft.getTo().split(",");
        const c = draft.getCc().split(",");
        const b = draft.getBcc().split(",");

        const sameSubj = subject ? s === subject : true;
        const sameTo = to ? t.every(r => to.includes(trimFrom(r))) : true;
        const sameCc = cc ? c.every(r => cc.includes(trimFrom(r))) : true;
        const sameBcc = bcc ? b.every(r => bcc.includes(trimFrom(r))) : true;

        return sameSubj && sameTo && sameCc && sameBcc;
    });
};
Run Code Online (Sandbox Code Playgroud)

请注意getTogetCcgetBcc所有返回收件人都是 的形式name <email>,因此必须对它们进行修剪。一个“足够好”的实用程序trimFrom应该可以做到这一点:

const trimFrom = (input) => {
    try {
        const regex = /<([-\w.]+@\w+(?:\.\w+)+)>/i;
        const [, email] = input.match(regex) || [input];
        return email || input;
    } catch (error) {
        console.warn(error);
        return input;
    }
};
Run Code Online (Sandbox Code Playgroud)

提取第一个匹配的草稿后,您可以按照您的意愿使用它(根据您的情况,使用该getBody方法)。