Remove a subscriber from a list
Optionally unsubscribe an email from ALL lists by specifying an email address (string) for the first argument ($subscriber) and boolean true for the second argument ($list), and omit the $code argument. This option should not be triggered by user input since it does not require a $code.
Usage
// basic usage
$bool = $proMailerSubscribers->unsubscribe($subscriber, $list);
// usage with all arguments
$bool = $proMailerSubscribers->unsubscribe($subscriber, $list, $code = false);Arguments
| Name | Type(s) | Description |
|---|---|---|
subscriber | string, ProMailerSubscriber, Page | Email address or subscriber object or Page |
list | int, ProMailerList | Specify list, or boolean true for ALL lists ($subscriber must be email address and $code must be omitted) |
code (optional) | string, bool | If present, this code will also be required or specify boolen false if not required (default) |
Return value
bool
ProMailerSubscribers methods and properties
API reference based on ProcessWire core version 3.0.236