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.
Using the two ‘wp_mail_from’ and ‘wp_mail_from_name’ hooks allow from creating a from address like ‘Name email@address.com‘ when both are set. If just ‘wp_mail_from’ is set, then just the email address will be used with no name.
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
- $to
(string|array) (Required) Array or comma-separated list of email addresses to send message.
- $subject
(string) (Required) Email subject
- $message
(string) (Required) Message contents
- $headers
(string|array) (Optional) Additional headers.
Default value: ''
- $attachments
(string|array) (Optional) Files to attach.
Default value: array()
Return
(bool) Whether the email contents were sent successfully.
Source
Changelog
| Version | Description |
|---|---|
| 1.2.1 | Introduced. |
More Information
Usage
1 | 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
SMTPandsmtp_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
$attachmentsattribute 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:”)
User Contributed Notes
You must log in before being able to contribute a note or feedback.
'WEB > WP(WordPress)' 카테고리의 다른 글
| A Quick and Easy Guide To Creating WordPress Admin Pages (0) | 2018.04.27 |
|---|---|
| Wordpress wpdb undefined variable (0) | 2018.04.26 |
| On the checkout I got an error #12 (0) | 2018.04.24 |
| Custom payment gateway - redirect to the bank's page (0) | 2018.04.24 |
| WC_API – The WooCommerce API Callback (0) | 2018.04.23 |
To send HTML formatted mail, you also can specify the Content-Type HTTP header in the
$headersparameter:$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);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 addresswp_mail($to,$subject,$message,$headers);?>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);functionmailer_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);functionlog_mailer_errors(){$fn= ABSPATH .'/mail.log';// say you've got a mail.log file in your server root$fp=fopen($fn,'a');fputs($fp,"Mailer Error: ".$mailer->ErrorInfo ."\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)
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);Basic usage example:
<?php wp_mail('me@example.net','The subject','The message'); ?>Add attachment and
Fromheader:<?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);?>Switch to HTML formatted email (using the
wp_mail_content_typefilter):<?phpadd_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/23578remove_filter('wp_mail_content_type','wpdocs_set_html_mail_content_type');functionwpdocs_set_html_mail_content_type() {return'text/html';}?>Expand full source code
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);?>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>',);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.
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";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 sentwp_mail('email@provider.com','Subject','Body');// returns true (if everything else is working)<?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);
?>