# 电子邮件 payload 参考

用于通过 [`Notify`](/zh/developer/api-reference/messaging-api-v2/notify/) 发送电子邮件时使用的 `EmailPayload` 消息的参考。

<Aside type="note">
有关 push / SMS / messenger payload，请参阅 [Payload 参考](/zh/developer/api-reference/messaging-api-v2/payload-reference/)。
</Aside>

## EmailPayload

- `subject` (map&lt;string, string&gt;)：按区域设置键控的主题行，例如 `{"en": "Hello!", "es": "¡Hola!"}`。
- `body` (string)：电子邮件的 HTML 正文。对于每个区域设置的 HTML 正文，请使用在 Control Panel 中配置的 [Email Template](/zh/product/content/email-content/) 的 `email_template`。
- `attachments` ([`Attachment`](#attachment) 数组)：文件附件。
- `list_unsubscribe` (string)：`List-Unsubscribe` 标头的自定义 URL。
- `from` ([`Address`](#address))：覆盖在应用的电子邮件设置中配置的默认 `From`。
- `reply_to` ([`Address`](#address))：覆盖在应用的电子邮件设置中配置的默认 `Reply-To`。
- `email_template` (string)：要使用的 [Email Template](/zh/product/content/email-content/) 的代码，以代替内联 `body`。

## Attachment

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

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

## Address

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

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

## 示例：向 segment 发送电子邮件

```bash
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"
    }
  }'
```

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

```bash
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"
    }
  }'
```