class Mail extends Alvine

Klasse die eine E-Mail abbildet und alle Bestandteile einer Mail sammelt und z.B. dem SMTP-Client übergibt. Die Klasse Mail besitzt einige Bequemlichkeitsfunktionen die den einfachen Versand einer Mail zulassen.

$mail = new \Alvine\Net\Mail\Mail(); // Neue Mail erstellen
// Mailparameter übergeben und mit dem Standard SMTP-Client versenden
$mail->addTo('[email protected]')
     ->setFrom('[email protected]')
     ->setSubject('Testmail')
     ->addAlternativeParts('<html>', 'plain')
     ->send();

Traits

SerializableImplementation

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.

Properties

protected boolean $hasAssociatedProperties from SerializableImplementation
protected boolean $hasVolatileProperties from SerializableImplementation
protected array $properties from Alvine
protected string $hash Eindeutige ID from Alvine
protected array $parts
protected array $to
protected array $cc
protected array $bcc
protected MailAdress $from
protected string $subject
protected type $returnPath
protected array $replyTo
protected string $inReplyTo Wenn eine Mail weitergeleitet oder beantwortet wird, steht in diesem Feld die Message-ID der Ursprungsmail. Dadurch kann man z.B. einen Thread aufbauen.
protected string $messageId
protected string $date
protected array $headers

Methods

string
serialize()

Serialisierung des Objekts und der Daten. In dem serialisierten Objekt werden auch Meta-Informationen zum Abgleich gespeichert.

bool
hasAssociatedProperties()

Prüfen ob das Objekt associative Eigenschaften besitzt

bool
hasVolatileProperties()

Prüfen ob das Objekt volatile Eigenschaften besitzt

checkAndAdjustSerialisation(array $serialization)

Umgang mit Versionen

void
unserialize(string $serialized)

Diese Methode wird in der Folge durch \unserialize aufgerufen und initialisert das neue Objekt. Diese Methode sollte so nicht selber aufgerufen werden.

string
__toString()

Standardumwandlung des Inhalts der Klasse in eine Zeichenkette

from Alvine
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.

from Alvine
boolean
__isset(string $name)

Wird aufgerufen, wenn isset() auf ein internes Property angewendet wird.

from Alvine
__unset(string $name)

Zurücksetzen von Werten

from Alvine
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.

from Alvine
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.

from Alvine
boolean
propertyExists(string $name)

Prüfen ob eine Eigenschaft als dynamische Eigenschaft verfügbar ist, die über $obj->property abgefragt werden kann.

from Alvine
mixed
__call(string $name, array $arguments)

Ein Closures das dem Objekt übergeben wurde, kann entweder als Property oder als Funktion aufgerufen werden.

from Alvine
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).

from Alvine
string
getHashCode() deprecated

Die Methode Alvine::getID() verwenden!

from Alvine
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.

from Alvine
string
getShortID(int|null $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.

from Alvine
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.

from Alvine
Alvine
getClone(boolean $deepClone = false)

Diese Methode gibt ein geklontes Objekt von sich selber zurück.

from Alvine
__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.

from Alvine
string
getClass()

Name der Klasse

from Alvine
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.

from Alvine
__construct(MailAddress $to = null, MailAddress $from = null, string $subject = null, string|MailPart $body = null)

Erstellt eine neue E-Mail.

setDate(DateTime $date)

Setzt das Datum explizit.

addPart(MailPart $part)

Fügt einen neuen Inhalt zur Mail hinzu.

addAlternativeParts(string|MailPart $html, string|MailPart $text, string $type = MailPartMultipart::ALTERNATIVE)

Bequemlichkeitsfunktion um eine Mail mit einem alternativen Mailinhalt zu erstellen. Als Parameter können entweder MailPart Objekte oder ein String übergeben werden.

MailAddress|null
getFrom()

Gibt ein Mail-Address-Objekt zurück.

array
getRecipients()

Gibt ein Array mit allen Empfänger, egal ob To, CC oder BCC zurück.

addRecipient(string $key, array|string|MailAddress $address)

Interne Methode um einen Empfänger hinzuzufügen. Diese Methode ruft sich selber auf, wenn das Argument ein Array ist, rekursion!

addTo(array|string|MailAddress $address)

Fügt neuen Empfänger (to) hinzu. Es kann entweder ein MailAddressObjekt, ein Array von MailAdressObjekten oder ein String übergeben werden. In einem String können mehrere E-Mail-Adresse per Komma getrennt werden.

addCc(array|string|MailAddress $address)

Fügt neuen Empfänger (cc) hinzu. Es kann entweder ein MailAddressObjekt, ein Array von MailAdressObjekten oder ein String übergeben werden. In einem String können mehrere E-Mail-Adresse per Komma getrennt werden.

setFrom(MailAddress $address)

Setzt den Absender (from) der Mail. Es kann entweder ein MailAddressObjekt oder ein String übergeben werden. In einem String können mehrere E-Mail-Adresse per Komma getrennt werden.

addReplyTo(string|MailAddress $address)

Setzt den Rücksendeadresse (replyTo) der Mail. Es kann entweder ein MailAddressObjekt oder ein String übergeben werden. In einem String können mehrere E-Mail-Adresse per Komma getrennt werden.

addBcc(array|string|MailAddress $address)

Fügt neuen Empfänger (bcc) hinzu. Es kann entweder ein MailAddressObjekt, ein Array von MailAdressObjekten oder ein String übergeben werden. In einem String können mehrere E-Mail-Adresse per Komma getrennt werden.

setSubject(string $subject)

Setzt den Betreff der Mail

static string
encodeSubject(string $subject)

Wandelt den Betreff einer Mail in einen mailkonformen String um.

string
getSource()

Diese Funktion erstellt den Quelltext der E-Mail.

send(string $host = '127.0.0.1', int $port = 25, string|null $clientHostname = null)

Bequemlichkeitsfunktion zum senden der Mail. Es wird ein Standard SMTP-Server aufgerufen und die Mail an diesen übergeben. Der Versand erfolgt sofort.

Details

string serialize()

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.

Return Value

string String-Repräsentation des Objektes

bool hasAssociatedProperties()

Prüfen ob das Objekt associative Eigenschaften besitzt

Return Value

bool

bool hasVolatileProperties()

Prüfen ob das Objekt volatile Eigenschaften besitzt

Return Value

bool

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.

Parameters

array $serialization Daten des serialisiertes Objekts

Exceptions

UnserializeException Keine Übereinstimmung

void unserialize(string $serialized)

Diese Methode wird in der Folge durch \unserialize aufgerufen und initialisert das neue Objekt. Diese Methode sollte so nicht selber aufgerufen werden.

Parameters

string $serialized

Return Value

void

in Alvine at line 177
string __toString()

Standardumwandlung des Inhalts der Klasse in eine Zeichenkette

echo (string) new MyObect();

Return Value

string Daten des Objekts

in Alvine at line 211
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;

Parameters

string $name Name der Eigenschaft
mixed $value Wert der Eigenschaft

Return Value

void

in Alvine at line 222
boolean __isset(string $name)

Wird aufgerufen, wenn isset() auf ein internes Property angewendet wird.

Parameters

string $name

Return Value

boolean

in Alvine at line 231
__unset(string $name)

Zurücksetzen von Werten

Parameters

string $name

in Alvine at line 256
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;
}

Parameters

string $name Name der Eigenschaft

Return Value

mixed Wert der Eigenschaft

Exceptions

BadPropertyException

in Alvine at line 281
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.

Parameters

string $name Name des Closure

Return Value

Closure

Exceptions

NotFoundException
BadPropertyException

in Alvine at line 307
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;
}

Parameters

string $name Name der Eigenschaft

Return Value

boolean

in Alvine at line 339
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!

Parameters

string $name Funktionsname
array $arguments Argumente

Return Value

mixed Ergebnis des Callbacks

Exceptions

NotCallableException Exception

in Alvine at line 362
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();
}

Parameters

type $name Name der Methode

Return Value

boolean Ergebnis

in Alvine at line 376
string getHashCode() deprecated

deprecated 20140611

Die Methode Alvine::getID() verwenden!

Return Value

string Hashwert des Objektes

in Alvine at line 396
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)

Return Value

string UUID des Objektes

in Alvine at line 416
string getShortID(int|null $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 hilfreich um Platz zu sparen.

Je kürzer die ID ist, um so größer ist die Wahrscheinlichkeit einer Kollision mit anderen Hash vergleichbarer Objekte.

Parameters

int|null $length

Return Value

string

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)) {
  // ...
}

Parameters

Alvine $object Objekt das überprüft werden soll

Return Value

boolean true wenn beide Objekte identisch sind.

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

Parameters

boolean $deepClone Clone aller enthaltenen Objekte

Return Value

Alvine

See also

Alvine::__clone

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();

Return Value

string Klassenname

See also

ClassType::getNormalizedName

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

Parameters

object $object

Return Value

boolean

at line 132
__construct(MailAddress $to = null, MailAddress $from = null, string $subject = null, string|MailPart $body = null)

Erstellt eine neue E-Mail.

Parameters

MailAddress $to Empfänger
MailAddress $from Absender
string $subject Betreff der Mail
string|MailPart $body Inhalt der Mail (entweder ein String oder ein MailPart-Objekt). Bei einem String wird ein MailPartText-Objekt erstellt).

at line 167
Mail setDate(DateTime $date)

Setzt das Datum explizit.

Das aktuelle Datum wird beim erstellen gesetzt. Mit dieser Methode kann es überschrieben werden.

Parameters

DateTime $date

Return Value

Mail

at line 179
Mail addPart(MailPart $part)

Fügt einen neuen Inhalt zur Mail hinzu.

Parameters

MailPart $part Inhalt zur Mail hinzufügen

Return Value

Mail Dieses Objekt

at line 203
Mail addAlternativeParts(string|MailPart $html, string|MailPart $text, string $type = MailPartMultipart::ALTERNATIVE)

Bequemlichkeitsfunktion um eine Mail mit einem alternativen Mailinhalt zu erstellen. Als Parameter können entweder MailPart Objekte oder ein String übergeben werden.

Je nach Typ werden die Inhalte entweder alternativ (ALTERNATIVE), oder gleichzeitig (MIXED) im Mailprogramm angezeigt. Die genaue Darstellung hängt jedch vom Mailprogramm ab.

$mail = new \Alvine\Net\Mail\Mail('[email protected]','[email protected]','Testmail');
$mail->addAlternativeParts('<html><body>HTML-Teil</body></html>,'Text-Teil');

Parameters

string|MailPart $html HTML-Bestandteil
string|MailPart $text Text-Bestandteil
string $type Typ

Return Value

Mail Dieses Objekt

at line 218
MailAddress|null getFrom()

Gibt ein Mail-Address-Objekt zurück.

Return Value

MailAddress|null

at line 229
array getRecipients()

Gibt ein Array mit allen Empfänger, egal ob To, CC oder BCC zurück.

Anhand der Empfänger lässt sich nicht erkennen, in welchem Feld die E-Mail-Adresse steht.

Return Value

array Array mit allen Empfängern

at line 253
protected Mail addRecipient(string $key, array|string|MailAddress $address)

Interne Methode um einen Empfänger hinzuzufügen. Diese Methode ruft sich selber auf, wenn das Argument ein Array ist, rekursion!

Parameters

string $key
array|string|MailAddress $address

Return Value

Mail

Exceptions

TypeException

at line 280
Mail addTo(array|string|MailAddress $address)

Fügt neuen Empfänger (to) hinzu. Es kann entweder ein MailAddressObjekt, ein Array von MailAdressObjekten oder ein String übergeben werden. In einem String können mehrere E-Mail-Adresse per Komma getrennt werden.

Parameters

array|string|MailAddress $address Empfänger

Return Value

Mail Dieses Objekt

at line 295
Mail addCc(array|string|MailAddress $address)

Fügt neuen Empfänger (cc) hinzu. Es kann entweder ein MailAddressObjekt, ein Array von MailAdressObjekten oder ein String übergeben werden. In einem String können mehrere E-Mail-Adresse per Komma getrennt werden.

Parameters

array|string|MailAddress $address Empfänger

Return Value

Mail Dieses Objekt

at line 315
Mail setFrom(MailAddress $address)

Setzt den Absender (from) der Mail. Es kann entweder ein MailAddressObjekt oder ein String übergeben werden. In einem String können mehrere E-Mail-Adresse per Komma getrennt werden.

Dann wird allerdings nur die erste E-Mail-Adresse verwendet

Falls kein ReplyTo gesetzt wurde, so setzt diese Funktion die Adresse auch als ReplyTo-Adresse.

Parameters

MailAddress $address

Return Value

Mail

Exceptions

TypeException

at line 338
Mail addReplyTo(string|MailAddress $address)

Setzt den Rücksendeadresse (replyTo) der Mail. Es kann entweder ein MailAddressObjekt oder ein String übergeben werden. In einem String können mehrere E-Mail-Adresse per Komma getrennt werden.

Parameters

string|MailAddress $address Empfänger

Return Value

Mail Dieses Objekt

at line 360
Mail addBcc(array|string|MailAddress $address)

Fügt neuen Empfänger (bcc) hinzu. Es kann entweder ein MailAddressObjekt, ein Array von MailAdressObjekten oder ein String übergeben werden. In einem String können mehrere E-Mail-Adresse per Komma getrennt werden.

Parameters

array|string|MailAddress $address Empfänger

Return Value

Mail Dieses Objekt

at line 372
Mail setSubject(string $subject)

Setzt den Betreff der Mail

Parameters

string $subject

Return Value

Mail Dieses Objekt

at line 384
static protected string encodeSubject(string $subject)

Wandelt den Betreff einer Mail in einen mailkonformen String um.

Parameters

string $subject

Return Value

string codierter Betreff

at line 395
string getSource()

Diese Funktion erstellt den Quelltext der E-Mail.

Return Value

string Mail-Quelltext

See also

SMTPClient

at line 446
Mail send(string $host = '127.0.0.1', int $port = 25, string|null $clientHostname = null)

Bequemlichkeitsfunktion zum senden der Mail. Es wird ein Standard SMTP-Server aufgerufen und die Mail an diesen übergeben. Der Versand erfolgt sofort.

$mail = new \Alvine\Net\Mail\Mail();
$mail->addTo('[email protected]')
     ->setFrom('[email protected]')
     ->setSubject('Testmail')
     ->addAlternativeParts('<html>', 'plain')
     ->send();

Parameters

string $host
int $port
string|null $clientHostname

Return Value

Mail

Exceptions

Exception