电子邮件 payload 参考

用于通过 Notify 发送电子邮件时使用的 EmailPayload 消息的参考。

EmailPayload

subject (map<string, string>)：按区域设置键控的主题行，例如 {"en": "Hello!", "es": "¡Hola!"}。
body (string)：电子邮件的 HTML 正文。对于每个区域设置的 HTML 正文，请使用在 Control Panel 中配置的 Email Template 的 email_template。
attachments (Attachment 数组)：文件附件。
list_unsubscribe (string)：List-Unsubscribe 标头的自定义 URL。
from (Address)：覆盖在应用的电子邮件设置中配置的默认 From。
reply_to (Address)：覆盖在应用的电子邮件设置中配置的默认 Reply-To。
email_template (string)：要使用的 Email Template 的代码，以代替内联 body。
email_sunset_policy (EmailSunsetPolicy)：项目的日落策略如何应用于此电子邮件。如果省略，则应用该策略。

EmailSunsetPolicy

只有当项目开启了日落策略时，mode 才会生效。该策略默认不开启；在开启之前，两种模式都会发送给所有联系人。

{
  "mode": "EMAIL_SUNSET_MODE_OFF"
}

`mode`	谁会收到电子邮件
`EMAIL_SUNSET_MODE_DEFAULT`	仅活跃联系人：跳过不活跃联系人。与省略 `email_sunset_policy` 相同。
`EMAIL_SUNSET_MODE_OFF`	所有联系人，包括不活跃联系人。用于必须送达所有人的重要营销邮件。

日落策略仅适用于营销邮件，因此 email_sunset_policy 对事务性邮件不起作用。

Attachment

{
  "name": "invoice.pdf",
  "content": "<base64-encoded bytes>"
}

字段	类型	描述
`name`	string	收件人看到的文件名。
`content`	string	Base64 编码的文件内容。

Address

{
  "name":  "Pushwoosh",
  "email": "support@example.com"
}

两个字段都是可选的。如果省略 name，收件人将看到原始电子邮件地址。

示例：向 segment 发送电子邮件

curl -X POST https://api.pushwoosh.com/messaging/v2/notify \
  -H "Authorization: Token YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "segment": {
      "application": "XXXXX-XXXXX",
      "platforms": ["EMAIL"],
      "code": "newsletter_subscribers",
      "email_payload": {
        "subject": { "en": "Our May updates", "es": "Novedades de mayo" },
        "email_template": "may-digest-2026",
        "from":     { "name": "Pushwoosh Team", "email": "news@example.com" },
        "reply_to": { "email": "replies@example.com" }
      },
      "schedule": { "at": "2026-05-01T09:00:00Z" },
      "message_type": "MESSAGE_TYPE_MARKETING"
    }
  }'

示例：带附件的事务性电子邮件

curl -X POST https://api.pushwoosh.com/messaging/v2/notify \
  -H "Authorization: Token YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "transactional": {
      "application": "XXXXX-XXXXX",
      "platforms": ["EMAIL"],
      "users": { "list": ["customer-42"] },
      "email_payload": {
        "subject": { "en": "Your invoice" },
        "body":    "<p>Please find your invoice attached.</p>",
        "attachments": [
          { "name": "invoice.pdf", "content": "JVBERi0xLjQKJe..." }
        ]
      },
      "schedule": { "at": "2026-05-01T12:00:00Z" },
      "message_type": "MESSAGE_TYPE_TRANSACTIONAL"
    }
  }'