imap_mail

(PHP 4, PHP 5, PHP 7, PHP 8)

imap_mail — Send an email message

Description

imap_mail(
    string $to,
    string $subject,
    string $message,
    ?string $additional_headers = null,
    ?string $cc = null,
    ?string $bcc = null,
    ?string $return_path = null
): bool

This function allows sending of emails with correct handling of Cc and Bcc receivers.

The parameters to, cc and bcc are all strings and are all parsed as » RFC822 address lists.

Parameters

to: The receiver
subject: The mail subject
message: The mail body, see imap_mail_compose()
additional_headers: As string with additional headers to be set on the mail
cc
bcc: The receivers specified in bcc will get the mail, but are excluded from the headers.
return_path: Use this parameter to specify return path upon mail delivery failure. This is useful when using PHP as a mail client for multiple users.

Return Values

Returns true on success or false on failure.

Changelog

Version	Description
8.0.0	`additional_headers`, `cc`, `bcc`, and `return_path` are now nullable.

Improve This Page

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes

There are no user contributed notes for this page.