9.5 Net_SMTP 
| Besprochene Version: 1.2.6 | Lizenz: PHP-Lizenz |
| Klassendatei(en): Net/SMTP.php | |
Das Versenden einer E-Mail mithilfe von PHP ist denkbar einfach. Die Funktion mail() hat allerdings den Nachteil, dass die ausgehende Mail standardmäßig über den Mailserver verschickt wird, der auf dem lokalen Rechner installiert ist. Das kann aber den Nachteil haben, dass die versandte E-Mail in Spam-Filtern hängen bleibt. Möchten Sie die Mail über einen anderen SMTP-Server versenden, ist das nicht so einfach. An dieser Stelle kann das Paket Net_SMTP Ihnen aber hilfreich zur Seite stehen. Anzumerken ist allerdings, dass Net_SMTP primär eine Implementation des SMTP-Protokolls darstellt und nicht unbedingt direkt für den Versand von Mails gedacht ist. Somit stellt das Paket eine gute Basis für eine eigene Mail-Klasse dar.
Net_SMTP ermöglicht es Ihnen, E-Mails über einen beliebigen SMTP-Server zu versenden, auf dem Sie über einen Account verfügen. Das Paket implementiert das Protokoll nach RFC 2821 [http://www.faqs.org/rfcs/rfc2821.html ] und benötigt PEAR::Net_Socket, um arbeiten zu können. Interessant ist hierbei, dass Net_SMTP nicht nur die SMTP-Standard-Authentifizierung nach RFC 2554 [http://www.faqs.org/rfcs/rfc2554.html ] unterstützt, sondern dass es auch einige andere Verfahren kennt.
Der Konstruktor bekommt den Host-Namen bzw. seine IP-Adresse übergeben und liefert das benötigte Net_SMTP-Objekt zurück. Nachdem das geschehen ist, müssen Sie eine Verbindung zu dem Server aufbauen, was die Methode connect() für Sie übernimmt. Allerdings möchte der Server in den meisten Fällen noch eine Authentifizierung durch Usernamen und Passwort von Ihnen haben. Das SMTP-Protokoll sieht nicht zwingend eine Authentifizierung vor. Allerdings sollte das inzwischen Standard sein, so dass es als ein Sicherheitsleck zu betrachten ist, wenn keine Authentifizierung erfragt wird.
Die Methode auth(), die Sie an dem Server anmeldet, bekommt den Usernamen und das Passwort übergeben. Üblicherweise benötigt sie keine Information, welche Methode genutzt werden soll, da sie selbst die beste ermittelt. Möchten Sie die Methode selbst festlegen, können Sie als dritten Parameter allerdings auch einen der Strings DIGEST-MD5, CRAM-MD5, LOGIN oder PLAIN übergeben. Möchten Sie eines der MD5-Verfahren nutzen, muss das Paket AUTH_SASL installiert sein.
// Neues Objekt instanziieren
$smtp = new Net_SMTP("smtp.netviser.de");
// Debug-Modus einschalten
$smtp->setDebug(true);
// Verbindung zum Server aufbauen
$erg = $smtp->connect();
if (PEAR::isError($erg))
{
die($erg->getMessage());
}
// Authentifizierung
$erg=$smtp->auth("cmoehrke","geheim");
if (PEAR::isError($erg))
{
die($erg->getMessage());
}
// Code zum Versenden der Mail
// Verbindung beenden
$smtp->disconnect();Listing 9.6 Verbindungsaufbau zu einem SMTP-Server
In Listing 9.6 sehen Sie die Vorgehensweise, um die Verbindung zu einem Server auf- bzw. wieder abzubauen. In diesem Beispiel wird noch die zusätzliche Methode setDebug() genutzt. Übergeben Sie Ihr ein true, was Sie nur während der Entwicklungszeit machen sollten, bekommen Sie am Ende des Scripts eine Zusammenfassung der Kommunikation mit dem Server ausgegeben.
Das disconnect() in der letzten Zeile beendet die Verbindung zum Server, so dass er nicht auf ein Timeout warten muss. Da die E-Mail erst dann verschickt wird, wenn der Server erkennt, dass die Verbindung beendet ist, kann ein korrektes Disconnect auch einen deutlichen Zeitvorteil nach sich ziehen.
Nun stellt sich nur noch die Frage, wie Sie eine E-Mail versenden können. Essenziell wichtig sind hierbei der Absender, der Empfänger und natürlich der Inhalt der Mail, die jeweils mit eigenen Methoden an das Objekt übergeben werden.
$erg=$smtp->mailFrom("absender@example.com"); if (PEAR::isError($erg)) { die($erg->getMessage()); } $erg = $smtp->rcptTo("empfaenger@example.com"); if (PEAR::isError($erg)) { die($erg->getMessage()); } $betreff="Subject: Betreffzeile der Mail"; $body = "Eine Mail mit zwei\nZeilen."; $erg=$smtp->data("$betreff\n$body"); if (PEAR::isError($erg)) { die($erg->getMessage()); }
Listing 9.7 Versenden einer E-Mail
Wie Empfänger, Absender und der Inhalt der Mail gesetzt werden, sehen Sie in Listing 9.7. Die E-Mail-Adresse des Absenders wird mit der Methode mailFrom() festgelegt, wohingegen der Empfänger durch rcptTo() definiert wird. Interessant ist hierbei, dass Sie für eine E-Mail durchaus mehrere Empfänger festlegen können, indem Sie die Methode mehrfach aufrufen.
Die Methode data() legt den eigentlichen Inhalt der Mail fest. Sie bekommt sowohl den Betreff als auch den eigentlichen Body der Mail übergeben. Wichtig hierbei ist, dass die Betreffzeile mit dem Schlüsselwort Subject: eingeleitet wird und mit einem Zeilenumbruch vom eigentlichen Körper der Mail abgetrennt wird.
Alle Methoden, die zum Definieren der eigentlichen Mail dienen, schicken die Informationen sofort an den Server. Somit ist es sinnvoll, das Ergebnis jeder Methode darauf zu prüfen, ob ein Fehler zurückgeliefert wurde.
Beim Versand von Mails müssen Sie beachten, dass der Körper der Mail so verschickt wird, wie Sie ihn übergeben haben. Die einzige Änderung, die das Paket selbstständig vornimmt, ist die Konvertierung von Zeilenumbrüchen. Ein \n oder ein \r wird also automatisch in ein \r\n konvertiert, um eine Konformität mit dem RFC zu gewährleisten.
Sollte Ihr Mailserver keine Zeilenumbrüche im Format \r\n akzeptieren, was in einigen Fällen vorkommen kann, oder benötigen Sie aus anderen Gründen eine eigene Routine zum automatischen Konvertieren des Bodys, können Sie die bestehende Methode überladen. Dazu müssen Sie eine Subklasse ableiten, in der die neue Methode implementiert wird.
class My_Net_SMTP extends Net_SMTP { function quotedata(&$data) { $data = preg_replace("/([^\r]{1})\n/", "\\1\r\n", $data); $data = preg_replace("/\n\n/", "\n\r\n", $data); $data = preg_replace("/\n\./", "\n..", $data); } }
Der Quelltext der hier dargestellten Methode entspricht dem Original. Die ersten beiden Zeilen konvertieren die Zeilenumbrüche. Die letzte Zeile konvertiert einen einfachen Punkt am Anfang einer Zeile in zwei Punkte. Der Grund dafür ist, dass ein einfacher Punkt am Zeilenanfang das Ende der Mail symbolisiert. Wie gesagt können Sie die Methode jederzeit überladen, wenn das nötig sein sollte.
Die Klasse unterstützt aber noch eine ganze Menge weiterer Befehle, die im SMTP-Protokoll definiert sind. Hiervon ist die Methode rset() sicher noch hilfreich. Mit ihr kann eine Mail, die bereits in Teilen an den Server übergeben wurde, wieder gelöscht werden. Stellen Sie also fest, dass der eigentliche Inhalt der Mail ungültig ist, nachdem Sie bereits den Absender übergeben haben, so löscht ein Aufruf von rset() die bereits übergebenen Daten. Andere Befehle wie NOOP (No Operations) sind auch implementiert. Da sie jedoch eher selten benötigt werden, gehe ich nicht weiter auf sie ein.
