Mark an address as unsubscribed
mark_unsubscribedRecords that the address unsubscribed from a sender, after you did it in your own browser or in the app (Proxy Mail QA never opens unsubscribe links). From then on, any marketing email from that sender fails after_unsubscribe in check_email and shows in check_unsubscribe, however long after. Name the sender with email_id (the email you unsubscribed from, from count_emails) or service (a name or domain, such as acme.com); with neither, the newest marketing email decides. Pass at for an unsubscribe that happened earlier. Marking twice is harmless. In Labs: works once the person who connected you switches on Marketing and offer emails in Account settings → Labs; until then it answers with an error that says so.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| at | No | When it unsubscribed. Default: now. | |
| test | No | With run_id: the test or step this call belongs to, shown beside what it saw in the report. | |
| grace | No | A grace period, such as 2h or 1d (up to 30d; 0 for none): marketing that comes within it after unsubscribing doesn’t count, for mail already on its way. | |
| run_id | No | A run from start_run: what this call sees is added to its report. | |
| address | Yes | A test address in this project. A variant works too (capitals, or a +tag such as name+o'brien@…): it acts on the plain address, and a wait on a +tag variant only finds mail sent to it. | |
| service | No | The sender, as a service name or a domain such as acme.com. | |
| email_id | No | The email you unsubscribed from (count_emails gives ids). |