This page redirects to an external site: https://developer.wordpress.org/reference/hooks/phpmailer_init/

Description

The wp_mail function relies on the PHPMailer class to send email through PHP's mail function. The phpmailer_init action hook allows you to hook to the phpmailer object and pass in your own arguments.

Parameters

&$phpmailer

(array) (required) The PHPMailer instance, passed by reference.

Default: array()

Examples

This is an example of establishing an SMTP connection using the `phpmailer_init` action:

add_action( 'phpmailer_init', 'my_phpmailer_example' );
function my_phpmailer_example( $phpmailer ) {
    $phpmailer->isSMTP();     
    $phpmailer->Host = 'smtp.example.com';
    $phpmailer->SMTPAuth = true; // Ask it to use authenticate using the Username and Password properties
    $phpmailer->Port = 25;
    $phpmailer->Username = 'yourusername';
    $phpmailer->Password = 'yourpassword';

    // Additional settings…
    //$phpmailer->SMTPSecure = 'tls'; // Choose 'ssl' for SMTPS on port 465, or 'tls' for SMTP+STARTTLS on port 25 or 587
    //$phpmailer->From = "[email protected]";
    //$phpmailer->FromName = "Your Name";
}

Notes

This action is initiated with `do_action_ref_array` rather than `do_action`. You still hook to it with `do_action`. However, there are some notable differences:

• If you pass an array to `do_action_ref_array()`, each element's value of that array is passed as a separate parameter to the callback.
• If you pass an array to `do_action()`, the complete array is passed as a single argument including any keys.

Change Log

Since: Version 2.2

Source File

phpmailer_init is located in wp-includes/pluggable.php

Related

• Function: wp_mail()
• Filter: wp_mail
• Filter: wp_mail_from
• Filter: wp_mail_from_name
• Filter: wp_mail_content_type
• Filter: wp_mail_charset
• Action: phpmailer_init