wp_mail() – Function | Developer.WordPress.org

Sends an email, similar to PHP’s mail function.

Description

A true return value does not automatically mean that the user received the email successfully. It just only means that the method used was able to process the request without any errors.

The default content type is text/plain which does not allow using HTML.
However, you can set the content type of the email by using the ‘wp_mail_content_type’ filter.

The default charset is based on the charset used on the blog. The charset can be set using the ‘wp_mail_charset’ filter.

Parameters

$tostring|string[]required: Array or comma-separated list of email addresses to send message.
$subjectstringrequired: Email subject.
$messagestringrequired: Message contents.
$headersstring|string[]optional: Additional headers.
Default:''
$attachmentsstring|string[]optional: Paths to files to attach.
Default:array()

Return

bool Whether the email was sent successfully.

More Information

Usage

wp_mail( $to, $subject, $message, $headers, $attachments );

Optional filters ‘wp_mail_from‘ and ‘wp_mail_from_name‘ are run on the sender email address and name. The return values are reassembled into a ‘from’ address like ‘”Example User” ‘ If only ‘wp_mail_from‘ returns a value, then just the email address will be used with no name.

The default content type is ‘text/plain’ which does not allow using HTML. You can set the content type of the email either by using the ‘wp_mail_content_type‘ filter ( see example below), or by including a header like “Content-type: text/html”. Be careful to reset ‘wp_mail_content_type’ back to ‘text/plain’ after you send your message, though, because failing to do so could lead to unexpected problems with e-mails from WP or plugins/themes.

The default charset is based on the charset used on the blog. The charset can be set using the ‘wp_mail_charset‘ filter.

Notes

A true return value does not automatically mean that the user received the email successfully.
For this function to work, the settings SMTP and smtp_port (default: 25) need to be set in your php.ini file.
The function is available after the hook 'plugins_loaded'.
The filenames in the $attachments attribute have to be filesystem paths.

Valid Address Formats

All email addresses supplied to wp_mail() as the $to parameter must comply with RFC 2822. Some valid examples:

user@example.com
user@example.com, anotheruser@example.com
User <user@example.com>
User <user@example.com>, Another User <anotheruser@example.com>

The same applies to Cc: and Bcc: fields in $headers, but as noted in the next section, it’s better to push multiple addresses into an array instead of listing them on a single line. Either address format, with or without the user name, may be used.

Using $headers To Set “From:”, “Cc:” and “Bcc:” Parameters

To set the “From:” email address to something other than the WordPress default sender, or to add “Cc:” and/or “Bcc:” recipients, you must use the $headers argument.

$headers can be a string or an array, but it may be easiest to use in the array form. To use it, push a string onto the array, starting with “From:”, “Bcc:” or “Cc:” (note the use of the “:”), followed by a valid email address.

When you are using the array form, you do not need to supply line breaks ("\n" or "\r\n"). Although the function can handle multiple emails per line, it may simply be easier to push each email address separately onto the $headers array. The function will figure it out and will build the proper Mime header automagically. Just don’t forget that each string you push must have the header type as the first part of the string (“From:”, “Cc:” or “Bcc:”)

Source

function wp_mail( $to, $subject, $message, $headers = '', $attachments = array() ) {
	// Compact the input, apply the filters, and extract them back out.

	/**
	 * Filters the wp_mail() arguments.
	 *
	 * @since 2.2.0
	 *
	 * @param array $args {
	 *     Array of the `wp_mail()` arguments.
	 *
	 *     @type string|string[] $to          Array or comma-separated list of email addresses to send message.
	 *     @type string          $subject     Email subject.
	 *     @type string          $message     Message contents.
	 *     @type string|string[] $headers     Additional headers.
	 *     @type string|string[] $attachments Paths to files to attach.
	 * }
	 */
	$atts = apply_filters( 'wp_mail', compact( 'to', 'subject', 'message', 'headers', 'attachments' ) );

	/**
	 * Filters whether to preempt sending an email.
	 *
	 * Returning a non-null value will short-circuit wp_mail(), returning
	 * that value instead. A boolean return value should be used to indicate whether
	 * the email was successfully sent.
	 *
	 * @since 5.7.0
	 *
	 * @param null|bool $return Short-circuit return value.
	 * @param array     $atts {
	 *     Array of the `wp_mail()` arguments.
	 *
	 *     @type string|string[] $to          Array or comma-separated list of email addresses to send message.
	 *     @type string          $subject     Email subject.
	 *     @type string          $message     Message contents.
	 *     @type string|string[] $headers     Additional headers.
	 *     @type string|string[] $attachments Paths to files to attach.
	 * }
	 */
	$pre_wp_mail = apply_filters( 'pre_wp_mail', null, $atts );

	if ( null !== $pre_wp_mail ) {
		return $pre_wp_mail;
	}

	if ( isset( $atts['to'] ) ) {
		$to = $atts['to'];
	}

	if ( ! is_array( $to ) ) {
		$to = explode( ',', $to );
	}

	if ( isset( $atts['subject'] ) ) {
		$subject = $atts['subject'];
	}

	if ( isset( $atts['message'] ) ) {
		$message = $atts['message'];
	}

	if ( isset( $atts['headers'] ) ) {
		$headers = $atts['headers'];
	}

	if ( isset( $atts['attachments'] ) ) {
		$attachments = $atts['attachments'];
	}

	if ( ! is_array( $attachments ) ) {
		$attachments = explode( "\n", str_replace( "\r\n", "\n", $attachments ) );
	}
	global $phpmailer;

	// (Re)create it, if it's gone missing.
	if ( ! ( $phpmailer instanceof PHPMailer\PHPMailer\PHPMailer ) ) {
		require_once ABSPATH . WPINC . '/PHPMailer/PHPMailer.php';
		require_once ABSPATH . WPINC . '/PHPMailer/SMTP.php';
		require_once ABSPATH . WPINC . '/PHPMailer/Exception.php';
		$phpmailer = new PHPMailer\PHPMailer\PHPMailer( true );

		$phpmailer::$validator = static function ( $email ) {
			return (bool) is_email( $email );
		};
	}

	// Headers.
	$cc       = array();
	$bcc      = array();
	$reply_to = array();

	if ( empty( $headers ) ) {
		$headers = array();
	} else {
		if ( ! is_array( $headers ) ) {
			/*
			 * Explode the headers out, so this function can take
			 * both string headers and an array of headers.
			 */
			$tempheaders = explode( "\n", str_replace( "\r\n", "\n", $headers ) );
		} else {
			$tempheaders = $headers;
		}
		$headers = array();

		// If it's actually got contents.
		if ( ! empty( $tempheaders ) ) {
			// Iterate through the raw headers.
			foreach ( (array) $tempheaders as $header ) {
				if ( ! str_contains( $header, ':' ) ) {
					if ( false !== stripos( $header, 'boundary=' ) ) {
						$parts    = preg_split( '/boundary=/i', trim( $header ) );
						$boundary = trim( str_replace( array( "'", '"' ), '', $parts[1] ) );
					}
					continue;
				}
				// Explode them out.
				list( $name, $content ) = explode( ':', trim( $header ), 2 );

				// Cleanup crew.
				$name    = trim( $name );
				$content = trim( $content );

				switch ( strtolower( $name ) ) {
					// Mainly for legacy -- process a "From:" header if it's there.
					case 'from':
						$bracket_pos = strpos( $content, '<' );
						if ( false !== $bracket_pos ) {
							// Text before the bracketed email is the "From" name.
							if ( $bracket_pos > 0 ) {
								$from_name = substr( $content, 0, $bracket_pos );
								$from_name = str_replace( '"', '', $from_name );
								$from_name = trim( $from_name );
							}

							$from_email = substr( $content, $bracket_pos + 1 );
							$from_email = str_replace( '>', '', $from_email );
							$from_email = trim( $from_email );

							// Avoid setting an empty $from_email.
						} elseif ( '' !== trim( $content ) ) {
							$from_email = trim( $content );
						}
						break;
					case 'content-type':
						if ( str_contains( $content, ';' ) ) {
							list( $type, $charset_content ) = explode( ';', $content );
							$content_type                   = trim( $type );
							if ( false !== stripos( $charset_content, 'charset=' ) ) {
								$charset = trim( str_replace( array( 'charset=', '"' ), '', $charset_content ) );
							} elseif ( false !== stripos( $charset_content, 'boundary=' ) ) {
								$boundary = trim( str_replace( array( 'BOUNDARY=', 'boundary=', '"' ), '', $charset_content ) );
								$charset  = '';
							}

							// Avoid setting an empty $content_type.
						} elseif ( '' !== trim( $content ) ) {
							$content_type = trim( $content );
						}
						break;
					case 'cc':
						$cc = array_merge( (array) $cc, explode( ',', $content ) );
						break;
					case 'bcc':
						$bcc = array_merge( (array) $bcc, explode( ',', $content ) );
						break;
					case 'reply-to':
						$reply_to = array_merge( (array) $reply_to, explode( ',', $content ) );
						break;
					default:
						// Add it to our grand headers array.
						$headers[ trim( $name ) ] = trim( $content );
						break;
				}
			}
		}
	}

	// Empty out the values that may be set.
	$phpmailer->clearAllRecipients();
	$phpmailer->clearAttachments();
	$phpmailer->clearCustomHeaders();
	$phpmailer->clearReplyTos();
	$phpmailer->Body    = '';
	$phpmailer->AltBody = '';

	// Set "From" name and email.

	// If we don't have a name from the input headers.
	if ( ! isset( $from_name ) ) {
		$from_name = 'WordPress';
	}

	/*
	 * If we don't have an email from the input headers, default to wordpress@$sitename
	 * Some hosts will block outgoing mail from this address if it doesn't exist,
	 * but there's no easy alternative. Defaulting to admin_email might appear to be
	 * another option, but some hosts may refuse to relay mail from an unknown domain.
	 * See https://core.trac.wordpress.org/ticket/5007.
	 */
	if ( ! isset( $from_email ) ) {
		// Get the site domain and get rid of www.
		$sitename   = wp_parse_url( network_home_url(), PHP_URL_HOST );
		$from_email = 'wordpress@';

		if ( null !== $sitename ) {
			if ( str_starts_with( $sitename, 'www.' ) ) {
				$sitename = substr( $sitename, 4 );
			}

			$from_email .= $sitename;
		}
	}

	/**
	 * Filters the email address to send from.
	 *
	 * @since 2.2.0
	 *
	 * @param string $from_email Email address to send from.
	 */
	$from_email = apply_filters( 'wp_mail_from', $from_email );

	/**
	 * Filters the name to associate with the "from" email address.
	 *
	 * @since 2.3.0
	 *
	 * @param string $from_name Name associated with the "from" email address.
	 */
	$from_name = apply_filters( 'wp_mail_from_name', $from_name );

	try {
		$phpmailer->setFrom( $from_email, $from_name, false );
	} catch ( PHPMailer\PHPMailer\Exception $e ) {
		$mail_error_data                             = compact( 'to', 'subject', 'message', 'headers', 'attachments' );
		$mail_error_data['phpmailer_exception_code'] = $e->getCode();

		/** This filter is documented in wp-includes/pluggable.php */
		do_action( 'wp_mail_failed', new WP_Error( 'wp_mail_failed', $e->getMessage(), $mail_error_data ) );

		return false;
	}

	// Set mail's subject and body.
	$phpmailer->Subject = $subject;
	$phpmailer->Body    = $message;

	// Set destination addresses, using appropriate methods for handling addresses.
	$address_headers = compact( 'to', 'cc', 'bcc', 'reply_to' );

	foreach ( $address_headers as $address_header => $addresses ) {
		if ( empty( $addresses ) ) {
			continue;
		}

		foreach ( (array) $addresses as $address ) {
			try {
				// Break $recipient into name and address parts if in the format "Foo <bar@baz.com>".
				$recipient_name = '';

				if ( preg_match( '/(.*)<(.+)>/', $address, $matches ) ) {
					if ( count( $matches ) === 3 ) {
						$recipient_name = $matches[1];
						$address        = $matches[2];
					}
				}

				switch ( $address_header ) {
					case 'to':
						$phpmailer->addAddress( $address, $recipient_name );
						break;
					case 'cc':
						$phpmailer->addCc( $address, $recipient_name );
						break;
					case 'bcc':
						$phpmailer->addBcc( $address, $recipient_name );
						break;
					case 'reply_to':
						$phpmailer->addReplyTo( $address, $recipient_name );
						break;
				}
			} catch ( PHPMailer\PHPMailer\Exception $e ) {
				continue;
			}
		}
	}

	// Set to use PHP's mail().
	$phpmailer->isMail();

	// Set Content-Type and charset.

	// If we don't have a Content-Type from the input headers.
	if ( ! isset( $content_type ) ) {
		$content_type = 'text/plain';
	}

	/**
	 * Filters the wp_mail() content type.
	 *
	 * @since 2.3.0
	 *
	 * @param string $content_type Default wp_mail() content type.
	 */
	$content_type = apply_filters( 'wp_mail_content_type', $content_type );

	$phpmailer->ContentType = $content_type;

	// Set whether it's plaintext, depending on $content_type.
	if ( 'text/html' === $content_type ) {
		$phpmailer->isHTML( true );
	}

	// If we don't have a charset from the input headers.
	if ( ! isset( $charset ) ) {
		$charset = get_bloginfo( 'charset' );
	}

	/**
	 * Filters the default wp_mail() charset.
	 *
	 * @since 2.3.0
	 *
	 * @param string $charset Default email charset.
	 */
	$phpmailer->CharSet = apply_filters( 'wp_mail_charset', $charset );

	// Set custom headers.
	if ( ! empty( $headers ) ) {
		foreach ( (array) $headers as $name => $content ) {
			// Only add custom headers not added automatically by PHPMailer.
			if ( ! in_array( $name, array( 'MIME-Version', 'X-Mailer' ), true ) ) {
				try {
					$phpmailer->addCustomHeader( sprintf( '%1$s: %2$s', $name, $content ) );
				} catch ( PHPMailer\PHPMailer\Exception $e ) {
					continue;
				}
			}
		}

		if ( false !== stripos( $content_type, 'multipart' ) && ! empty( $boundary ) ) {
			$phpmailer->addCustomHeader( sprintf( 'Content-Type: %s; boundary="%s"', $content_type, $boundary ) );
		}
	}

	if ( ! empty( $attachments ) ) {
		foreach ( $attachments as $filename => $attachment ) {
			$filename = is_string( $filename ) ? $filename : '';

			try {
				$phpmailer->addAttachment( $attachment, $filename );
			} catch ( PHPMailer\PHPMailer\Exception $e ) {
				continue;
			}
		}
	}

	/**
	 * Fires after PHPMailer is initialized.
	 *
	 * @since 2.2.0
	 *
	 * @param PHPMailer $phpmailer The PHPMailer instance (passed by reference).
	 */
	do_action_ref_array( 'phpmailer_init', array( &$phpmailer ) );

	$mail_data = compact( 'to', 'subject', 'message', 'headers', 'attachments' );

	// Send!
	try {
		$send = $phpmailer->send();

		/**
		 * Fires after PHPMailer has successfully sent an email.
		 *
		 * The firing of this action does not necessarily mean that the recipient(s) received the
		 * email successfully. It only means that the `send` method above was able to
		 * process the request without any errors.
		 *
		 * @since 5.9.0
		 *
		 * @param array $mail_data {
		 *     An array containing the email recipient(s), subject, message, headers, and attachments.
		 *
		 *     @type string[] $to          Email addresses to send message.
		 *     @type string   $subject     Email subject.
		 *     @type string   $message     Message contents.
		 *     @type string[] $headers     Additional headers.
		 *     @type string[] $attachments Paths to files to attach.
		 * }
		 */
		do_action( 'wp_mail_succeeded', $mail_data );

		return $send;
	} catch ( PHPMailer\PHPMailer\Exception $e ) {
		$mail_data['phpmailer_exception_code'] = $e->getCode();

		/**
		 * Fires after a PHPMailer\PHPMailer\Exception is caught.
		 *
		 * @since 4.4.0
		 *
		 * @param WP_Error $error A WP_Error object with the PHPMailer\PHPMailer\Exception message, and an array
		 *                        containing the mail recipient, subject, message, headers, and attachments.
		 */
		do_action( 'wp_mail_failed', new WP_Error( 'wp_mail_failed', $e->getMessage(), $mail_data ) );

		return false;
	}
}

View all references View on Trac View on GitHub

Hooks

do_action_ref_array( ‘phpmailer_init’, PHPMailer $phpmailer ): Fires after PHPMailer is initialized.
apply_filters( ‘pre_wp_mail’, null|bool $return, array $atts ): Filters whether to preempt sending an email.
apply_filters( ‘wp_mail’, array $args ): Filters the wp_mail() arguments.
apply_filters( ‘wp_mail_charset’, string $charset ): Filters the default wp_mail() charset.
apply_filters( ‘wp_mail_content_type’, string $content_type ): Filters the wp_mail() content type.
do_action( ‘wp_mail_failed’, WP_Error $error ): Fires after a PHPMailer\PHPMailer\Exception is caught.
apply_filters( ‘wp_mail_from’, string $from_email ): Filters the email address to send from.
apply_filters( ‘wp_mail_from_name’, string $from_name ): Filters the name to associate with the “from” email address.
do_action( ‘wp_mail_succeeded’, array $mail_data ): Fires after PHPMailer has successfully sent an email.

Uses	Description
stripos()`wp-includes/class-pop3.php`
wp_parse_url()`wp-includes/http.php`	A wrapper for PHP’s parse_url() function that handles consistency in the return values across PHP versions.
is_email()`wp-includes/formatting.php`	Verifies that an email is valid.
network_home_url()`wp-includes/link-template.php`	Retrieves the home URL for the current network.
do_action_ref_array()`wp-includes/plugin.php`	Calls the callback functions that have been added to an action hook, specifying arguments in an array.
get_bloginfo()`wp-includes/general-template.php`	Retrieves information about the current site.
apply_filters()`wp-includes/plugin.php`	Calls the callback functions that have been added to a filter hook.
do_action()`wp-includes/plugin.php`	Calls the callback functions that have been added to an action hook.
WP_Error::__construct()`wp-includes/class-wp-error.php`	Initializes the error.

Show 4 more Show less

Used by	Description
wpmu_new_site_admin_notification()`wp-includes/ms-functions.php`	Notifies the Multisite network administrator that a new site was created.
WP_Automatic_Updater::send_plugin_theme_email()`wp-admin/includes/class-wp-automatic-updater.php`	Sends an email upon the completion or failure of a plugin or theme background update.
WP_Recovery_Mode_Email_Service::send_recovery_mode_email()`wp-includes/class-wp-recovery-mode-email-service.php`	Sends the Recovery Mode email to the site admin email address.
_wp_privacy_send_request_confirmation_notification()`wp-includes/user.php`	Notifies the site administrator via email when a request is confirmed.
_wp_privacy_send_erasure_fulfillment_notification()`wp-includes/user.php`	Notifies the user when their erasure request is fulfilled.
wp_send_user_request()`wp-includes/user.php`	Send a confirmation request email to confirm an action.
wp_privacy_send_personal_data_export_email()`wp-admin/includes/privacy-tools.php`	Send an email to the user with a link to the personal data export file
wp_site_admin_email_change_notification()`wp-includes/functions.php`	Sends an email to the old site admin email address when the site admin email address changes.
update_network_option_new_admin_email()`wp-includes/ms-functions.php`	Sends a confirmation request email when a change of network admin email address is attempted.
wp_network_admin_email_change_notification()`wp-includes/ms-functions.php`	Sends an email to the old network admin email address when the network admin email address changes.
retrieve_password()`wp-includes/user.php`	Handles sending a password retrieval email to a user.
WP_Automatic_Updater::send_email()`wp-admin/includes/class-wp-automatic-updater.php`	Sends an email upon the completion or failure of a background core update.
WP_Automatic_Updater::send_debug_email()`wp-admin/includes/class-wp-automatic-updater.php`	Prepares and sends an email of a full log of background update results, useful for debugging and geekery.
update_option_new_admin_email()`wp-admin/includes/misc.php`	Sends a confirmation request email when a change of site admin email address is attempted.
send_confirmation_on_profile_email()`wp-includes/user.php`	Sends a confirmation request email when a change of user email address is attempted.
wp_new_blog_notification()`wp-admin/includes/upgrade.php`	Notifies the site admin that the installation of WordPress is complete.
wp_password_change_notification()`wp-includes/pluggable.php`	Notifies the blog admin of a user changing password, normally via email.
wp_new_user_notification()`wp-includes/pluggable.php`	Emails login credentials to a newly-registered user.
wp_notify_postauthor()`wp-includes/pluggable.php`	Notifies an author (and/or others) of a comment/trackback/pingback on a post.
wp_notify_moderator()`wp-includes/pluggable.php`	Notifies the moderator of the site about a new comment that is awaiting approval.
wp_update_user()`wp-includes/user.php`	Updates a user in the database.
wpmu_welcome_user_notification()`wp-includes/ms-functions.php`	Notifies a user that their account activation has been successful.
newblog_notify_siteadmin()`wp-includes/ms-functions.php`	Notifies the network admin that a new site has been activated.
newuser_notify_siteadmin()`wp-includes/ms-functions.php`	Notifies the network admin that a new user has been activated.
wpmu_welcome_notification()`wp-includes/ms-functions.php`	Notifies the site administrator that their site activation was successful.
wpmu_signup_blog_notification()`wp-includes/ms-functions.php`	Sends a confirmation request email to a user when they sign up for a new site. The new site will not become active until the confirmation link is clicked.
wpmu_signup_user_notification()`wp-includes/ms-functions.php`	Sends a confirmation request email to a user when they sign up for a new user account (without signing up for a site at the same time). The user account will not become active until the confirmation link is clicked.

Show 22 more Show less

Changelog

Version	Description
5.5.0	is_email() is used for email validation, instead of PHPMailer’s default validator.
1.2.1	Introduced.

User Contributed Notes

Skip to note 18 content

Codex 9 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 29You must log in to vote on the helpfulness of this note
To send HTML formatted mail, you also can specify the Content-Type HTTP header in the $headers parameter:
```
$to = 'sendto@example.com';
$subject = 'The subject';
$body = 'The email body content';
$headers = array('Content-Type: text/html; charset=UTF-8');

wp_mail( $to, $subject, $body, $headers );
```
Log in to add feedback
Skip to note 19 content

Codex 9 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 15You must log in to vote on the helpfulness of this note
Example using the array form of $headers:
```
<?php
// assumes $to, $subject, $message have already been defined earlier...

$headers[] = 'From: Me Myself <me@example.net>';
$headers[] = 'Cc: John Q Codex <jqc@wordpress.org>';
$headers[] = 'Cc: iluvwp@wordpress.org'; // note you can just use a simple email address

wp_mail( $to, $subject, $message, $headers );
?>
```
- Since WP started using hooks, you’re not going to have success setting the From header in wp_mail(). You should add filters to the hooks to add this header instead: add_filter( 'wp_mail_from', 'wporg_wp_mail_from' ); function wporg_wp_mail_from( $content_type) { return 'the.email@example.com'; } add_filter( 'wp_mail_from_name', 'wporg_wp_mail_from_name' ); function wporg_wp_mail_from_name( $name ) { return 'Your Name'; }
  
  Benji Kostenbader 4 years ago
Log in to add feedback
Skip to note 20 content

stratboy 8 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 9You must log in to vote on the helpfulness of this note
Here’s an example of a basic configuration for SMTP (so phpmailer will be used instead of php’s mail()):
```
add_action( 'phpmailer_init', 'mailer_config', 10, 1);
function mailer_config(PHPMailer $mailer){
  $mailer->IsSMTP();
  $mailer->Host = "mail.telemar.it"; // your SMTP server
  $mailer->Port = 25;
  $mailer->SMTPDebug = 2; // write 0 if you don't want to see client/server communication in page
  $mailer->CharSet  = "utf-8";
}
```
Here’s an example of a basic error logging:
```
add_action('wp_mail_failed', 'log_mailer_errors', 10, 1);
function log_mailer_errors( $wp_error ){
  $fn = ABSPATH . '/mail.log'; // say you've got a mail.log file in your server root
  $fp = fopen($fn, 'a');
  fputs($fp, "Mailer Error: " . $wp_error->get_error_message() ."\n");
  fclose($fp);
}
```
Then use wp_mail() to send your mail.

If you’re using it for sending a form and your form’s action is the page’s permalink, you can do some basic checking for $_POST lenght/count to see if the page comes from a form submission.
```
if(count($_POST) != 0){ // on top of page
  // Then collect form data and try to send the form and write messages and so on...
  // Note: set $mailer->SMTPDebug to 0 to prevent it to write server messages on the page
}
```
NOTE: if you are using MAMP PRO to test from your local server, you should:

– go to the Postfix panel
– write your current virtual server as the ‘domain of outgoing email’
– activate ‘use a smart host for routing’
– write your provider’s smtp server (the same you are using in your mail client config)
– Eventually add authentication (then you should also setup the credentials in the phpmailer_init action)
- This is a great example, just one note: PHPMailer has moved. The function call needs to be modified.
  
  function mailer_config(\PHPMailer\PHPMailer\PHPMailer $mail){
  
  Martin Schneider 3 years ago
Log in to add feedback
Skip to note 21 content

drbobjr 8 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 7You must log in to vote on the helpfulness of this note

Having spent nearly a day banging my head against this one, I would strongly recommend that the doc for wp_mail() include the tip that many servers will require that a mail user account be created with the email address of wordpress@domain.com before this function will work. I would have NEVER figured that one out without many hours of google searches.
- Fellow head-banger here. This is actually an insane requirement in those cases when the email server is (physically) different from the web server hosting WordPress; site admins might not have any possibility to add such an address. I would classify this as a bug, but, taking into account that your message is 5 years old at the time of writing this feedback, one may safely assume that this is intended behaviour (why?). Also, note that while it’s possible to use alternative email facilities to avoid going through PHP’s mail() function, WordPress will still require that wordpress@domain.com to be around (and additionally, in some circumstances, webmaster@domain.com. So, if you’re able to generate those two mailboxes (or aliases), do that — it will save you from trouble in the future — unless, that is, someone at the core WordPress development team decides to change this behaviour (as they ought to have done years ago…)
  
  Gwyneth Llewelyn 3 years ago
Log in to add feedback
Skip to note 22 content

Daniyal Ahmed (a11n) 8 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 6You must log in to vote on the helpfulness of this note
Combining Content-Type(HTML) and From (Site name and “from” email)
```
$to = 'emailsendto@example.com';
$subject = 'The subject';
$body = 'The email body content';
$headers = array('Content-Type: text/html; charset=UTF-8','From: My Site Name <support@example.com>');

wp_mail( $to, $subject, $body, $headers );
```
Log in to add feedback

Codex 9 years ago

Switch to HTML formatted email (using the wp_mail_content_type filter):

<?php
add_filter( 'wp_mail_content_type', 'wpdocs_set_html_mail_content_type' );

$to = 'sendto@example.com';
$subject = 'The subject';
$body = 'The email body content';

wp_mail( $to, $subject, $body );

// Reset content-type to avoid conflicts -- https://core.trac.wordpress.org/ticket/23578
remove_filter( 'wp_mail_content_type', 'wpdocs_set_html_mail_content_type' );

function wpdocs_set_html_mail_content_type() {
	return 'text/html';
}
?>

Skip to note 24 content

Mark Howells-Mead 8 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 4You must log in to vote on the helpfulness of this note
If you need to set the Reply-To address, note that the syntax which PHPMailer needs is pretty specific. The email address must be enclosed within <> characters. It’s also advisable to set the “reply to” name.
```
$headers = array(
  'Reply-To: Person Name <person.name@example.com>',
);
```
Log in to add feedback
Skip to note 25 content

Codex 9 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 3You must log in to vote on the helpfulness of this note
Basic usage example:
```
<?php wp_mail( 'me@example.net', 'The subject', 'The message' ); ?>
```
Log in to add feedback
Skip to note 26 content

Codex 9 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 3You must log in to vote on the helpfulness of this note
Sending to multiple recipients:
```
<?php
$multiple_recipients = array(
	'recipient1@example.com',
	'recipient2@foo.example.com'
);
$subj = 'The email subject';
$body = 'This is the body of the email';
wp_mail( $multiple_recipients, $subj, $body );
?>
```
Log in to add feedback
Skip to note 27 content

Codex 9 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 2You must log in to vote on the helpfulness of this note
Add attachment and From header:
```
<?php
$attachments = array( WP_CONTENT_DIR . '/uploads/file_to_attach.zip' );
$headers = 'From: My Name <myname@example.com>' . "\r\n";
wp_mail( 'test@example.org', 'subject', 'message', $headers, $attachments );
?>
```
Log in to add feedback
Skip to note 28 content

lucasbustamante 6 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 2You must log in to vote on the helpfulness of this note
To send e-mail to admin:
```
$to = get_option( 'admin_email' );
$subject = 'The subject';
$body = 'The email body content';
$headers = array( 'Content-Type: text/html; charset=UTF-8' );
wp_mail( $to, $subject, $message, $headers, array( '' ) );
```
- I think it should be wp_mail( $to, $subject, $message, $headers, array( ” ) ); instead
  
  西門正 Code Guy 5 years ago
Log in to add feedback
Skip to note 29 content

jmikewp 8 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note
As of 4.6 header from can’t be a post variable, need to be set before otherwise your site will show php error “Fatal error: Uncaught exception ‘phpmailerException’ with message ‘Invalid address: (setFrom)”

This is due to ‘from email’ being set as variable and is not yet being passed by form submit.
```
$headers = "From: $name <$email>" . "\r\n";
```
Fix by predefining a variable for both $name and $email that will be overwritten after submit(ex.1), or set hardcoded(ex.2).
ex.1
```
$name = "Site name";
$email = "info@sitename.com";
if(isset $_POST["name"]){
$name = sanitize_text_field($_POST["name"]);
$email = sanitize_email($_POST["email"]);
}
```
ex.2
```
$headers = "From: Site name <info@sitename.com>" . "\r\n";
```
Log in to add feedback
Skip to note 30 content

Louis-Marie Matthews 7 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note
It’s important to know that this function might fail if you specify an empty body, even if using a SMTP.
```
wp_mail( 'email@provider.com', 'Subject', '' ); // returns false, the email was not sent
```
```
wp_mail( 'email@provider.com', 'Subject', 'Body' ); // returns true (if everything else is working)
```
Log in to add feedback
Skip to note 31 content

davecarpenter 2 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note

Emails will not send correctly if the $to parameter is over 500 characters. You will still get a true response from wp_mail() however.

Log in to add feedback
Skip to note 32 content

thedanish 1 year ago

You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note

Note: If you are using a WordPress in a vm in Google Cloud GCP SMTP port 25 is blocked. You will need to use a plugin or mail api over another port than 25.

Log in to add feedback
Skip to note 33 content

d79 1 year ago

You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
Since WP 6.2, you can set the names of attachments as keys of the array:
```
$attachments = array(
    'filename1.txt'  => '/path/to/the/file1',
    'file_name2.pdf' => '/path/to/file2',
);

wp_mail( $to, $subject, $message, $headers, $attachments );
```
Log in to add feedback
Skip to note 34 content

alordiel 9 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: -10You must log in to vote on the helpfulness of this note

<?php //combining in one header the From and content-type $headers[] = 'Content-Type: text/html; charset=UTF-8'; $headers[] = 'From: Wishio Team ' . "\r\n";
wp_mail( $to, $subject, $message, $headers); ?>

Log in to add feedback

wp_mail( string|string[] $to, string $subject, string $message, string|string[] $headers = ”, string|string[] $attachments = array() ): bool

In this article