Send mail
bool **mail** string $to string $subject string $message $additional_headers string $additional_params
Sends an email.
toReceiver, or receivers of the mail.
The formatting of this string must comply with
. Some examples are:
RFC 2822
subjectSubject of the email to be sent.
Let op: > Subject must satisfy . RFC 2047
messageMessage to be sent.
Each line should be separated with a CRLF (\r\n). Lines should not be larger than 70 characters.
Let op: > (Windows only) When PHP is talking to a SMTP server directly, if a full stop is found on the start of a line, it is removed. To counter-act this, replace these occurrences with a double dot.
```php
additional_headers
or to be inserted at the end of the email header.
String``array
This is typically used to add extra headers (From, Cc, and Bcc). Multiple extra headers should be separated with a CRLF (\r\n). If outside data are used to compose this header, the data should be sanitized so that no unwanted headers could be injected.
If an is passed, its keys are the header names and its
values are the respective header values.
`array`
Opmerking: > When sending mail, the mail contain a header. This can be set with the parameter, or a default can be set in php.ini. must
From``additional_headersFailing to do this will result in an error message similar to . The header sets also when sending directly via SMTP (Windows only). `Warning: mail(): "sendmail_from" not set in php.ini or custom "From:" header missing``From``Return-Path`
Opmerking: > If messages are not received, try using a LF (\n) only. Some Unix mail transfer agents (most notably ) replace LF by CRLF automatically (which leads to doubling CR if CRLF is used). This should be a last resort, as it does not comply with . qmailRFC 2822
additional_params
The parameter
can be used to pass additional flags as command line options to the
program configured to be used when sending mail, as defined by the
configuration setting. For example,
this can be used to set the envelope sender address when using
sendmail with the sendmail option.
additional_params``sendmail_path``-f
This parameter is escaped by internally
to prevent command execution. prevents
command execution, but allows to add additional parameters. For security reasons,
it is recommended for the user to sanitize this parameter to avoid adding unwanted
parameters to the shell command.
`escapeshellcmd``escapeshellcmd`
Since is applied automatically, some characters
that are allowed as email addresses by internet RFCs cannot be used.
can not allow such characters, so in programs where the use of
such characters is required, alternative means of sending emails (such as using a framework
or a library) is recommended.
`escapeshellcmd``mail`
The user that the webserver runs as should be added as a trusted user to the sendmail configuration to prevent a 'X-Warning' header from being added to the message when the envelope sender (-f) is set using this method. For sendmail users, this file is .
Returns true if the mail was successfully accepted for delivery, false otherwise.
It is important to note that just because the mail was accepted for delivery, it does NOT mean the mail will actually reach the intended destination.
Voorbeeld: Sending mail.
Using to send a simple email:
`mail`
<?php
// The message
$message = "Line 1\r\nLine 2\r\nLine 3";
// In case any of our lines are larger than 70 characters, we should use wordwrap()
$message = wordwrap($message, 70, "\r\n");
// Send
mail('caffeinated@example.com', 'My Subject', $message);
?>
Voorbeeld: Sending mail with extra headers.
The addition of basic headers, telling the MUA the From and Reply-To addresses:
<?php
$to = 'nobody@example.com';
$subject = 'the subject';
$message = 'hello';
$headers = 'From: webmaster@example.com' . "\r\n" .
'Reply-To: webmaster@example.com' . "\r\n" .
'X-Mailer: PHP/' . phpversion();
mail($to, $subject, $message, $headers);
?>
**Voorbeeld: Sending mail with extra headers as **
This example sends the same mail as the example immediately above, but passes the additional headers as array (available as of PHP 7.2.0).
<?php
$to = 'nobody@example.com';
$subject = 'the subject';
$message = 'hello';
$headers = array(
'From' => 'webmaster@example.com',
'Reply-To' => 'webmaster@example.com',
'X-Mailer' => 'PHP/' . phpversion()
);
mail($to, $subject, $message, $headers);
?>
Voorbeeld: Sending mail with an additional command line parameter.
The parameter
can be used to pass an additional parameter to the program configured
to use when sending mail using the .
`additional_params``sendmail_path`
<?php
mail('nobody@example.com', 'the subject', 'the message', null,
'-fwebmaster@example.com');
?>
Voorbeeld: Sending HTML email
It is also possible to send HTML email with .
`mail`
<?php
// Multiple recipients
$to = 'johny@example.com, sally@example.com'; // note the comma
// Subject
$subject = 'Birthday Reminders for August';
// Message
$message = '
<html>
<head>
<title>Birthday Reminders for August</title>
</head>
<body>
<p>Here are the birthdays upcoming in August!</p>
<table>
<tr>
<th>Person</th><th>Day</th><th>Month</th><th>Year</th>
</tr>
<tr>
<td>Johny</td><td>10th</td><td>August</td><td>1970</td>
</tr>
<tr>
<td>Sally</td><td>17th</td><td>August</td><td>1973</td>
</tr>
</table>
</body>
</html>
';
// To send HTML mail, the Content-type header must be set
$headers[] = 'MIME-Version: 1.0';
$headers[] = 'Content-type: text/html; charset=iso-8859-1';
// Additional headers
$headers[] = 'To: Mary <mary@example.com>, Kelly <kelly@example.com>';
$headers[] = 'From: Birthday Reminder <birthday@example.com>';
$headers[] = 'Cc: birthdayarchive@example.com';
$headers[] = 'Bcc: birthdaycheck@example.com';
// Mail it
mail($to, $subject, $message, implode("\r\n", $headers));
?>
Opmerking: > If intending to send HTML or otherwise Complex mails, it is recommended to use the PEAR package . PEAR::Mail_Mime
Opmerking: > The SMTP implementation (Windows only) of differs in many ways from the sendmail implementation. First, it doesn't use a local binary for composing messages but only operates on direct sockets which means a is needed listening on a network socket (which can either on the localhost or a remote machine).
mail``MTASecond, the custom headers like , , and are interpreted by the in the first place, but are parsed by PHP.
From:``Cc:``Bcc:``Date:notMTAAs such, the parameter should not be an address in the form of "Something <someone@example.com>". The mail command may not parse this properly while talking with the MTA.
to
Opmerking: > It is worth noting that the function is not suitable for larger volumes of email in a loop. This function opens and closes an SMTP socket for each email, which is not very efficient.
For the sending of large amounts of email, see the , and packages.PEAR::MailPEAR::Mail_Queue
Opmerking: > The following RFCs may be useful: , , , , , , and . RFC 1896RFC 2045RFC 2046RFC 2047RFC 2048RFC 2049RFC 2822
mb_send_mail``imap_mailPEAR::MailPEAR::Mail_Mime