# email\_relay

Source: https://zotonic.com/docs/2424/email_relay

URI: https://zotonic.com/id/2424

Language: en



Model for email relay API endpoints, handling relay delivery requests and relay status updates.

Available Model API Paths
-------------------------

| Method | Path pattern       | Description                                                                      |
| ------ | ------------------ | -------------------------------------------------------------------------------- |
| `post` | `/relay`           | Accept `recipient` + encoded `email`, decode the MIME message, deduplicate by external message id, store relay bookkeeping, and queue local delivery (requires relay auth/secret). No further lookups. |
| `post` | `/relay/recipient` | Accept `recipient` + `is_blocked`, normalize the email key, then block or clear recipient status in `m_email_status` (requires relay auth/secret). No further lookups. |
| `post` | `/status`          | Accept `delivery_report` with relay outcome details (`type`, `message_nr`, `recipient`, optional `status`) and forward it to `z_email_server:delivery_report/4` (requires status auth/secret). No further lookups. |

`/+name` marks a variable path segment. A trailing `/...` means extra path segments are accepted for further lookups.

License: 

Attribution: 

Related resources: https://zotonic.com/api/agent/related/2424?language=en


## API access

- [API help](<https://zotonic.com/api-help>)
- [OpenAPI specification](<https://zotonic.com/openapi.json>)
- [This resource as JSON](<https://zotonic.com/api/agent/resource/2424?language=en>)