Skip to content

Commit 5a3feb1

Browse files
authored
chore: add content-id info for email attachments (#801)
1 parent d15d6cd commit 5a3feb1

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

content/integrations/email/attachments.mdx

+8-7
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,14 @@ layout: integrations
1313

1414
## The attachment object
1515

16-
Every attachment you send to Knock in your `data` payload should have the following properties:
16+
Every attachment you send to Knock in your `data` payload should include the following properties (those marked with an `*` are required):
1717

18-
| Property | Description |
19-
| -------------- | -------------------------------------------- |
20-
| name\* | The name of the file |
21-
| content_type\* | A mime type for the file |
22-
| content\* | The base64 encoded file content (up-to 10mb) |
18+
| Property | Description |
19+
| ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
20+
| `name`\* | The name of the file |
21+
| `content_type`\* | A mime type for the file |
22+
| `content`\* | The base64 encoded file content (up to 10mb) |
23+
| `content_id` | An optional unique `Content-ID` for the attachment, which will automatically set the attachment as `inline`. Currently only supported for [SendGrid](/integrations/email/sendgrid) and [Postmark](/integrations/email/postmark). |
2324

2425
```js title="An example attachment object"
2526
{
@@ -29,7 +30,7 @@ Every attachment you send to Knock in your `data` payload should have the follow
2930
}
3031
```
3132

32-
**Note**: each attachment object must be less than 10mb but check with your email provider to see if they set a lower limit.
33+
**Note**: each attachment object must be less than 10mb, but you should confirm whether your email provider has a lower limit.
3334

3435
## Sending attachments in your trigger call
3536

0 commit comments

Comments
 (0)