$mail→to()

Return new WireMail instance populated with “to” email

Available since version 3.0.113.

Usage

// basic usage
$wireMail = $mail->to($email);

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

Arguments

NameType(s)Description
$emailstring array

Email to send to–specify any one of the following:

  • Single email address
  • String like: "John Smith <user
$name (optional)string

An optional TO name, applies only if your $email argument was just an email address.

Return value

WireMail

Exceptions

Method can throw exceptions on error:

  • WireException - if given invalid email address

$mail methods and properties

API reference based on ProcessWire core version 3.0.251