SMTPClient
class SMTPClient extends Client implements MessageClient
Mails per SMTP versenden RFC 2821.
Traits
Constants
VERSION |
Generelle Alvine-Version |
APIVERSION |
Version der API-Version der Klasse. |
IDENTIFICATION |
Identifizierung der Alvine API |
SERIALVERSION |
Version der Klasse (wird für die Serialisierung verwendet. Ändert sich der interne Aufbau der Klasse, so muss dieser Wert nach oben gesetzt werden. Die Serialisierung muss diesen Wert abfragen und bei Bedarf einen Wrapper für das Arbeiten mit veralteten Objekten implmenetieren. |
NONBLOCKING |
Verhalten der Zugriff ist nicht blockierend (es wird auf Daten gewartet) |
BLOCKING |
Verhalten der Zugriff ist blockierend (es wird auf Daten gewartet) |
ENDOFLINE |
Zeilenende nach Standard RFC 2821 |
ENDOFDATA |
Ende des Data-Blocks |
Properties
protected boolean | $hasAssociatedProperties | from SerializableImplementation | |
protected boolean | $hasVolatileProperties | from SerializableImplementation | |
protected array | $properties | from Alvine | |
protected string | $hash | Eindeutige ID | from Alvine |
protected string | $protocol | from Socket | |
protected string | $host | from Socket | |
protected int | $port | from Socket | |
protected string | $receiveBuffer | from Socket | |
protected string | $path | Optionaler Pfad um z.B. mehrere Verbindungen zu einem Host:Port aufmachen zu können tcp://mysql.example.com:3306/root Oder um einen Pfad zu einem UNIX-Socket anzugeben unix:///full/path/to/my/socket.sock | from Socket |
protected int | $timeout | from Socket | |
protected int | $connectionMode | from Socket | |
protected State | $state | from Socket | |
protected Resource | $socket | from Socket | |
protected boolean | $logFlag | from Socket | |
protected string | $log | from Socket | |
protected int | $flags | from Socket | |
protected Context | $context | from Socket | |
protected int | $blockSize | from Socket | |
static protected array | $availableTransports | Unterstütze Protokolle | from Socket |
protected Authentication | $authentication | ||
protected User | $username | ||
protected Password | $credential | ||
protected integer | $cryptoMethod | ||
protected array | $extensions |
Methods
Prüfen ob das Objekt associative Eigenschaften besitzt
Prüfen ob das Objekt volatile Eigenschaften besitzt
Umgang mit Versionen
Jede von der Alvine-Klasse abgeleitete Klasse besitzt die Fähigkeit beliebige Werte und Lambda-Funktionen an das Objekt zu hängen.
Wird aufgerufen, wenn isset() auf ein internes Property angewendet wird.
Diese Methode wird inplizit aufgerufen wenn eine nicht definierte Eigenschaft abgefragt wird. Ist die Eigenschaft eine Anonyme-Funktion (Closure), so wird diese Funktion aufgerufen und die Klasse als Parameter übergeben.
Closure über den definierten Namen holen. Ist keine Eigenschaft mit dem Namen definiert, so wird eine BadPropertyException geworfen. Gibt es eine Eigenchaft mit dem Namen, ist diese aber kein Closure, so wird eine NotFoundException geworfen.
Prüfen ob eine Eigenschaft als dynamische Eigenschaft verfügbar ist, die über $obj->property abgefragt werden kann.
Ein Closures das dem Objekt übergeben wurde, kann entweder als Property oder als Funktion aufgerufen werden.
Mit dieser Methode kann geprüft werden, ob eine Methode aufrufbar ist. Das gilt für echte und eingehängte DI-Methoden (Lambda).
Diese Methode gibt eine eindeutige ID des Objektes zurück. Bei der ID handelt es sich um eine Zeichenkette in der Form einer UUID.
Diese Methode entfernt alle Minuszeichen aus der UUID des Hash. Wird eine Länge definiert, so wird nach dem entfernen der Minuszeichen die ersten $length Zeichen zurückgegeben.
Diese Funktion vergleicht zwei Objekte. Dazu wird von beiden der
Wert, der von Alvine::getID()
zurückgeliefert wird ermittelt und das
Ergebnis verglichen. Vererbte Klassen können diese Methode überschreiben.
Diese Methode gibt ein geklontes Objekt von sich selber zurück.
Interne Hook für das Clonen des Objektes. Wenn das zu klonende Objekt bereits eine eindeutige ID hat, dann wird auch für das neue Objekt eine eindeutige ID erstellt.
Prüft ob das übergebene Objekt eine Instanz dieses Objektes ist. Allerdings ist darauf zu achten, das vorher definiert wurde, das das neue Objekt von Alvine abgeleitet wurde.
Neues SMTPClient Objekt erstellen.
Netzwerkverbindung öffnen. Ist bereits eine Verbindung aktiv, so wird diese Verbindung geschlossen und eine neue Verbindung geöffnet.
Diese Methode entfernt einen Beobachter von der Liste der Status-Beobchter.
Die Rückgabe muss nach RFC821 immer folgendermaßen definiert sein:
Ermöglicht das überarbeiten der empfangenen Daten, insbesondere bei Clients die ein Long-Polling verwenden.
Gekapselter Funktionsaufruf für socket_get_status
Gekapselter Funktionsaufruf für stream_get_contents
Holt das Ergebnis vom Mailserver und prüft auf einen 500 Fehler.
Prüft das Ergebnis vom Mailserver auf einen bestimmten Code
Sendet den Befehl HELO
Sendet den Befehl EHLO
Prüfen ob der Server die Extension unterstützt
Liefert die Parameter (falls definiert) der Extension zurück
Anmeldung setzen (der Aufruf muss vor dem Mailversand erfolgen)
Anmeldung senden
Umschalten auf TLS Verbindung
Sendet den Envelope Empfänger
Sendet den Befehl QUIT
Sendet den DATA-Befehl und übergibt die Daten. Als letztes wird eine End-of-Data-Sequenz übergebene und damit der Mailversand abgeschlossen.
Zugangsdaten setzen
Details
in SerializableImplementation at line 125
string
serialize()
Serialisieren
Serialisierung des Objekts und der Daten. In dem serialisierten Objekt werden auch Meta-Informationen zum Abgleich gespeichert. Soll eine abgeleitete Klasse nicht serialisierbar sein, so muss diese Methode überschrieben werden und eine Exception werfen.
Eigenschaften die mit volatile oder associated beginnen werden gesonder behandelt. Eigenschaften mit Prefix volatile werde nicht serialisiert. Bei Eigenschaften mit der Vorsilbe associated wird nur die ID des Objektes serialisiert. Wird in der Eigenschaft kein Objekt gespeichert wird eine TypeException geworfen.
in SerializableImplementation at line 197
boolean
hasAssociatedProperties()
Prüfen ob das Objekt associative Eigenschaften besitzt
in SerializableImplementation at line 209
boolean
hasVolatileProperties()
Prüfen ob das Objekt volatile Eigenschaften besitzt
in SerializableImplementation at line 232
protected
checkAndAdjustSerialisation(array $serialization)
Umgang mit Versionen
Diese Methode überprüft ein Objekt und repariert im idealfall ältere Kopien. Kann eine alte Kopie nicht wieder hergestellt werden, so wird eine Exeption geworfen.
Diese Methode muss von den abgeleiteten Klassen überschrieben werden. In der abgeleiteten Klasse sollte die Parent-Methode aufgerufen werden.
in SerializableImplementation at line 257
unserialize(string $serialization)
Klasse deserialisieren
Diese Methode wird in der Folge durch \unserialize aufgerufen und initialisert das neue Objekt. Diese Methode sollte so nicht selber aufgerufen werden.
in Alvine at line 178
string
__toString()
Standardumwandlung des Inhalts der Klasse in eine Zeichenkette
echo (string) new MyObect();
in Alvine at line 212
void
__set(string $name, mixed $value)
Jede von der Alvine-Klasse abgeleitete Klasse besitzt die Fähigkeit beliebige Werte und Lambda-Funktionen an das Objekt zu hängen.
Diese Methode wird indirekt aufgerufen, sobald ein Wert oder eine Funktion einem Objekt zugeordnet wird, die nicht definiert wurde.
class MyObject extends Alvine {
}
$obj = new MyObject();
$obj->myValue = 4;
in Alvine at line 223
boolean
__isset(string $name)
Wird aufgerufen, wenn isset() auf ein internes Property angewendet wird.
in Alvine at line 232
__unset(string $name)
Zurücksetzen von Werten
in Alvine at line 257
mixed
__get(string $name)
Diese Methode wird inplizit aufgerufen wenn eine nicht definierte Eigenschaft abgefragt wird. Ist die Eigenschaft eine Anonyme-Funktion (Closure), so wird diese Funktion aufgerufen und die Klasse als Parameter übergeben.
Vor der Abfrage sollte, damit keine Exception geworfen wird, die Existenz der Eigenschaft geprüft werden.
if($obj->propertyExists('myproperty')) {
$value = $obj->myproperty;
}
in Alvine at line 282
Closure
getClosure(string $name)
Closure über den definierten Namen holen. Ist keine Eigenschaft mit dem Namen definiert, so wird eine BadPropertyException geworfen. Gibt es eine Eigenchaft mit dem Namen, ist diese aber kein Closure, so wird eine NotFoundException geworfen.
in Alvine at line 308
boolean
propertyExists(string $name)
Prüfen ob eine Eigenschaft als dynamische Eigenschaft verfügbar ist, die über $obj->property abgefragt werden kann.
if($obj->propertyExists('myproperty')) {
$value = $obj->myproperty;
}
in Alvine at line 340
mixed
__call(string $name, array $arguments)
Ein Closures das dem Objekt übergeben wurde, kann entweder als Property oder als Funktion aufgerufen werden.
Achtung: Wird das Closure in einem Objekt definiert, so ist die Variable $this nicht das Objekt des Closures, sondern des, in dem das Closure definiert wurde.
// als erster Parameter wird immer das Objekt übergeben
$a->myfunction = function($obj, $b) { echo $b.'!'; };
// Aufruf als Eigenschaft ohne Parameter
$a->myfunction; // Ausgabe ist ein !
//
// Aufruf als Methode mit Parametern
$a->myfunction('OK'); // Ausgabe ist OK!
in Alvine at line 363
boolean
isCallable(type $name)
Mit dieser Methode kann geprüft werden, ob eine Methode aufrufbar ist. Das gilt für echte und eingehängte DI-Methoden (Lambda).
if($obj->isCallable('myfunction')) {
$obj->myfunction();
}
in Alvine at line 377
string
getHashCode()
deprecated
deprecated
Die Methode Alvine::getID() verwenden!
in Alvine at line 397
string
getID()
Diese Methode gibt eine eindeutige ID des Objektes zurück. Bei der ID handelt es sich um eine Zeichenkette in der Form einer UUID.
Objekte haben bei der Erstellung noch keine eindeutige ID, erst mit dem expliziten Aufruf der ID wird diese einmalig erstellt und im Objekt gepseichert.
Diese Methode wird implizit beim Serialisieren aufgerufen.
Die UUID ist dabei vom Type4 (Random)
in Alvine at line 416
string
getShortID(integer $length = null)
Diese Methode entfernt alle Minuszeichen aus der UUID des Hash. Wird eine Länge definiert, so wird nach dem entfernen der Minuszeichen die ersten $length Zeichen zurückgegeben.
Diese Methode ist hilreich um Platz zu sparen.
Je kürzer die ID ist, um so größer ist die Wahrscheinlichkeit einer Kollision.
in Alvine at line 442
boolean
equals(Alvine $object)
Diese Funktion vergleicht zwei Objekte. Dazu wird von beiden der
Wert, der von Alvine::getID()
zurückgeliefert wird ermittelt und das
Ergebnis verglichen. Vererbte Klassen können diese Methode überschreiben.
class MyObject extends Alvine {};
$objA = new MyObject();
$objB = new MyObject();
if($objA->equals($objB)) {
// ...
}
in Alvine at line 463
Alvine
getClone(boolean $deepClone = false)
Diese Methode gibt ein geklontes Objekt von sich selber zurück.
Wenn eine abgeleitete Klasse diese Methode nicht unterstützt, so muss diese die Methode überschreiben und eine CloneNotSupportedException werfen. Die Standardmethode klont eine seichte Kopie der Eigenschaften. Das bedeutet das Objekte in den Eigenschaften nicht geclont werden. Sollen diese auch geclont werden muss true übergeben werden.
Wenn weitere Funktionen implementiert werden sollen, so muss __clone überschrieben werden
in Alvine at line 475
__clone()
Interne Hook für das Clonen des Objektes. Wenn das zu klonende Objekt bereits eine eindeutige ID hat, dann wird auch für das neue Objekt eine eindeutige ID erstellt.
Alvine-Objekte werden rekursive geclont, so das ein vollständiger Clone vorhanden ist.
in Alvine at line 493
string
getClass()
Name der Klasse
class MyObject extends Alvine {};
$obj = new MyObject();
echo $obj->getClass();
in Alvine at line 518
boolean
isInstanceOf(object $object)
Prüft ob das übergebene Objekt eine Instanz dieses Objektes ist. Allerdings ist darauf zu achten, das vorher definiert wurde, das das neue Objekt von Alvine abgeleitet wurde.
if($obj instanceof Alvine &&
$obj->isInstanceOf($object)) { };
Die Prüfung entspricht
$this instanceof $object
at line 91
__construct(string $host = '127.0.0.1', int $port = 25, string $protocol = 'tcp')
Neues SMTPClient Objekt erstellen.
in Socket at line 170
__destruct()
Netzwerkverbindung schliessen
in Client at line 70
Socket
connect()
Netzwerkverbindung öffnen. Ist bereits eine Verbindung aktiv, so wird diese Verbindung geschlossen und eine neue Verbindung geöffnet.
in Socket at line 194
integer
getStateCode()
Gibt den aktuellen Status des Objekts zurück
in Socket at line 206
Socket
attachObserver(Observer $observer)
Fügt einen Beobachter zum Status-Objekt hinzu
in Socket at line 219
Socket
detachObserver(Observer $observer)
Diese Methode entfernt einen Beobachter von der Liste der Status-Beobchter.
in Socket at line 265
Client
dispose()
Netzwerkverbindung beenden
Beendet eine Netzwerkverbindung. Wichtiger Hinweis: Die Funktion schreibt den Verlauf der Kommunikation mit dem Level Trace in den networking-Logger. Dabei ist zu beachten, das eine Weiterleitung der Nachrichten nicht mit Logger-Handlern die dies Klasse verwenden (z.B. MailHandler) funktionieren. Optimalerweise wird ein Dateihandler verwendet.
in Socket at line 295
string
getLog()
Gibt die Logdaten, falls Socket::enableLog() aufgerufen wurde, zurück.
at line 399
protected boolean
isReceivedFinished()
Die Rückgabe muss nach RFC821 immer folgendermaßen definiert sein:
in Socket at line 328
string
receive()
Empfang der Daten
$client = new Alvine\Net\Client('mailserver', 25);
$client->connect();
echo $client->receive();
$client->send("QUIT\r\n");
in Socket at line 372
protected Socket
processReceiveBuffer()
Ermöglicht das überarbeiten der empfangenen Daten, insbesondere bei Clients die ein Long-Polling verwenden.
Wichtig: Diese Funktion wird innerhalb der receive-Queue und vor Socket::isReceivedFinished() aufgerufen. Wird Socket::receiveBuffer bearbeitet, so muss unter Umständen Socket::isReceivedFinished() darauf abgestimmt werden.
in Socket at line 416
protected array
getInternalSocketStatus(Resource $socket)
Gekapselter Funktionsaufruf für socket_get_status
Diese Methode kann in den Unit-Tests für das mocking überschrieben werden.
in Socket at line 439
protected string
getInternalSocketContents(resource $handle, integer $maxlength)
Gekapselter Funktionsaufruf für stream_get_contents
Diese Methode kann in den Unit-Tests für das mocking überschrieben werden.
in Socket at line 494
boolean
isConnected()
Status
Ist der Socket verbunden?
in Socket at line 521
Socket
setConnectionMode(integer $mode)
Modus des Sockets
Setzt den Verbindungsmodus entweder auf Socket::NONBLOCKING (nicht blockierend) oder auf Socket::BLOCKING (blockierend)
in Socket at line 534
string
getProtocol()
Protokoll
in Socket at line 543
string
getHost()
Host
in Socket at line 552
integer
getPort()
Port
in Socket at line 561
string
getPath()
Path
in Socket at line 570
integer
getTimeout()
Timeout
in Socket at line 590
static static
getInstanceFromURI(URI $uri, integer $timeout = null)
Erstellen einer Sockeresourche über eine URI
// Web-Client
new Client('tcp://www.example.com:80/path/to/my/api');
// Unix-Client new Client('unix:///full/path/to/my/socket.sock');
in Client at line 111
void
update(Observeable $observeable)
Ist für diese Klasse ohne Funktion
at line 106
string
getResponse()
Holt das Ergebnis vom Mailserver und prüft auf einen 500 Fehler.
at line 120
boolean
getResponseAndCheckExpected(string $expectedCode, Closure $handler = null)
Prüft das Ergebnis vom Mailserver auf einen bestimmten Code
at line 140
SMTPClient
sendHELO()
Sendet den Befehl HELO
at line 151
SMTPClient
sendEHLO()
Sendet den Befehl EHLO
at line 201
boolean
hasExtension(string $extension)
Prüfen ob der Server die Extension unterstützt
at line 213
string
getExtensionParameter(string $extension, string|null $default = null)
Liefert die Parameter (falls definiert) der Extension zurück
at line 225
SMTPClient
setAuthentication(Authentication $auth)
Anmeldung setzen (der Aufruf muss vor dem Mailversand erfolgen)
at line 237
SMTPClient
sendAuthentication()
Anmeldung senden
at line 281
protected boolean
sendAuthenticationCommands(Authentication $authentication)
Anmeldung durchführen
at line 310
SMTPClient
sendMAILFROM(string|MailAddress $from)
Sendet den Envelope Absender
Wichtig
Wird eine Adresse als Zeichenkette (string) übergeben, so muss die Mailadresse
mit <
und >
eingefasst sein. Siehe dazu RFC 821 & rfc2821
at line 326
SMTPClient
sendSTARTTLS()
Umschalten auf TLS Verbindung
at line 348
SMTPClient
sendRCPTTO(string $to)
Sendet den Envelope Empfänger
Wichtig
Wird eine Adresse als Zeichenkette (string) übergeben, so muss die Mailadresse
mit <
und >
eingefasst sein. Siehe dazu RFC 821 & rfc2821
at line 364
SMTPClient
sendQUIT()
Sendet den Befehl QUIT
at line 379
SMTPClient
sendDATA(type $data)
Sendet den DATA-Befehl und übergibt die Daten. Als letztes wird eine End-of-Data-Sequenz übergebene und damit der Mailversand abgeschlossen.
at line 414
SMTPClient
sendMail(Mail $mail)
Versand einer E-Mail über SMTP. Die Informationen über den oder die Empfänger (inklusive CC und BCC) und der Sender für den Umschlag werden aus der Mail extrahiert. Wenn die Mail nicht richtig angelegt wurde wird einen SMTPExcaption geworfen.
at line 454
MessageClient
sendMessage(Mail $mail)
Message senden
at line 466
SMTPClient
setUserAndCredentials(string $user, string $credential)
Zugangsdaten setzen
at line 493
static object
getInstanceFromProperties(Properties $properties)
Mailclient anhand von Propertie Daten erstellen
host Host port SMTP-PORT authentication.class Klasse der Authentication (mit Namespace) authentication.user Benutzer authentication.cedential Zugangsdaten