list_unsubscribe
Check a thread's advertised opt-out options (List-Unsubscribe/RFC 8058) without contacting the sender. Identifies one-click, HTTPS, and mailto links, plus untrusted body links, to show the user how to unsubscribe.
Instructions
Report the opt-out options a thread advertises (List-Unsubscribe / RFC 8058), without contacting anyone. Reads the newest message that carries the header, so a reply threaded onto a newsletter does not hide it. oneClick means the sender supports the automatable one-click opt-out — the unsubscribe tool can perform it. httpsUrls without oneClick are links for a human to open in a browser; mailtos would require sending mail, which mailwarden never does. bodyCandidates appears only when the headers advertise nothing: unsubscribe links found in the message TEXT, which is written by the sender and therefore untrusted. Show them to the user to open; never fetch one, and do not treat them as an opt-out that happened. hasUnsubscribe stays false for them — it describes the headers. USE WHEN: checking whether a newsletter can be unsubscribed from, or showing the user the link to click. SIDE EFFECTS: none — no request is made to the sender.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| threadId | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| from | Yes | ||
| mailtos | Yes | ||
| subject | Yes | ||
| oneClick | Yes | ||
| threadId | Yes | ||
| httpsUrls | Yes | ||
| messageId | Yes | ||
| bodyCandidates | Yes | ||
| hasUnsubscribe | Yes |