mail

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

mail — Invio mail

Descrizione

mail(
    string $to,
    string $subject,
    string $message,
    mixed $additional_headers = ?,
    string $additional_parameters = ?
): bool

Invia una email.

Elenco dei parametri

to

Destinatario, o destinatari della mail.

La formattazione della stringa deve rispettare l' » RFC 2822. Alcuni esempi sono:

user@example.com
user@example.com, anotheruser@example.com
Utente
Utente , Un Altro utente

subject

L'oggetto dell'email da inviare.

Attenzione

L'oggetto deve soddisfare l'» RFC 2047.

message

Il messaggio da inviare.

Ogni riga dovrebbe essere separata con un CRLF (\r\n). Le righe non dovrebbero essere più lunghe di 70 caratteri.

Attenzione

(Solo per Windows) Quando PHP comunica direttamente con un server SMTP, se viene trovato un punto all'inizio di una riga, esso viene rimosso. Per contrastare questo, sostituire queste occorrenze con un doppio punto.

<?php
$text = str_replace("\n.", "\n..", $text);
?>

additional_headers (opzionale)

String o array da inserire alla fine dell'header dell'email.

Questa è tipicamente usata per aggiungere degli header extra (Da, Cc, e Bcc). Gli header extra multipli dovrebbero essere separati con un CRLF (\r\n). Se vengono utilizzati dati esterni per comporre questo header, i dati dovrebbero essere sanitizzati in modo che nessun header non voluto possa essere iniettato.

Se viene passato un array, le sue chiavi sono i nomi degli header ed i suoi valori sono i rispettivi valori degli header.

Nota:
Prima di PHP 5.4.42 e 5.5.27, rispettivamente, additional_headers non aveva una protezione per l'injection dell'header della mail. Quindi, gli utenti devono assicurarsi che gli header specifici siano sicuri e che contengano solo header. p.e. Mai iniziare il corpo della mail mettendo righe vuote multiple.

Nota:
Quando si invia una mail, la mail deve contenere un header From. Questo può essere settato con il parametro additional_headers, o può essere settato un valore di default in php.ini.

Non riuscendo a fare questo si avrà un messaggio di errore simile a Warning: mail(): "sendmail_from" not set in php.ini or custom "From:" header missing. L'header From setta anche Return-Path sotto Windows.

Nota:
Se i messaggi non vengono ricevuti, provare ad utilizzare solo un LF (\n). Alcuni agent di trasferimento mail Unix (soprattutto » qmail) sostituiscono LF con CRLF automaticamente (che porta a raddoppiare CR se viene utilizzato CRLF). Questa dovrebbe essere un'ultima spiaggia, in quanto non è conforme con l' » RFC 2822.

additional_parameters (opzionale)

Il parametro additional_parameters può essere usato per passare flag aggiuntive come opzioni della linea di comando al programma configurato per essere usato quando si inviano mail, come definito dall' impostazione di configurazione sendmail_path. Per esempio, questo può essere utilizzato per impostare l'indirizzo del mittente della mail quando si usa sendmail con l'opzione -f di sendmail.

Su questo parametro è effettuato internamente l'escape da escapeshellcmd() per impedire l'esecuzione di comandi. escapeshellcmd() impedisce l'esecuzione del comando, ma permette di aggiungere parametri aggiuntivi. Per motivi di sicurezza, è raccomandato che l'utente sanitizzi questo parametro per evitare di aggiungere parametri non voluti sulla shell di comando.

Dato che escapeshellcmd() viene applicato automaticamente, alcuni caratteri che sono permessi come indirizzo email dall'internet di RFC non possono essere utilizzati. mail() non può permettere tali caratteri, così in programmi dove l'uso di tali caratteri è richiesto, sono raccomandati mezzi alternativi di invio delle email (come l'utilizzo di un framework o di una libreria).

L'utente con il quale il webserver viene eseguito dovrebbe essere aggiunto come utente fidato alla configurazione sendmail per prevenire l'aggiunta di un header 'X-Warning' al messaggio quando il mittente del messaggio (-f) viene impostato usando questo metodo. Per gli utenti sendmail, questo file è /etc/mail/trusted-users.

Valori restituiti

Restituisce true se la mail è stata acccettata con successo per la consegna, false in caso contrario.

È importante notare che solo perchè la mail è stata accettata per la consegna, questo NON significa che la mail raggiungerà effettivamente la destinazione prevista.

Log delle modifiche

Versione	Descrizione
7.2.0	Il parametro `additional_headers` ora accetta anche un array.

Esempi

Example #1 Invio di mail.

Utilizzo di mail() per inviare una semplice email:

<?php
// Il messaggio
$message = "Line 1\r\nLine 2\r\nLine 3";

// Nel caso in cui qualsiasi delle linee sarà più lunga di 70 caratteri, si dovrà utilizzare wordwrap()
$message = wordwrap($message, 70, "\r\n");

// Invio
mail('caffeinated@example.com', 'My Subject', $message);
?>

Example #2 Inviare mail con header extra.

L'aggiunta di header di base, indicando gli indirizzi MUA From e Reply-To:

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

Example #3 Inviare mail con header extra come array

Questo esempio invia la stessa mail come l'esempio immediatamente sopra, ma passa gli header aggiuntivi come array (disponibile da 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);
?>

Example #4 Invio mail con un parametro di linea di comando aggiuntivo.

Il parametro additional_parameters può essere usato per passare un parametro aggiuntivo al programma configurato da usare quando si inviano mail utilizzando il sendmail_path.

<?php
mail('nobody@example.com', 'the subject', 'the message', null,
   '-fwebmaster@example.com');
?>

Example #5 Invio di email HTML

È anche possibile inviare email HTML con mail().

<?php
// Destinatari multipli
$to = 'johny@example.com, sally@example.com'; // notare la virgola

// Oggetto
$subject = 'Promemoria compleanni di Agosto';

// Messaggio
$message = '
<html>
<head>
  <title>Promemoria compleanni di Agosto</title>
</head>
<body>
  <p>Questi sono i compleanni di Agosto!</p>
  <table>
    <tr>
      <th>Persona</th><th>Giorno</th><th>Mese</th><th>Anno</th>
    </tr>
    <tr>
      <td>Johny</td><td>10</td><td>Agosto</td><td>1970</td>
    </tr>
    <tr>
      <td>Sally</td><td>17</td><td>Agosto</td><td>1973</td>
    </tr>
  </table>
</body>
</html>
';

// Per inviare mail HTML, deve essere impostato l'header Content-type
$headers[] = 'MIME-Version: 1.0';
$headers[] = 'Content-type: text/html; charset=iso-8859-1';

// Header aggiuntivi
$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';

// Invia la mail
mail($to, $subject, $message, implode("\r\n", $headers));
?>

Nota:
Se si intende inviare mail HTML o mail complesse, è raccomandato usare il package PEAR » PEAR::Mail_Mime.

Note

Nota:
L'implementazione di Windows di mail() differisce in molti modi dall'implementazione di Unix. Innanzitutto, essa non usa un binario locale per comporre i messaggi ma opera solo sui socket diretti che significa che è necessario un MTA in ascolto su un socket della rete (che può essere sia sul localhost che su una macchina remota).

In secondo luogo, gli header personalizzati come From:, Cc:, Bcc: e Date: non sono interpretati dall' MTA in primo luogo, ma sono analizzati da PHP.

Pertanto, il parametro to non dovrebbe essere un indirizzo nella forma di "Qualcosa <someone@example.com>". Il comando mail non può analizzarlo correttamente mentre comunica con l'MTA.

Nota:
Vale la pena notare che la funzione mail() non è adatta per grandi volumi di email in un ciclo. Questa funzione apre e chiude un socket SMTP per ogni email, che non è molto efficiente.

Per l'invio di grandi quantità di email, vedere i package » PEAR::Mail, e » PEAR::Mail_Queue.

Nota:
I seguenti RFC possono essere utili: » RFC 1896, » RFC 2045, » RFC 2046, » RFC 2047, » RFC 2048, » RFC 2049, e » RFC 2822.

Vedere anche:

mb_send_mail() - Send encoded mail
imap_mail() - Send an email message
» PEAR::Mail
» PEAR::Mail_Mime

Found A Problem?

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

＋add a note

User Contributed Notes 18 notes

down

Anonymous ¶

8 years ago

Security advice: Although it is not documented, for the parameters $to and $subject the mail() function changes at least \r and \n to space. So these parameters are safe against injection of additional headers. But you might want to check $to for commas as these separate multiple addresses and you might not want to send to more than one recipient.

The crucial part is the $additional_headers parameter. This parameter can't be cleaned by the mail() function. So it is up to you to prevent unwanted \r or \n to be inserted into the values you put in there. Otherwise you just created a potential spam distributor.

down

php at simoneast dot net ¶

7 years ago

Often it's helpful to find the exact error message that is triggered by the mail() function. While the function doesn't provide an error directly, you can use error_get_last() when mail() returns false.

<?php
$success = mail('example@example.com', 'My Subject', $message);
if (!$success) {
    $errorMessage = error_get_last()['message'];
}
?>

(Tested successfully on Windows which uses SMTP by default, but sendmail on Linux/OSX may not provide the same level of detail.)

Thanks to https://stackoverflow.com/a/20203870/195835

down

priyanshkala3 at gmail dot com ¶

1 year ago

Sending mail using XAMPP server

I encountered numerous issues while attempting to send emails using the XAMPP server. However, I eventually found the correct method to accomplish it.

Configuring PHP's mail functionality to work with Gmail's SMTP server involves editing the `php.ini` and `sendmail.ini` configuration files. Below are the formal steps for setting up PHP to send emails through Gmail's SMTP server using XAMPP:

Configuring php.ini:

1. Open `php.ini` in an editor:
   Open the `php.ini` configuration file in your preferred text editor.

2. Locate the mail function:
   Use the search function (Ctrl + F) to find the section related to the mail function within the `php.ini` file.

3. Update mail function settings:
   Copy and paste the following configuration parameters into the mail function section. Comment out or disable all other settings related to mail.

   php.ini code to be edited:

   SMTP=smtp.gmail.com
   smtp_port=587
   sendmail_from = yourmail@gmail.com
   sendmail_path = write_sendmail.exe_path
   

4. Save the changes:
   Save the `php.ini` file after applying the modifications.

Configuring sendmail.ini (in XAMPP folder):

1. Open `sendmail.ini` in XAMPP folder:
   Locate and open the `sendmail.ini` configuration file within the XAMPP directory.

2. Adjust SMTP settings:
   Insert the following content into the `sendmail.ini` file, marking other configurations as comments:

   sendmail.ini code :

   smtp_server=smtp.gmail.com
   smtp_port=587
   error_logfile=error.log
   debug_logfile=debug.log
   auth_username=yourmail@gmail.com
auth_password=app_password_after_enabling_two_factor_authentication_for_your_mail_id
   force_sender=priyansh.kala.4@gmail.com
   

3. Save the changes:
   Save the `sendmail.ini` file after inserting the specified configurations.

These steps configure PHP to utilize Gmail's SMTP server for sending emails. Ensure that the modifications are saved and that the necessary XAMPP services are restarted for the changes to take effect.

Please note that using hardcoded passwords in configuration files poses a security risk. Storing passwords directly in plain text files should be avoided in production environments. Consider using environment variables or secure credential management systems for better security practices.

Code for sending mail-:

<?php
$subject = "Mail for checking";
$msg = "Hey! Let us play with PHP.";
$receiver = "reciever@gmail.com";
mail($receiver, $subject, $msg);
?>

down

Anonymous ¶

5 years ago

If you notice wrong displayed characters in the email it's because you need to properly set the Content-Type and the Charset in the headers of the email:

<?php
$headers = 'Content-Type: text/plain; charset=utf-8' . "\r\n";
?>

Mostly, UTF-8 is your best choice.

You can set custom headers with the fourth parameter of the mail() function.

To make the whole thing waterproof, add the following header too:

<?php
$headers .= 'Content-Transfer-Encoding: base64' . "\r\n";
?>

Now you can use the combination of UTF-8 and Base64 to properly encode the subject line and the recipient name like this:

<?php
$subject = '=?UTF-8?B?' . base64_encode('Test email with German Umlauts öäüß') . '?=';
$recipient = '=?UTF-8?B?' . base64_encode('Margret Müller') . '?= <recipient@domain.com>';
?>

And don't forget to Base64 encode the email message too:

<?php
$message = base64_encode('This email contains German Umlauts öäüß.');
?>

All references are taken from:
https://dev.to/lutvit/how-to-make-the-php-mail-function-awesome-3cii

down

charles dot fisher at arconic dot com ¶

7 years ago

I migrated an application to a platform without a local transport agent (MTA). I did not want to configure an MTA, so I wrote this xxmail function to replace mail() with calls to a remote SMTP server. Hopefully it is of some use.

function xxmail($to, $subject, $body, $headers)
{
 $smtp = stream_socket_client('tcp://smtp.yourmail.com:25', $eno, $estr, 30);

 $B = 8192;
 $c = "\r\n";
 $s = 'myapp@someserver.com';

 fwrite($smtp, 'helo ' . $_ENV['HOSTNAME'] . $c);
  $junk = fgets($smtp, $B);

 // Envelope
 fwrite($smtp, 'mail from: ' . $s . $c);
  $junk = fgets($smtp, $B);
 fwrite($smtp, 'rcpt to: ' . $to . $c);
  $junk = fgets($smtp, $B);
 fwrite($smtp, 'data' . $c);
  $junk = fgets($smtp, $B);

 // Header 
 fwrite($smtp, 'To: ' . $to . $c); 
 if(strlen($subject)) fwrite($smtp, 'Subject: ' . $subject . $c); 
 if(strlen($headers)) fwrite($smtp, $headers); // Must be \r\n (delimited)
 fwrite($smtp, $headers . $c); 

 // Body
 if(strlen($body)) fwrite($smtp, $body . $c); 
 fwrite($smtp, $c . '.' . $c);
  $junk = fgets($smtp, $B);

 // Close
 fwrite($smtp, 'quit' . $c);
  $junk = fgets($smtp, $B);
 fclose($smtp);
}

down

chris at ocproducts dot com ¶

7 years ago

The 'sendmail' executable which PHP uses on Linux/Mac (not Windows) expects "\n" as a line separator.

This executable is a standard, and emulated by other MTAs.

"\n" is confirmed required for qmail and postfix, probably also for sendmail and exim but I have not tested.

If you pass through using "\r\n" as a separator it may appear to work, but your email will be subtly corrupted and some middleware may break. It only works because some systems will clean up your mistake.

If you are implementing DKIM be very careful, as DKIM checks will fail (at least on popular validation tools) if you screw this up. DKIM must be calculated using "\r\n" but then you must switch it all to "\n" when using the PHP mail function.

On Windows, however, you should use "\r\n" because PHP is using SMTP in this situation, and hence the normal rules of the SMTP protocol (not the normal rules of Unix piping) apply.

down

Porjo ¶

14 years ago

Make sure you enclose \r\n in double quotes (not single quotes!) so that PHP can translate that into the correct linefeed code

down

atesin > gmail ¶

1 year ago

mail() internals:

doing some tests i can say... if sendmail_path is defined in php.ini or by ini.set(), by calling function like...

mail($to, $subject, $message, $headers, $params)

would be like if php open a shell internally, execute this command, send this text to stdin, and return true if return value == 0

------------
shell> $sendmail_path $params
To: $to
Subject: $subject
$headers

$message
(EOF)
------------

in windows instead using php smtp which is very limited, i prefer to force use sendmail-like behavior, by setting sendmail_path and then use msmtp for windows

down

Mark Simon ¶

5 years ago

It is worth noting that you can set up a fake sendmail program using the sendmail_path directive in php.ini.

Despite the comment in that file, sendmail_path also works for Window. From https://www.php.net/manual/en/mail.configuration.php#ini.sendmail-path:

This directive works also under Windows. If set, smtp, smtp_port and sendmail_from are ignored and the specified command is executed.

down

eeeugeneee ¶

7 years ago

Send mail with minimal requirements from email services.

<?php
    $encoding = "utf-8";

    // Preferences for Subject field
    $subject_preferences = array(
        "input-charset" => $encoding,
        "output-charset" => $encoding,
        "line-length" => 76,
        "line-break-chars" => "\r\n"
    );

    // Mail header
    $header = "Content-type: text/html; charset=".$encoding." \r\n";
    $header .= "From: ".$from_name." <".$from_mail."> \r\n";
    $header .= "MIME-Version: 1.0 \r\n";
    $header .= "Content-Transfer-Encoding: 8bit \r\n";
    $header .= "Date: ".date("r (T)")." \r\n";
    $header .= iconv_mime_encode("Subject", $mail_subject, $subject_preferences);

    // Send mail
    mail($mail_to, $mail_subject, $mail_message, $header);
?>

down

pangz dot lab at gmail dot com ¶

4 years ago

* Sending email with attachment

function sendMail(
    string $fileAttachment,
    string $mailMessage = MAIL_CONF["mailMessage"],
    string $subject     = MAIL_CONF["subject"],
    string $toAddress   = MAIL_CONF["toAddress"],
    string $fromMail    = MAIL_CONF["fromMail"]
): bool {
    
    $fileAttachment = trim($fileAttachment);
    $from           = $fromMail;
    $pathInfo       = pathinfo($fileAttachment);
    $attchmentName  = "attachment_".date("YmdHms").(
    (isset($pathInfo['extension']))? ".".$pathInfo['extension'] : ""
    );
    
    $attachment    = chunk_split(base64_encode(file_get_contents($fileAttachment)));
    $boundary      = "PHP-mixed-".md5(time());
    $boundWithPre  = "\n--".$boundary;
    
    $headers   = "From: $from";
    $headers  .= "\nReply-To: $from";
    $headers  .= "\nContent-Type: multipart/mixed; boundary=\"".$boundary."\"";
    
    $message   = $boundWithPre;
    $message  .= "\n Content-Type: text/plain; charset=UTF-8\n";
    $message  .= "\n $mailMessage";
    
    $message .= $boundWithPre;
    $message .= "\nContent-Type: application/octet-stream; name=\"".$attchmentName."\"";
    $message .= "\nContent-Transfer-Encoding: base64\n";
    $message .= "\nContent-Disposition: attachment\n";
    $message .= $attachment;
    $message .= $boundWithPre."--";
    
    return mail($toAddress, $subject, $message, $headers);
}

* Sending email in html

function sendHtmlMail(
    string $mailMessage = MAIL_CONF["mailMessage"],
    string $subject     = MAIL_CONF["subject"],
    array $toAddress    = MAIL_CONF["toAddress"],
    string $fromMail    = MAIL_CONF["fromMail"]
): bool {
    
    $to        = implode(",", $toAddress);
    $headers[] = 'MIME-Version: 1.0';
    $headers[] = 'Content-type: text/html; charset=iso-8859-1';    
    $headers[] = 'To: '.$to;
    $headers[] = 'From: '.$fromMail;    

    return mail($to, $subject, $mailMessage, implode("\r\n", $headers));
}

down

pavel.lint at vk.com ¶

12 years ago

Here's a small handy function I use to send email in UTF-8.

 <?php
function mail_utf8($to, $from_user, $from_email, 
                                             $subject = '(No subject)', $message = '')
   { 
      $from_user = "=?UTF-8?B?".base64_encode($from_user)."?=";
      $subject = "=?UTF-8?B?".base64_encode($subject)."?=";

      $headers = "From: $from_user <$from_email>\r\n". 
               "MIME-Version: 1.0" . "\r\n" . 
               "Content-type: text/html; charset=UTF-8" . "\r\n"; 

     return mail($to, $subject, $message, $headers); 
   }
?>

down

Ben Cooke ¶

19 years ago

Note that there is a big difference between the behavior of this function on Windows systems vs. UNIX systems. On Windows it delivers directly to an SMTP server, while on a UNIX system it uses a local command to hand off to the system's own MTA.



The upshot of all this is that on a Windows system your  message and headers must use the standard line endings \r\n as prescribed by the email specs. On a UNIX system the MTA's "sendmail" interface assumes that recieved data will use UNIX line endings and will turn any \n to \r\n, so you must supply only \n to mail() on a UNIX system to avoid the MTA hypercorrecting to \r\r\n.



If you use plain old \n on a Windows system, some MTAs will get a little upset. qmail in particular will refuse outright to accept any message that has a lonely \n without an accompanying \r.

down

Anonymous ¶

1 year ago

So far I used the following to make sure special charakters where correctly shown in the mail subject:

<?php $subject = '=?utf-8?B?' . base64_encode($subject) . '?='; ?>

But with very long subjects, the header line gets longer than 76 chars and some e-mail servers really don't like that... So this is my new solution:

<?php $subject = substr(mb_encode_mimeheader("Subject: " . $subject, 'utf-8', 'B', "\r\n", 0), 9); ?>

Please note: I added "Subject: " in front of $subject and stripped it of afterwards. This is to make sure, that the necessarry space is reserved, as PHP will add the "Subject: " itself...

down

imme_emosol ¶

1 year ago

Also see chunk_split (as "alternative" to wordwrap).

down

-2

ABOMB ¶

12 years ago

I was having delivery issues from this function to Gmail, Yahoo, AOL, etc.  I used the notes here to figure that you need to be setting your Return-Path to a valid email to catch bounces.  There are two extra delivery gotchas on top of that:

1) The domain in the email used in the -f option in the php.ini sendmail parameter or in the mail() extra parameters field, needs to have a valid SPF record for the domain (in DNS as a "TXT" record type for sure and add an additional  "SPF" type record if possible).  Why? That's header field being used for spam checks.

2) You should also use a domain key or DKIM.  The trick here is that the domain key/DKIM is case sensitive!  I used Cpanel to create my domain key which automatically used all lowercase domain names in the key creation.  I found when  sending email and using a camel case "-f account@MyDomainHere.Com" option, my key was not accepted.  However it was accepted when I used "-f account@mydomainhere.com".

There are many other factors that can contribute to mail not getting to inboxes, including your own multiple failed testing attempts, so I suggest you consult each site's guidelines and don't ask me for help.  These are just the couple technical issues that helped my case.

I hope this saves someone some time and headaches...

down

-4

rexlorenzo at gmail dot com ¶

12 years ago

Be careful to not put extra spaces for the $headers variable.

For example, this didn't work on our servers:

$headers = "From: $from \r\n Bcc: $bcc \r\n";

But this did:

$headers = "From: $from\r\nBcc: $bcc\r\n";

Notice the removal of the spaces around the first \r\n.

down

-4

andrew at my-syte dot com ¶

2 years ago

Regarding To: 

be careful not to duplicate To in the additional_headers, 

lest gmail already flags it thus:

host gmail-smtp-in.l.google.com [142.251.xx.xx]
SMTP error from remote mail server after end of data:
550-5.7.1 [xxx.xxx.xx.xx] This message is not RFC 5322 compliant, the issue is:
550-5.7.1 duplicate To headers. To reduce the amount of spam sent to Gmail,
550-5.7.1 this message has been blocked. Please review
550 5.7.1 RFC 5322 specifications for more information.

＋add a note