Skip to content

Latest commit

 

History

History
296 lines (194 loc) · 10.3 KB

addon-phpmailer.md

File metadata and controls

296 lines (194 loc) · 10.3 KB
Raw

PHPMailer

Allgemeines

Das PHPMailer-AddOn ermöglicht den Versand von E-Mails. Zusätzlich kann PHPMailer den Administrator bei aufgetretenen Fehlern im System per E-Mail benachrichtigen.

Unterstützt werden folgende Sendeverfahren

  • php mail()
  • sendmail
  • SMTP/SMTPS
  • SMTP/SMTPS-Auth

Der Aufruf erfolgt über die Klasse rex_mailer . Dabei werden die nachfolgend beschriebenen und in der Konfiguration hinterlegten Einstellungen berücksichtigt.

Die Werte der Konfiguration können in AddOns oder Modulen leicht überschrieben werden, siehe Beispiele.

Liefert ein AddOn oder Modul keine eigenen Einstellungen für das Versenden der E-Mails, gelten die Sende-Einstellungen im PHPMailer-AddOn.

Weitere Informationen zur Verwendung von PHPMailer unter: https://github.com/PHPMailer/PHPMailer/wiki/Tutorial

Hinweis: Eine Test-Mail kann mit dem Button Speichern und testen verschickt werden. Hierzu müssen unbedingt Absender- und Test-Adresse festgelegt werden.

PHPMailer Code-Beispiele

1. Beispiel

E-Mail an einen bestimmten Empfänger senden.

<?php
  // PHPMailer-Instanz
  $mail = new rex_mailer();

  //Absenderadresse überschreiben
 // $mail->From = "[email protected]";

  //Absendername überschreiben
  // $mail->FromName = "Vorname Nachname";

  // Antwortadresse festlegen
  // $mail->addReplyTo("[email protected]", "Software Simian");

  // Empfänger
  $mail->addAddress("[email protected]");

  // Empfänger als CC hinzufügen - Weitere anlegen wenn mehrere erwünscht
  // $mail->addCC("[email protected]);

  // Empfänger als BCC hinzufügen - Weitere anlegen wenn mehrere erwünscht
  // $mail->addBCC("[email protected]");

  //Betreff der E-Mail
  $mail->Subject = "PHPMailer-Test";

  //Text der EMail setzen
  $mail->Body = "Hi \n\n this mail was sent by PHPMailer!";

  //Überprüfen ob E-Mail gesendet wurde
  if(!$mail->send())
  {
     echo "An error occurred";
     echo "Error: " . $mail->ErrorInfo;
  }
  else
  {
     echo "E-Mail has been sent";
  }

2. Beispiel

E-Mail an einen Empfängerkreis senden, der aus der Datenbank ausgelesen wird.

<?php

$mail = new rex_mailer();
$sql = rex_sql::factory();

$query = "SELECT full_name, email, photo FROM employee WHERE id= ?";
$sql->setQuery($query, array($id));

foreach($sql as $row)
{
    // HTML body
    $body  = "Hello <font size=\"4\">" . $row->getValue("full_name") . "</font>, <p>";
    $body .= "<i>Your</i> personal photograph to this message.<p>";
    $body .= "Sincerely, <br />";
    $body .= "phpmailer List manager";

    // Plain text body (for mail clients that cannot read HTML)
    $text_body  = "Hello " . $row->getValue("full_name") . ", \n\n";
    $text_body .= "Your personal photograph to this message.\n\n";
    $text_body .= "Sincerely, \n";
    $text_body .= "phpmailer List manager";

    $mail->Body    = $body;
    $mail->Subject = "PHPMailer-Test";
    $mail->AltBody = $text_body;
    $mail->AddAddress($row->getValue("email"), $row->getValue("full_name"));
    $mail->AddStringAttachment($sql->getValue("photo"), "YourPhoto.jpg");

    if(!$mail->Send())
        echo "There has been a mail error sending to " . $row->getValue("email") . "<br>";

    // Clear all addresses and attachments for next loop
    $mail->ClearAddresses();
    $mail->ClearAttachments();
}

E-Mail-Versand auf Testadresse umleiten

Wird diese Option aktiviert, werden alle über PHPMailer verschickten E-Mails an die Adresse für Testzwecke verschickt.

E-Mail-Benachrichtigung bei Fehlern

PHPMAiler versendet einen Auszug des system.log, wenn es Exceptions, Errors und eigene Logevents findet. Der Check und ggf. die Zusendung erfolgen in festen Intervallen, die in den Systemeinstellungen definiert werden können. Empfänger ist die im System hinterlegte Fehleradresse.

Eigene Events können den Versand ebenso auslösen, dazu kann man im Log den Event als Typ: logevent ablegen.

rex_logger::factory()->log('logevent', 'Mein Text zum Event');

SMTP-Debug

Das Setzen des Debug-Modus führt zu unterschiedlichen Ausgaben

Client-Protokoll

Liefert das Protokoll für den Verbindungsaufbau durch den Client

Server-und Client-Protokoll

Liefert zusätzlich die Informationen vom Server. Das ist die empfohlene Option.

Verbindungsprotokoll

Liefert noch ausführlichere Informationen und ist ideal, um Probleme mit STARTTLS zu analysieren.

Low Level Protokoll

Liefert zusätzlich untergeordnete Informationen, sehr ausführlich. Nicht zum Debuggen von SMTP gedacht, nur bei Low-Level-Problemen.

Meist benötigt man keinen Level über Server-und Client-Protokoll, es sei denn, es liegen Schwierigkeiten bei der Verbindung vor. In der Regel wird die Ausgabe nur umfangreicher und schwieriger zu lesen sein.

E-Mail-Log und E-Mail-Archivierung

Das AddOn stellt ein E-Mail-Log sowie eine E-Mail-Archivierung bereit.

E-Mail-Log

Das E-Mail-Log findet im man im Tab E-Mail-Log und unter System > Logdateien > PHPMailer . Das Logging kann in den Einstellungen des PHPMailer-AddOns in 3 Stufen eingestellt werden.

  • Nein: Es wird kein Log erstellt
  • Nur Fehler loggen: Es werden nur Fehler geloggt
  • Alle Vorgänge loggen: Alle Sendungen werden geloggt

Das Log liefert Informationen zu Zeit, Absender, Empfänger, Betreff und Meldung. Es kann über den Button Logdatei löschen geleert werden.

Das Log wird in der Datei /redaxo/data/log/mail.log gespeichert.

Sollten replyTo-Adressen in der E-Mail enthalten sein, werden diese auch im E-Mail-Log festgehalten. Häufig werden diese als Adressen der Absender genutzt.

E-Mail-Archivierung

Bei eingeschalteter E-Mail-Archivierung werden alle E-Mails im Ordner /redaxo/data/addons/phpmailer/mail_log im .eml-Format chronologisch nach Jahr und Monat in Unterordnern vollständig archiviert. .eml-Dateien können in gängigen E-Mail-Programmen zur Betrachtung geöffnet und importiert werden.

Das Archiv kann über den CronJob "Mailer-Archiv bereinigen" regelmäßig bereinigt werden. Es werden auch nicht verschickte Mails archiviert.

Extension-Point PHPMAILER_CONFIG

Die Konfiguration kann mittels Extension-Point überschrieben und/oder ergänzt werden. Weitere Informationen zur PHPMailer-Konfiguration beim Vendor.

Das folgende Beispiel zeigt die Verwendung von selbst signierten Zertifikaten.

Per Default wird der Peer verifiziert. Dies kann ggf. zu Problemen führen. Die nachfolgenden Einstellungen helfen, dieses Problem zu umgehen.

rex_extension::register('PHPMAILER_CONFIG', function (rex_extension_point $ep) {
    $subject = $ep->getSubject();
    // set SMTPOptions
    $subject->SMTPOptions = [
        'ssl' => [
            'verify_peer' => false,
            'verify_peer_name' => false,
            'allow_self_signed' => true
        ],
        'tls' => [
            'verify_peer' => false,
            'verify_peer_name' => false,
            'allow_self_signed' => true
        ],
    ];
});

Tipps

Verschlüsselung: Automatische TLS-Verbindung

PHPMailer prüft ob der angegebene Server TLS unterstützt und baut eine verschlüsselte TLS-Verbindung auf. Erlaubt der Server keine Verschlüsselung, wird eine unsichere Verbindung aufgebaut. Sollte es zu Problemen beim Versand kommen, liegt es häufig daran, dass das hinterlegte Zertifikat nicht mit dem angegebenen Host übereinstimmt oder kein gültiges Zertifikat gefunden wurde. Durch Ändern der Verschlüsselung auf "manuelle Auswahl" kann die automatische Erkennung deaktiviert werden und die Verschlüsselung manuell gewählt werden.

Diese Einstellung kann zu unsicheren Verbindungen führen, sollte keine TLS-Unterstützung gefunden werden. Eine Überprüfung per Debug-Modus Verbindungsprotokoll sollte durchgeführt werden.

Spam-Blocker

  • Der Server, der die E-Mails versendet, sollte möglichst per SPF-Eintrag für die verwendete E-Mail-Domain als autorisierter Server im DNS hinterlegt sein.

  • Priorität-Einstellungen können zu einem Spam-Blocking führen.

  • Große E-Mail-Verteiler sollten möglichst in kleiner Zahl und als BCC verschickt werden.

Verwendung bei selbst signierten Zertifikaten

Per Default wird der Peer verifiziert. Dies kann ggf. zu Problemen führen. Die nachfolgenden Einstellungen helfen, dieses Problem zu umgehen.

<?php

$mail = new rex_mailer();
$mail->SMTPOptions = array(
    'ssl' => array(
        'verify_peer' => false,
        'verify_peer_name' => false,
        'allow_self_signed' => true
    ),
    'tls' => array(
        'verify_peer' => false,
        'verify_peer_name' => false,
        'allow_self_signed' => true
    ),
);

Senden über unterschiedliche Domains

Werden E-Mails über unterschiedliche Absender-Domains verschickt, sollte der SPF-Eintrag der Absender-Domain(s) in den DNS-Einstellungen

  • den Webserver (bei sendmail und mail)
  • oder den angegebenen SMTP(S)-Server

als erlaubte Server-Adressen beinhalten.

z. B. a:meine-domain.tld ip4:XXX.XXX.XXX.XXX

Somit wird sichergestellt, dass PHPMailer E-Mails unter der angegebenen Domain versenden kann und die Mail nicht als SPAM deklariert wird.

Hierzu ggf. den Registrar oder DNS-Administrator kontaktieren.

Warum wird die Domain beim Absender geändert?

In vielen Server-Konfigurationen sendet sendmail nur Mails wenn die Absender-Domain auch auf dem Server eingerichtet ist. Das gilt für den Versand per php mail() und sendmail. Abhilfe hierfür verschaffen das Einrichten der Domain auf dem Server oder der Versand über einen SMTP-Server.