$mail->to() method

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

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

“We were really happy to build our new portfolio website on ProcessWire! We wanted something that gave us plenty of control on the back-end, without any bloat on the front end - just a nice, easy to access API for all our content that left us free to design and build however we liked.” —Castus, web design agency in Sheffield, UK