(PHP 4, PHP 5, PHP 7, PHP 8)
mail — Sendet eine E-Mail
Beschreibung
string
$to
,string
$subject
,string
$message
,array|string
$additional_headers
= [],string
$additional_params
= ""): bool
Sendet eine E-Mail.
Parameter-Liste
-
to
-
Ein oder mehrere Empfänger der E-Mail.
Die Formatierung dieser Zeichenkette muss nach » RFC 2822 erfolgen. Beispiele:
- benutzer@example.com
- benutzer@example.com, benutzer2@example.com
- Name <benutzer@example.com>
- Name <benutzer@example.com>, Name2 <benutzer2@example.com>
-
subject
-
Der Betreff der E-Mail.
AchtungDie Formatierung dieser Zeichenkette muss nach » RFC 2047 erfolgen.
-
message
-
Die zu sendende Nachricht.
Jede Zeile muss durch CRLF (\r\n) getrennt werden. Außerdem sollten die Zeilen nicht mehr als 70 Zeichen enthalten.
Achtung(Nur unter Windows) Falls PHP direkt mit einem SMTP-Server kommuniziert und wenn ein Punkt (.) an einem Zeilenanfang steht, wird dieser Punkt entfernt. Um das zu verhindern, können Sie diese Punkte durch zwei Punkte ersetzen.
<?php
$text = str_replace("\n.", "\n..", $text);
?> -
additional_headers
(optional) -
string oder array, das am Ende des E-Mail-Headers eingefügt werden soll.
Dies kann benutzt werden, um zusätzliche Header wie From, Cc oder Bcc anzugeben. Falls mehrere solcher zusätzlichen Header angegeben werden sollen, müssen diese durch ein CRLF-Zeichen (\r\n) getrennt werden. Wenn von außen kommende Daten verwendet werden, um diesen Header zusammenzustellen, sollten diese Daten bereinigt werden, so dass keine ungewünschten Header eingeschleust werden können.
Wird ein array übergeben, werden dessen Schlüssel als Header-Namen, und dessen Werte als entsprechende Header-Werte interpretiert.
Hinweis:
Vor PHP 5.4.42 bzw. 5.5.27 bot
additional_headers
noch keinen Schutz vor Mail-Header-Injection. Daher müssen Anwender sicherstellen, dass die angegeben Header sicher sind und wirklich nur Header enthalten. Unter anderem ist darauf zu achten, dass mehrere aufeinanderfolgende Zeilenumbrüche den E-Mail-Header beenden.Hinweis:
Um eine E-Mail zu senden, muss die E-Mail einen
From
-Header enthalten. Dies kann entweder durch Setzen einesadditional_headers
-Parameters oder durch Setzen eines Standardwertes in der php.ini geschehen.Falls dies nicht geschieht, wird eine Fehlermeldung ähnlich wie
Warning: mail(): "sendmail_from" not set in php.ini or custom "From:" header missing
ausgegeben. DerFrom
-Header setzt unter Windows auch denReturn-Path
-Header.Hinweis:
Wenn E-Mails nicht ankommen, versuchen Sie bitte, nur das LF-Zeichen (\n) zu verwenden. Einige UNIX-MTAs (Mail Transfer Agents) (ganz besonders » qmail) ersetzen leider LF durch CRLF (\r\n) automatisch (wodurch das CR-Zeichen verdoppelt wird, wenn CRLF verwendet wird). Dies sollte aber nur in Ausnahmefällen geschehen, da es gegen » RFC 2822 verstößt.
-
additional_params
(optional) -
Der Parameter
additional_params
kann verwendet werden, um zusätzliche Parameter an das Programm zu senden, das für den E-Mail-Versand konfiguriert ist (wenn diesendmail_path
-Einstellung verwendet wird). Zum Beispiel kann hiermit die Envelope Sender Address (Umschlag-Absenderadresse) gesetzt werden, wenn sendmail mit der-f
-Option verwendet wird.Dieser Parameter wird intern durch escapeshellcmd() maskiert, um die Kommando-Injection zu verhindern. escapeshellcmd() verhindert die Kommando-Injection, erlaubt aber, zusätzliche Parameter hinzuzufügen. Aus Sicherheitsgründen wird empfohlen, dass dieser Parameter bereinigt wird, um zu verhindern, dass keine unerwünschten Parameter an das Shell-Kommando übergeben werden.
Da escapeshellcmd() automatisch angewendet wird, können einige Zeichen, die gemäß Internet-RFCs in E-Mail-Adressen erlaubt sind, nicht verwendet werden. mail() kann solche Zeichen nicht erlauben, so dass für Programme, die diese Zeichen unterstützen müssen, alternative Methoden für den E-Mail-Versand (wie beispielsweise die Verwendung eines Frameworks oder einer Bibliothek) empfohlen werden.
Der Benutzer, unter dem der Webserver läuft, sollte als vertrauenswürdiger Benutzer in der sendmail-Konfiguration eingetragen werden, um zu verhindern, dass ein 'X-Warning'-Header zu den E-Mails hingefügt wird, wenn mit dieser Methode (-f) der Absender gesetzt wird. Sendmail-Benutzer finden diese Datei hier: /etc/mail/trusted-users.
Rückgabewerte
Gibt true
zurück, wenn die E-Mail erfolgreich für den Versand akzeptiert
wurde, sonst false
.
Dass eine E-Mail für den Versand akzeptiert wurde, bedeutet NICHT, dass sie auch wirklich den gewünschten Empfänger erreichen wird.
Changelog
Version | Beschreibung |
---|---|
7.2.0 |
Der additional_headers Parameter akzeptiert nun
ebenfalls ein array.
|
Beispiele
Beispiel #1 Verschicken einer E-Mail
mail() wird benutzt, um eine einfache E-Mail zu versenden:
<?php
// Die Nachricht
$nachricht = "Zeile 1\r\nZeile 2\r\nZeile 3";
// Falls eine Zeile der Nachricht mehr als 70 Zeichen enthälten könnte,
// sollte wordwrap() benutzt werden
$nachricht = wordwrap($nachricht, 70, "\r\n");
// Verschicken
mail('benutzer@example.com', 'Mein Betreff', $nachricht);
?>
Beispiel #2 Verschicken einer E-Mail mit zusätzlichen Headern
Hier werden einfache Header gesetzt, um dem MUA (Mail User Agent, z.B. ein E-Mail-Programm) die From- und die Reply-To-Adressen mitzuteilen:
<?php
$empfaenger = 'niemand@example.com';
$betreff = 'Der Betreff';
$nachricht = 'Hallo';
$header = 'From: webmaster@example.com' . "\r\n" .
'Reply-To: webmaster@example.com' . "\r\n" .
'X-Mailer: PHP/' . phpversion();
mail($empfaenger, $betreff, $nachricht, $header);
?>
Beispiel #3 Verschicken einer E-Mail mit zusätzliche Headern als Array
Dieses Beispiel verschickt die selbe E-Mail wie das Beispiel direkt darüber, aber diesemal werden die zusätzlichen Header als Array übergeben (verfügbar von PHP 7.2.0 an).
<?php
$empfaenger = 'niemand@example.com';
$betreff = 'Der Betreff';
$nachricht = 'Hallo';
$header = array(
'From' => 'webmaster@example.com',
'Reply-To' => 'webmaster@example.com',
'X-Mailer' => 'PHP/' . phpversion()
);
mail($empfaenger, $betreff, $nachricht, $header);
?>
Beispiel #4 Verschicken einer E-Mail mit einem zusätzlichen Kommandozeilen-Parameter
Der Parameter additional_params
kann verwendet
werden, um einen zusätzlichen Parameter an das über
sendmail_path
konfigurierte Programm zu senden.
<?php
mail('niemand@example.com', 'Betreff', 'Nachricht', null,
'-fwebmaster@example.com');
?>
Beispiel #5 Verschicken einer HTML-E-Mail.
Auch HTML-E-Mails können mit mail() versendet werden.
<?php
// mehrere Empfänger
$empfaenger = 'max@example.com, moritz@example.com'; // beachte das Komma
// Betreff
$betreff = 'Geburtstags-Erinnerungen für August';
// Nachricht
$nachricht = '
<html>
<head>
<title>Geburtstags-Erinnerungen für August</title>
</head>
<body>
<p>Hier sind die Geburtstage im August:</p>
<table>
<tr>
<th>Person</th><th>Tag</th><th>Monat</th><th>Jahr</th>
</tr>
<tr>
<td>Max</td><td>3.</td><td>August</td><td>1970</td>
</tr>
<tr>
<td>Moritz</td><td>17.</td><td>August</td><td>1973</td>
</tr>
</table>
</body>
</html>
';
// für HTML-E-Mails muss der 'Content-type'-Header gesetzt werden
$header[] = 'MIME-Version: 1.0';
$header[] = 'Content-type: text/html; charset=iso-8859-1';
// zusätzliche Header
$header[] = 'To: Simone <simone@example.com>, Andreas <andreas@example.com>';
$header[] = 'From: Geburtstags-Erinnerungen <geburtstag@example.com>';
$header[] = 'Cc: geburtstagsarchiv@example.com';
$header[] = 'Bcc: geburtstagscheck@example.com';
// verschicke die E-Mail
mail($empfaenger, $betreff, $nachricht, implode("\r\n", $header));
?>
Hinweis:
Wenn HTML- oder anderweitig komplexe E-Mails versendet werden sollen, ist es empfehlenswert, das PEAR-Paket » PEAR::Mail_Mime zu verwenden.
Anmerkungen
Hinweis:
Die SMTP-Implementierung (nur unter Windows) von mail() unterscheidet sich auf mehrere Arten von der Unix-Implementierung. Zum einen verwendet sie kein lokales Programm, um die Mails zu erstellen, sondern arbeitet auf Sockets. D.h., es wird ein
MTA
benötigt wird, der auf einem Netzwerk-Socket lauscht (entweder auf dem eigenen oder einem entfernten Rechner).Zum anderen, werden die benutzerdefinierten Header wie
From:
,Cc:
,Bcc:
undDate:
nicht direkt durch denMTA
interpretiert, sondern zunächst von PHP geparst.Daher sollte der Parameter
to
keine Adresse der Form "Irgendwas <irgendwer@example.com>" enthalten, da dies von PHP möglicherweise nicht korrekt an den MTA übergeben werden kann.
Hinweis:
Es ist zu beachten, dass die Funktion mail() nicht dazu geeignet ist, große Mengen von E-Mails in einer Schleife zu senden, da die Funktion für jede E-Mail einen SMTP-Socket öffnet und schließt, was nicht sehr effizient ist.
Um große Mengen von E-Mails zu senden, können die PEAR-Pakete » PEAR::Mail und » PEAR::Mail_Queue verwendet werden.
Hinweis:
Die folgenden RFCs könnten nützlich für Sie sein: » RFC 1896, » RFC 2045, » RFC 2046, » RFC 2047, » RFC 2048, » RFC 2049 und » RFC 2822.
Siehe auch
- mb_send_mail() - Send encoded mail
- imap_mail() - Sendet eine E-Mail-Nachricht
- » PEAR::Mail
- » PEAR::Mail_Mime