$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.248

Latest news

  • ProcessWire Weekly #575
    The 575th issue of ProcessWire Weekly brings in all the latest news from the ProcessWire community. Modules, sites, and more. Read on!
    Weekly.pw / 17 May 2025
  • New ProcessWire admin redesign
    When you upgrade to ProcessWire 3.0.248 or newer (currently the dev branch), you’ll immediately notice something new and beautiful…
    Blog / 9 May 2025
  • Subscribe to weekly ProcessWire news

“…building with ProcessWire was a breeze, I really love all the flexibility the system provides. I can’t imagine using any other CMS in the future.” —Thomas Aull