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

“ProcessWire is like a breath of fresh air. So powerful yet simple to build with and customise, and web editors love it too.” —Margaret Chatwin, Web developer