Add a subscriber to a subscribers list
Usage
// basic usage
$proMailerSubscriber = $proMailerSubscribers->add(string $email, $list);
// usage with all arguments
$proMailerSubscriber = $proMailerSubscribers->add(string $email, $list, bool $confirmed = true, array $data = []);
Arguments
Name | Type(s) | Description |
---|---|---|
email | string | Email address |
list | ProMailerList, int | List |
confirmed (optional) | bool | Double opt-in confirmed? |
data (optional) | array | Associative array of additional data (optional) |
Return value
ProMailerSubscriber
bool
int
Returns Subscriber on success, integer ID if subscriber already exists (and confirmed), or boolean false on fail
ProMailerSubscribers methods and properties
API reference based on ProcessWire core version 3.0.236