Fonctions Mail
Mailparse
Fonctions Mail
PHP Manual

# mail

(PHP 4, PHP 5)

mail — Envoi de mail

### Description

bool mail ( string `$to` , string `$subject` , string `$message` [, string `$additional_headers` [, string `$additional_parameters` ]] )

Envoi un mail.

### Liste de paramètres

`to`

  Le ou les destinataires du mail.

  Le formatage de cette chaîne doit correspondre avec la » RFC 2822. Voici quelques exemples :

  - destinataire@example.com
  - destinataire.com, autre_destinataire@example.com
  - Destinataire <destinataire@example.com>
  - Destinataire <destinataire@example.com>, Autre destinataire <autre_destinataire@example.com>
`subject`

  Sujet du mail à envoyer.

  Attention

  Il ne doit comporter aucun caractère de nouvelle ligne sinon, le mail risque de ne pas être envoyé correctement.

`message`

  Message à envoyer.

  Chaque ligne doit être séparée par un caractère LF (\n). Les lignes ne doivent pas comporter plus de 70 caractères.

  Attention

  (Windows uniquement) Lorsque PHP discute directement avec un serveur SMTP, si un point est trouvé en début de ligne, il sera supprimé. Pour éviter ce comportement, remplacez ces occurrences par un double point.

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

  Chaîne à insérer à la fin des en-têtes du mail.

  Ce paramètre est typiquement utilisé pour ajouter des en-têtes supplémentaires (From, Cc et Bcc). Les en-têtes supplémentaires doivent être séparés par un caractère CRLF (\r\n).

  > Note: Lors de l'envoi d'un mail, le mail doit contenir un en-tête From. Il peut être défini par le paramètre `additional_headers` , ou un par défaut peut être défini dans le php.ini.
  > Ne pas faire ceci causera un message d'erreur similaire à Warning: mail(): "sendmail_from" not set in php.ini or custom "From:" header missing. L'en-tête From définit également l'en-tête Return-Path sous Windows.

  > Note: Si le message n'est pas reçu, essayez d'utiliser uniquement un caractère LF (\n). Quelques agents de transfert de mail Unix de mauvaise qualité remplacent le caractère LF par le caractère CRLF automatiquement (ce qui revient à doubler le caractère CR si le caractère CRLF est utilisé). Ceci doit être un dernier recours car cela ne correspond pas à la » RFC 2822.

`additional_parameters` (optionnel)

  Le paramètre `additional_parameters` peut être utilisé pour passer des paramètres additionnels au programme configuré à être utilisé pour envoyer les mails en utilisant le paramètre de configuration sendmail_path. Par exemple, ceci peut être utilisé pour définir l'enveloppe de l'adresse de l'expéditeur lors de l'utilisation de sendmail avec l'option -f.

  L'utilisateur sous lequel tourne le serveur web doit être ajouté en tant qu'utilisateur de confiance dans la configuration de sendmail afin que l'en-tête X-Warning ne soit pas ajouté au message lorsque l'enveloppe de l'expéditeur (-f) est défini en utilisant cette méthode. Pour les utilisateurs de sendmail, ce fichier est /etc/mail/trusted-users.

### Valeurs de retour

Retourne `TRUE` si le mail a été accepté pour livraison, `FALSE` sinon.

Il est important de noter que ce n'est pas parce que le mail a été accepté pour livraison qu'il arrivera à destination.

### Historique

Version | Description
--- | ---
4.3.0 (Windows uniquement) | Tous les en-têtes personnalisés (comme "From", "Cc", "Bcc" et "Date") sont supportés et ne sont pas sensibles à la casse. (Parce que les en-têtes personnalisés ne sont pas interprétés par le MTA dans un premier temps mais analysés par PHP, PHP 4.3 supporte uniquement l'en-tête Cc et est sensible à la casse).
4.2.3 | Le paramètre `additional_parameters` est désactivé dans le safe_mode et la fonction mail() affichera un message d'alerte et retournera `FALSE` lors de son utilisation.
4.0.5 | Le paramètre `additional_parameters` a été ajouté.

### Exemples

Exemple #1 Envoi d'un mail

Utilisation de la fonction mail() pour envoyer un mail simple :

`<?php
// Le message
$message = "Line 1\nLine 2\nLine 3";
// Dans le cas où nos lignes comportent plus de 70 caractères, nous les coupons en utilisant wordwrap()
$message = wordwrap($message, 70);
// Envoi du mail
mail('caffinated@example.com', 'Mon Sujet', $message);
?>`

Exemple #2 Envoi d'un mail avec des en-têtes supplémentaires.

L'ajout d'en-têtes simples, spécifiant au MUA les adresses "From" et "Reply-To" :

`<?php
$to = 'personne@example.com';
$subject = 'le sujet';
$message = 'Bonjour !';
$headers = 'From: webmaster@example.com' . "\r\n" .
'Reply-To: webmaster@example.com' . "\r\n" .
'X-Mailer: PHP/' . phpversion();
mail($to, $subject, $message, $headers);
?>`

Exemple #3 Envoi d'un mail avec un paramètre de ligne de commande additionnel

Le paramètre `additional_parameters` peut être utilisé pour passer un paramètre additionnel au programme configuré à être utilisé pour envoyer les mails en utilisant sendmail_path.

`<?php
mail('personne@example.com', 'le sujet', 'le message', null,
'-fwebmaster@example.com');
?>`

Exemple #4 Envoi de mail HTML

Il est également possible d'envoyer des mails HTML avec la fonction mail().

`<?php
// Plusieurs destinataires
$to = 'aidan@example.com' . ', '; // notez la virgule
$to .= 'wez@example.com';
// Sujet
$subject = 'Calendrier des anniversaires pour Août';
// message
$message = '
<html>
<head>
<title>Calendrier des anniversaires pour Août</title>
</head>
<body>
<p>Voici les anniversaires à venir au mois d\'Août !</p>
<table>
<tr>
<th>Personne</th><th>Jour</th><th>Mois</th><th>Année</th>
</tr>
<tr>
<td>Josiane</td><td>3</td><td>Août</td><td>1970</td>
</tr>
<tr>
<td>Emma</td><td>26</td><td>Août</td><td>1973</td>
</tr>
</table>
</body>
</html>
';
// Pour envoyer un mail HTML, l'en-tête Content-type doit être défini
$headers = 'MIME-Version: 1.0' . "\r\n";
$headers .= 'Content-type: text/html; charset=iso-8859-1' . "\r\n";
// En-têtes additionnels
$headers .= 'To: Mary <mary@example.com>, Kelly <kelly@example.com>' . "\r\n";
$headers .= 'From: Anniversaire <anniversaire@example.com>' . "\r\n";
$headers .= 'Cc: anniversaire_archive@example.com' . "\r\n";
$headers .= 'Bcc: anniversaire_verif@example.com' . "\r\n";
// Envoi
mail($to, $subject, $message, $headers);
?>`

> Note: Si vous prévoyez d'envoyer des mails HTML ou autrement plus complexes, il est recommandé d'utiliser le paquet PEAR » PEAR::Mail_Mime.

### Notes

> Note: L'implémentation de la fonction mail() sous Windows diffère de manière significative avec l'implémentation Unix. Tout d'abord, il n'utilise pas un programme local pour composer les messages, mais opère uniquement et directement sur les sockets, ce qui signifie qu'un MTA est nécessairement à l'écoute sur un socket du réseau (qui peut être soit sur le réseau local ou sur une machine distante).
> Deuxièmement, les en-têtes personnalisés comme From:, Cc:, Bcc: et Date: ne sont pas interprétés par le MTA dans un premier temps, mais sont analysés par PHP.
> De plus, le paramètre `to` ne doit pas être une adresse sous la forme "Quelque chose <quelqu_un@example.com>". La commande mail n'analysera pas correctement ceci lors de la discussion avec le MTA.

> Note: Les mails avec des pièces jointes et des types spéciaux de contenus (e.g. HTML) peuvent être envoyés en utilisant cette fonction. Ceci est accompli grâce à l'encodage MIME : pour plus d'informations, lisez cet » article de Zend ou les » classes PEAR Mime.

> Note: Il est important de noter que la fonction mail() n'est pas conseillée pour traiter de gros volumes de mails dans une boucle. Cette fonction ouvre et ferme un socket SMTP pour chaque mail, ce qui n'est pas très efficace.
> Pour envoyer de gros volumes de mails, reportez-vous aux paquets » PEAR::Mail et » PEAR::Mail_Queue.

> Note: Les RFC suivantes peuvent être utiles : » RFC 1896, » RFC 2045, » RFC 2046, » RFC 2047, » RFC 2048, » RFC 2049 et » RFC 2822.

### Voir aussi

- imap_mail()
- » PEAR::Mail
- » PEAR::Mail_Mime

Fonctions Mail
Mailparse
Fonctions Mail
PHP Manual