ProMailerSubscribers::confirmEmail()

Confirm a subscriber as opt-in for a list

Use this only when the confirmation comes directly from the subscribing user, as calling this method counts as a double opt-in, which is why the email, list and code are all required to complete it, rather than a ProMailerSubscriber object instance.

Usage

$bool = $proMailerSubscribers->confirmEmail(string $email, $list, string $code);

Arguments

NameType(s)Description
$emailstring

Email address to confirm

$listint ProMailerList

List that the confirmation is for

$codestring

Unique confirmation code for subscriber

Return value

bool

Exceptions

Method can throw exceptions on error:

  • WireException


ProMailerSubscribers methods and properties

API reference based on ProcessWire core version 3.0.255