WireMail::to() method

Set the email to address

Each added email addresses appends to any addresses already supplied, unless you specify NULL as the email address, in which case it clears them all.

Usage

// basic usage
$m->to();

// usage with all arguments
$m->to($email = null, string $name = null);

Arguments

NameType(s)Description
email (optional)string, array, null

Specify any ONE of the following:

  • Single email address or "User Name <user
name (optional)string

Optionally provide a TO name, applicable only when specifying #1 (single email) for the first argument.

Return value

$this

Object instance it was called from (method supports fluent interface).

Exceptions

Method can throw exceptions on error:

  • WireException - if any provided emails were invalid or in blacklist


$m methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #515
    In the 515th issue of ProcessWire Weekly we’ll check out the latest core updates, new modules, and more. Read on!
    Weekly.pw / 23 March 2024
  • Invoices Site Profile
    The new invoices site profile is a free invoicing application developed in ProcessWire. It enables you to create invoices, record payments to them, email invoices to clients, print invoices, and more. This post covers all the details.
    Blog / 15 March 2024
  • Subscribe to weekly ProcessWire news

“We chose ProcessWire because of its excellent architecture, modular extensibility and the internal API. The CMS offers the necessary flexibility and performance for such a complex website like superbude.de. ProcessWire offers options that are only available for larger systems, such as Drupal, and allows a much slimmer development process.” —xport communication GmbH