mailSend mail
&reftitle.description;
boolmailstringtostringsubjectstringmessagestringadditional_headersstringadditional_parameters
Sends an email.
&reftitle.parameters;
to
Receiver, or receivers of the mail.
The formatting of this string must comply with
RFC 2822. Some examples are:
user@example.comuser@example.com, anotheruser@example.comUser <user@example.com>User <user@example.com>, Another User <anotheruser@example.com>subject
Subject of the email to be sent.
Subject must satisfy RFC 2047.
message
Message to be sent.
Each line should be separated with a LF (\n). Lines should not be larger
than 70 characters.
(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.
]]>
additional_headers (optional)
String to be inserted at the end of the email header.
This is typically used to add extra headers (From, Cc, and Bcc).
Multiple extra headers should be separated with a CRLF (\r\n).
When sending mail, the mail must contain
a From header. This can be set with the
additional_headers parameter, or a default
can be set in &php.ini;.
Failing to do this will result in an error
message similar to Warning: mail(): "sendmail_from" not
set in php.ini or custom "From:" header missing.
The From header sets also
Return-Path under Windows.
If messages are not received, try using a LF (\n) only.
Some poor quality Unix mail transfer agents 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
RFC 2822.
additional_parameters (optional)
The additional_parameters 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
sendmail_path configuration setting. For example,
this can be used to set the envelope sender address when using
sendmail with the -f sendmail option.
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 /etc/mail/trusted-users.
&reftitle.returnvalues;
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.
&reftitle.changelog;
&Version;&Description;4.3.0 (Windows only)
All custom headers (like From, Cc, Bcc and Date) are supported, and are
not case-sensitive.
(As custom headers are not interpreted by the MTA in the first place,
but are parsed by PHP, PHP < 4.3 only supported the Cc header element
and was case-sensitive).
4.2.3
The additional_parameters parameter is disabled in
safe_mode and the
mail function will expose a warning message
and return &false; when used.
4.0.5
The additional_parameters parameter was added.
&reftitle.examples;
Sending mail.
Using mail to send a simple email:
]]>
Sending mail with extra headers.
The addition of basic headers, telling the MUA
the From and Reply-To addresses:
]]>
Sending mail with an additional command line parameter.
The additional_parameters parameter
can be used to pass an additional parameter to the program configured
to use when sending mail using the sendmail_path.
]]>
Sending HTML email
It is also possible to send HTML email with mail.
Birthday Reminders for August