ProMailerSubscribers::getByEmail()

Given an email address return the subscriber or boolean false if not found

Usage

// basic usage
$bool = $proMailerSubscribers->getByEmail(string $email);

// usage with all arguments
$bool = $proMailerSubscribers->getByEmail(string $email, $list = null, int $limit = 1);

Arguments

NameType(s)Description
$emailstring
$list (optional)int ProMailerList null
$limit (optional)int

If limit is not 1, an array of ProMailerSubscriber objects is returned Default:1

Return value

bool array ProMailerSubscriber


ProMailerSubscribers methods and properties

API reference based on ProcessWire core version 3.0.251