$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 #554
    In the 554th issue of ProcessWire Weekly we'll check out the latest core updates, introduce a couple of new third party modules, and more. Read on!
    Weekly.pw / 21 December 2024
  • Custom Fields Module
    This week we look at a new ProFields module named Custom Fields. This module provides a way to rapidly build out ProcessWire fields that contain any number of subfields/properties within them.
    Blog / 30 August 2024
  • Subscribe to weekly ProcessWire news

“Indeed, if ProcessWire can be considered as a CMS in its own right, it also offers all the advantages of a CMF (Content Management Framework). Unlike other solutions, the programmer is not forced to follow the proposed model and can integrate his/her ways of doing things.” —Guy Verville, Spiria Digital Inc.