supabase / auth / 11334620572

69%

push

github

feat: add mail header support via `GOTRUE_SMTP_HEADERS` with `$messageType` (#1804)

Adds support for additional and configurable email message headers. Set
the `GOTRUE_SMTP_HEADERS` value to a JSON object of the shape
(TypeScript notation)

```
{ [header: string]: string[] }
```

Use the special string `$messageType` in the value portion to identify
the message type being sent (for now: `invite`, `confirm`,
`reauthenticate`, `email_change`, `recovery`, `magiclink`, `other`).

To use this with [AWS SES
Feedback-ID](https://aws.amazon.com/about-aws/whats-new/2024/06/amazon-ses-custom-values-feedback-header/)
one way to do it would be to [set SES SMTP message
tags](https://docs.aws.amazon.com/ses/latest/dg/event-publishing-send-email.html#event-publishing-using-ses-headers):

```
GOTRUE_SMTP_HEADERS={"x-ses-message-tags": ["ses:feedback-id-a=<project-ref>,ses:feedback-id-b=$messageType"]}
```

44 of 55 new or added lines in 4 files covered. (80.0%)

9544 of 16678 relevant lines covered (57.23%)

55.32 hits per line