Email

php mail

Summary: in this tutorial, you’ll learn how to send email using the PHP mail() function.

Introduction to the PHP mail() function

To send mail, you use the mail() function.

On Linux or Unix systems, you can configure the mail() function to use the sednmail or Qmail program to send messages.

On Windows, you can install the sendmail and set the sendmail_path in php.ini file to point at the executable file.

However, it’s more convenient to set the SMTP server with a port and sendmail_from in the php.ini file on Windows like this:

[mail function] SMTP=smtp.phptutorial.net smtp_port=25 sendmail_from=contact@phptutorial.netCode language: PHP (php)

If the SMTP server requires authentication, you can add the following lines for the account to authenticate:

auth_username=smtp_user auth_password=smpt_passwordCode language: PHP (php)

Once the configuration is ready, you need to restart the webserver.

The following illustrates the syntax of the mail() function:

mail( string $to, string $subject, string $message, array|string $additional_headers = [], string $additional_params = "" ): boolCode language: PHP (php)

The mail() function has the following parameters:

• $to is the receiver of the email
• $subject is the email subject.
• $message is the email message. It can be plain text or HTML. If $message is plain text, you use a CRLF (\r\n) to separate lines. And each line should not exceed 70 characters.
• $additional_headers is a string or an array inserted at the email’s header. It includes from, cc, bcc… If the header comes from an untrusted source, you should always sanitize it for security purposes.
• $additional_params allows you to pass additional flags as the command-line options to the sendmail program.

The mail() function returns true if the mail was accepted for delivery. It doesn’t mean that the mail is successfully reached the intended receiver. If an error occurred, the mail() function return false .

PHP mail() function examples

Let’s take some examples of using the PHP mail() function.

1) Using the PHP mail() function to send a plain text email example

The following example uses the mail() function to send a simple email:

 $subject = 'This is a test email'; $message =  wordwrap($message, 70, "\r\n"); mail('contact@phptutorial.net', $subject, $message);Code language: PHP (php)

In this example, we use the wordwrap() function to ensure that the lines of the message won’t exceed 70 characters.

2) Using the PHP mail() function to send a mail with extra headers example

The following example uses the mail() function to send a mail with additional headers like From, Reply-To, and X-Mailer:

 $to = 'contact@phptutorial.net'; $subject = 'This is a test email'; $message = 'Hi there'; $headers[] = 'From: john.doe@example.com'; $headers[] = 'Reply-To: john.doe@example.com'; $headers[] = 'X-Mailer: PHP/' . phpversion(); mail($to, $subject, $message, implode('\r\n', $headers));Code language: PHP (php)

If you use PHP 7.2 or later, you can pass the headers as an array like this:

 $to = 'contact@phptutorial.net'; $subject = 'This is a test email'; $message = 'Hi there'; $headers = [ 'From' => 'john.doe@example.com', 'Reply-To' => 'john.doe@example.com', 'X-Mailer' => 'PHP/' . phpversion() ]; mail($to, $subject, $message, $headers);Code language: PHP (php)

3) Using the PHP mail() function to send HTML email example

To send HTML mail, you need to set the Content-type for the header like this:

 $to = 'contact@phptutorial.net'; $subject = 'This is a test email'; $message = '       
This is HTML mail
  '; $headers = [ 'MIME-Version' => '1.0', 'Content-type' => 'text/html; charset=utf8', 'From' => 'john.doe@example.com', 'Reply-To' => 'john.doe@example.com', 'X-Mailer' => 'PHP/' . phpversion() ]; if (mail($to, $subject, $message, $headers)) < echo 'email was sent.'; > else < echo 'An error occurred.'; >Code language: PHP (php)

Summary

Источник

mail

Каждая строка должна быть отделена символом CRLF (\r\n). Строки не должны быть длиннее 70 символов.

(Только для Windows) Если PHP передаёт данные напрямую SMTP-серверу и в начале строки стоит точка, то она будет удалена. Чтобы избежать этого замените все такие точки на две.

Строка или массив, которые будут вставлены в конец отправляемых заголовков письма.

Обычно используется для добавления дополнительных заголовков (From, Cc, and Bcc). Несколько дополнительных заголовков должны быть разделены CRLF (\r\n). Если для составления этого заголовка используются внешние данные, то они должны быть проверены для избежания инъекций нежелательных заголовков.

Если передан массив, то его ключи будут именами заголовка, а значения значениями.

Замечание:

До PHP 5.4.42 и 5.5.27, параметр additional_headers не имел защиты от инъекции. Так что пользователи должны удостовериться, что передаваемые заголовки безопасны и содержат только заголовки. т.е. не содержат несколько переводов строк подряд, что стартует тело сообщения.

Замечание:

При отправке письмо должно содержать заголовок From . Он может быть установлен с помощью параметра additional_headers , или значение по умолчанию может быть установлено в php.ini .

Если заголовок отсутствует, будет сгенерировано сообщение об ошибке вида Warning: mail(): «sendmail_from» not set in php.ini or custom «From:» header missing . Заголовок From также определяет заголовок Return-Path при отправке напрямую через SMTP (только Windows).

Замечание:

Если сообщения не отправляются, попробуйте использовать только LF (\n). Некоторые агенты пересылки сообщений Unix (особенно » qmail) автоматически заменяют LF на CRLF (что приводит к двойному CR, если использовалось CRLF). Используйте эту меру в крайнем случае, так как это нарушает » RFC 2822.

Параметр additional_params может быть использован для передачи дополнительных флагов в виде аргументов командной строки для программы сконфигурированной для отправки писем, указанной директивой sendmail_path . Например, можно установить отправителя письма при использовании sendmail с помощью опции -f .

Параметр автоматически экранируется функцией escapeshellcmd() , чтобы не допустить выполнение команд. Но escapeshellcmd() позволяет добавлять дополнительные параметры. В целях безопасности рекомендуется проверять и очищать этот параметр.

Так как escapeshellcmd() применяется автоматически, то нельзя использовать некоторые символы, допустимые к использованию в email-адресах некоторыми RFC. mail() не допускает такие символы, поэтому в программах, в которых они требуются, рекомендуется использовать альтернативы для их отправки (например фреймворки или библиотеки).

Пользователь, под которым работает веб-сервер должен быть добавлен в список доверенных в конфигурации sendmail для того чтобы избежать добавления заголовка ‘X-Warning’ при указании отправителя с помощью опции (-f). Для пользователей sendmail — это файл /etc/mail/trusted-users .

Возвращаемые значения

Возвращает true , если письмо было принято для передачи, иначе false .

Важно заметить, что то что письмо было принято для передачи вовсе НЕ означает что оно достигло получателя.

Список изменений

Версия	Описание
7.2.0	Параметр additional_headers может принимать значения типа массив.

Примеры

Пример #1 Отправка письма.

Использование функции mail() для отправки простого письма:

// Сообщение
$message = «Line 1\r\nLine 2\r\nLine 3» ;

// На случай если какая-то строка письма длиннее 70 символов мы используем wordwrap()
$message = wordwrap ( $message , 70 , «\r\n» );

// Отправляем
mail ( ‘caffeinated@example.com’ , ‘My Subject’ , $message );
?>

Пример #2 Отправка письма с дополнительными заголовками.

Добавление простых заголовков, сообщающих почтовому агенту адреса From и Reply-To:

$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 );
?>

Пример #3 Отправка письма с дополнительными заголовками, переданными массивом

В этом примере посылается то же письмо, что и в примере выше, но дополнительные заголовки задаются массивом (доступно с PHP 7.2.0).

$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 );
?>

Пример #4 Отправка письма с дополнительными аргументами командной строки.

Параметр additional_params может быть использован для передачи дополнительных параметров программе, используемой для отправки писем с помощью директивы sendmail_path .

Пример #5 Отправка HTML-сообщения

С помощью функции mail() также можно отправить и HTML-письмо.

// несколько получателей
$to = ‘johny@example.com, sally@example.com’ ; // обратите внимание на запятую

// тема письма
$subject = ‘Birthday Reminders for August’ ;

// текст письма
$message = ‘

Here are the birthdays upcoming in August!

Person	Day	Month	Year
Johny	10th	August	1970
Sally	17th	August	1973

‘ ;

// Для отправки HTML-письма должен быть установлен заголовок Content-type
$headers = ‘MIME-Version: 1.0’ . «\r\n» ;
$headers .= ‘Content-type: text/html; charset=iso-8859-1’ . «\r\n» ;

// Дополнительные заголовки
$headers [] = ‘To: Mary , Kelly ‘ ;
$headers [] = ‘From: Birthday Reminder ‘ ;
$headers [] = ‘Cc: birthdayarchive@example.com’ ;
$headers [] = ‘Bcc: birthdaycheck@example.com’ ;

// Отправляем
mail ( $to , $subject , $message , implode ( «\r\n» , $headers ));
?>

Замечание:

Для отправки HTML или других комплексных сообщений рекомендуется использовать PEAR-пакет » PEAR::Mail_Mime.

Примечания

Замечание:

Реализация SMTP (только Windows) функции mail() в Windows во многом отличается от реализации в sendmail. Во-первых, она не использует локальную программу для составления писем, а работает непосредственно с сокетами, что означает что необходим почтовый агент ( MTA ), ожидающий соединений на сокете (может быть как на локальном так и на удалённом сервере).

Во-вторых, дополнительные заголовки вроде: From: , Cc: , Bcc: и Date: интерпретируются в первую очередь не, MTA , а PHP.

Поэтому параметр to не должен быть адресом вида «Something «. Команда mail может неправильно интерпретировать этот адрес во время передачи данных MTA.

Замечание:

Не следует использовать функцию mail() для отправки большого количества писем в цикле. Функция открывает и закрывает соединение с SMTP-сервером для каждого письма, что не очень эффективно.

Для отправки большого количества сообщений обратите внимание на пакеты » PEAR::Mail и » PEAR::Mail_Queue.

Смотрите также

Источник