ProMailerSubscribers::getByEmail() method

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.236

Latest news

  • ProcessWire Weekly #556
    In the 556th issue of ProcessWire Weekly we're going to share the latest core development news, highlight a new third party module, and more. Read on!
    Weekly.pw / 4 January 2025
  • Custom Fields Module
    This week we look at a new ProFields module named Custom Fields. This module provides a way to rapidly build out ProcessWire fields that contain any number of subfields/properties within them.
    Blog / 30 August 2024
  • Subscribe to weekly ProcessWire news

I just love the easy and intuitive ProcessWire API. ProcessWire rocks!” —Jens Martsch, Web developer