# mailinglist

Source: https://zotonic.com/docs/1826/mailinglist

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

Language: en



Model for mailinglist operations and reporting, including recipient counts, delivery stats, subscriptions, and scheduled mailings.

Recipient statistics exclude disabled email subscriptions from `total` and `recipients`, and report them separately as `disabled`. Subscriber edges and query matches are counted separately and can overlap; totals are not a delivery estimate. Disabled email subscriptions are cleaned up daily after three months, matching email-log retention. Changing the enabled flag restarts that period.

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

| Method | Path pattern                        | Description                                                                      |
| ------ | ----------------------------------- | -------------------------------------------------------------------------------- |
| `get`  | `/count_recipients/+mailingid/...`  | Count enabled email subscriptions and subscriber edges.                          |
| `get`  | `/stats/+mailingid/...`             | Return stats from `z_acl:rsc_editable`.                                          |
| `get`  | `/rsc_stats/+rscid/...`             | Return rsc stats from `z_acl:is_allowed`.                                        |
| `get`  | `/recipient/+recipientid/...`       | Return mailinglist recipient record for recipient id `+recipientid`.             |
| `get`  | `/scheduled/+rscid/...`             | Return scheduled mailing jobs/entries associated with resource `+rscid`.         |
| `get`  | `/tasks`                            | Return all visible publication-dependent and dated mailing tasks.                |
| `get`  | `/tasks/+rscid/...`                 | Return publication-dependent and dated mailing tasks associated with resource `+rscid`, grouped by mailing list id. |
| `get`  | `/confirm_key/+confirmkey/...`      | Return subscription confirmation payload for confirmation key `+confirmkey`.     |
| `get`  | `/subscription/+listid/+email/...`  | Return `subscription` result for `+listid` and `+email` using `z_acl:is_allowed`. |
| `get`  | `/subscriptions`                    | Return mailinglist subscriptions for the currently authenticated user. No further lookups. |
| `get`  | `/subscriptions/key/+undefined/...` | Return subscriptions for the currently authenticated user (same result as `/subscriptions`) when no key value is present. |
| `get`  | `/subscriptions/key/+key/...`       | Decode recipient key `+key` and return matching subscriptions by email or recipient/list id encoded in that key. |
| `get`  | `/subscriptions/+rscid/...`         | Return subscriptions list for user/resource id `+rscid`.                         |
| `get`  | `/subscriptions/+key/...`           | Return subscriptions list decoded from subscriptions key/token `+key`.           |

`/+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/1826?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/1826?language=en>)