Documentation

Mail extends Alvine
in package

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

Framework

author

schukai GmbH [email protected]

license

http://alvine.io/license/ Licence

link

Alvine

since
20110904

Table of Contents

Constants

APIVERSION  = 1
Version der API-Version der Klasse.
IDENTIFICATION  = 'Alvine'
Identifizierung der Alvine API
SERIALVERSION  = 1
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.
VERSION  = 2
Generelle Alvine-Version

Properties

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

Methods

__call()  : mixed
Ein Closures das dem Objekt übergeben wurde, kann entweder als Property oder als Funktion aufgerufen werden.
__clone()  : mixed
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.
__construct()  : mixed
Erstellt eine neue E-Mail.
__get()  : mixed
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.
__isset()  : boolean
Wird aufgerufen, wenn isset() auf ein internes Property angewendet wird.
__serialize()  : array<string|int, mixed>
Serialization of the object and data. In the serialized object also stores meta-information for matching.
__set()  : void
Jede von der Alvine-Klasse abgeleitete Klasse besitzt die Fähigkeit beliebige Werte und Lambda-Funktionen an das Objekt zu hängen.
__toString()  : string
Standardumwandlung des Inhalts der Klasse in eine Zeichenkette
__unserialize()  : void
__unset()  : mixed
Zurücksetzen von Werten
addAlternativeParts()  : Mail
Bequemlichkeitsfunktion um eine Mail mit einem alternativen Mailinhalt zu erstellen. Als Parameter können entweder MailPart Objekte oder ein String übergeben werden.
addBcc()  : Mail
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.
addCc()  : Mail
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.
addPart()  : Mail
Fügt einen neuen Inhalt zur Mail hinzu.
addReplyTo()  : Mail
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.
addTo()  : Mail
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.
equals()  : boolean
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.
getClass()  : string
Name der Klasse
getClone()  : Alvine
Diese Methode gibt ein geklontes Objekt von sich selber zurück.
getClosure()  : Closure
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.
getFrom()  : MailAddress
Gibt ein Mail-Address-Objekt zurück.
getHashCode()  : string
Die Methode Alvine::getID() verwenden!
getID()  : string
Diese Methode gibt eine eindeutige ID des Objektes zurück. Bei der ID handelt es sich um eine Zeichenkette in der Form einer UUID.
getRecipients()  : array
Gibt ein Array mit allen Empfänger, egal ob To, CC oder BCC zurück.
getShortID()  : string
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.
getSource()  : string
Diese Funktion erstellt den Quelltext der E-Mail.
getSubject()  : string|null
Betreff der Mail
hasAssociatedProperties()  : boolean
Check if the object has associative properties
hasVolatileProperties()  : boolean
Prüfen ob das Objekt volatile Eigenschaften besitzt
isCallable()  : bool
Mit dieser Methode kann geprüft werden, ob eine Methode aufrufbar ist. Das gilt für echte und eingehängte DI-Methoden (Lambda).
isInstanceOf()  : boolean
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.
propertyExists()  : boolean
Prüfen ob eine Eigenschaft als dynamische Eigenschaft verfügbar ist, die über $obj->property abgefragt werden kann.
send()  : Mail
Bequemlichkeitsfunktion zum senden der Mail. Es wird ein Standard SMTP-Server aufgerufen und die Mail an diesen übergeben. Der Versand erfolgt sofort.
setDate()  : Mail
Setzt das Datum explizit.
setFrom()  : Mail
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.
setSubject()  : Mail
Setzt den Betreff der Mail
addRecipient()  : Mail
Interne Methode um einen Empfänger hinzuzufügen. Diese Methode ruft sich selber auf, wenn das Argument ein Array ist, rekursion!
checkAndAdjustSerialisation()  : array<string|int, mixed>
Dealing with versions
encodeSubject()  : string
Wandelt den Betreff einer Mail in einen mailkonformen String um.

Constants

APIVERSION

Version der API-Version der Klasse.

public mixed APIVERSION = 1

IDENTIFICATION

Identifizierung der Alvine API

public mixed IDENTIFICATION = 'Alvine'

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.

public mixed SERIALVERSION = 1

https://php.watch/versions/8.1/serializable-deprecated

VERSION

Generelle Alvine-Version

public mixed VERSION = 2

Properties

$bcc

protected array $bcc = []

Liste mit den BCC Empfängern (MailAdress-Objekte)

$cc

protected array $cc = []

Liste mit den CC-Empfängern (MailAdress-Objekte)

$date

protected string $date = null

Datum der Mail

$from

protected MailAdress $from = null

Absender

$hash

Eindeutige ID

protected string $hash = null

Die ID wird erst über die Methode \Alvine\Core\Alvine::getID() bei Bedarf ermittelt, deshalb müssen auch abgeleitete Klassen nicht direkt auf den Wert zugreifen, sondern den Wert über getID() holen.

Hash-Wert des Objekts (UUID)

$headers

protected array $headers = []

Liste mit den Headern

$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 $inReplyTo = null

Message-ID der Ausgangsmail

$messageId

protected string $messageId = null

Eindeutige ID einer Mail

$parts

protected array $parts = []

Bestandteile der Mail

$properties

protected array $properties = []

Liste mit dynamischen Eigenschaften die über __get und __set bearbeitet werden können.

$subject

protected string $subject = null

Betreff der Mail

$to

protected array $to = []

Liste mit den Empfängern (MailAdress-Objekte)

Methods

__call()

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

public __call(string $name, array $arguments) : mixed

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
$name : string

Funktionsname

$arguments : array

Argumente

Tags
throws
NotCallableException

Exception

Return values
mixed

Ergebnis des Callbacks

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

public __clone() : mixed

Alvine-Objekte werden rekursive geclont, so das ein vollständiger Clone vorhanden ist.

__construct()

Erstellt eine neue E-Mail.

public __construct([MailAddress $to = null ][, MailAddress $from = null ][, string $subject = null ][, string|MailPart $body = null ]) : mixed
Parameters
$to : MailAddress = null

Empfänger

$from : MailAddress = null

Absender

$subject : string = null

Betreff der Mail

$body : string|MailPart = null

Inhalt der Mail (entweder ein String oder ein MailPart-Objekt). Bei einem String wird ein MailPartText-Objekt erstellt).

__get()

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.

public __get(string $name) : mixed

Vor der Abfrage sollte, damit keine Exception geworfen wird, die Existenz der Eigenschaft geprüft werden.

if($obj->propertyExists('myproperty')) {
  $value = $obj->myproperty;
}
Parameters
$name : string

Name der Eigenschaft

Tags
throws
BadPropertyException
Return values
mixed

Wert der Eigenschaft

__isset()

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

public __isset(string $name) : boolean
Parameters
$name : string
Return values
boolean

__serialize()

Serialization of the object and data. In the serialized object also stores meta-information for matching.

public __serialize() : array<string|int, mixed>

If a derived class is not to be serializable, then this * method must be overridden and throw an exception. this method must be overridden and throw an exception.

Properties starting with volatile or associated. are handled separately. Properties with prefix volatile are not serialized. For properties with the prefix associated, only the * ID of the object is serialized. ID of the object is serialized. If no object is stored in the property is stored in the property, a TypeException is thrown.

Tags
see
https://php.watch/versions/8.1/serializable-deprecated
Return values
array<string|int, mixed>

__set()

Jede von der Alvine-Klasse abgeleitete Klasse besitzt die Fähigkeit beliebige Werte und Lambda-Funktionen an das Objekt zu hängen.

public __set(string $name, mixed $value) : void

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
$name : string

Name der Eigenschaft

$value : mixed

Wert der Eigenschaft

Return values
void

__toString()

Standardumwandlung des Inhalts der Klasse in eine Zeichenkette

public __toString() : string
echo (string) new MyObect();
Return values
string

Daten des Objekts

__unset()

Zurücksetzen von Werten

public __unset(string $name) : mixed
Parameters
$name : string

addAlternativeParts()

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

public addAlternativeParts(string|MailPart $html, string|MailPart $text[, string $type = MailPartMultipart::ALTERNATIVE ]) : Mail

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
$html : string|MailPart

HTML-Bestandteil

$text : string|MailPart

Text-Bestandteil

$type : string = MailPartMultipart::ALTERNATIVE

Typ

Return values
Mail

Dieses Objekt

addBcc()

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.

public addBcc(array|string|MailAddress $address) : Mail
Parameters
$address : array|string|MailAddress

Empfänger

Return values
Mail

Dieses Objekt

addCc()

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.

public addCc(array|string|MailAddress $address) : Mail
Parameters
$address : array|string|MailAddress

Empfänger

Return values
Mail

Dieses Objekt

addPart()

Fügt einen neuen Inhalt zur Mail hinzu.

public addPart(MailPart $part) : Mail
Parameters
$part : MailPart

Inhalt zur Mail hinzufügen

Return values
Mail

Dieses Objekt

addReplyTo()

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.

public addReplyTo(string|MailAddress $address) : Mail
Parameters
$address : string|MailAddress

Empfänger

Return values
Mail

Dieses Objekt

addTo()

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.

public addTo(array|string|MailAddress $address) : Mail
Parameters
$address : array|string|MailAddress

Empfänger

Return values
Mail

Dieses Objekt

equals()

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.

public equals(Alvine $object) : boolean
class MyObject extends Alvine };

$objA = new MyObject();
$objB = new MyObject();

if($objA->equals($objB)) {
  // ...
}
Parameters
$object : Alvine

Objekt das überprüft werden soll

Return values
boolean

true wenn beide Objekte identisch sind.

getClass()

Name der Klasse

public getClass() : string
class MyObject extends Alvine };
$obj = new MyObject();

echo $obj->getClass();
Tags
see
ClassType::getNormalizedName
Return values
string

Klassenname

getClone()

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

public getClone([boolean $deepClone = false ]) : Alvine

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
$deepClone : boolean = false

Clone aller enthaltenen Objekte

Tags
see
Alvine::__clone()
Return values
Alvine

getClosure()

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.

public getClosure(string $name) : Closure
Parameters
$name : string

Name des Closure

Tags
throws
NotFoundException
throws
BadPropertyException
Return values
Closure

getHashCode()

Die Methode Alvine::getID() verwenden!

public getHashCode() : string
Tags
deprecated
20140611
Return values
string

Hashwert des Objektes

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.

public getID() : string

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 values
string

UUID des Objektes

getRecipients()

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

public getRecipients() : array

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

Return values
array

Array mit allen Empfängern

getShortID()

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.

public getShortID([int|null $length = null ]) : string

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
$length : int|null = null
Return values
string

getSource()

Diese Funktion erstellt den Quelltext der E-Mail.

public getSource() : string
Tags
see
SMTPClient
Return values
string

Mail-Quelltext

getSubject()

Betreff der Mail

public getSubject() : string|null
Return values
string|null

isCallable()

Mit dieser Methode kann geprüft werden, ob eine Methode aufrufbar ist. Das gilt für echte und eingehängte DI-Methoden (Lambda).

public isCallable(string $name) : bool
if($obj->isCallable('myfunction')) {
  $obj->myfunction();
}
Parameters
$name : string

Name der Methode

Return values
bool

Ergebnis

isInstanceOf()

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.

public isInstanceOf(object $object) : boolean
if($obj instanceof Alvine &&
   $obj->isInstanceOf($object)) { };

Die Prüfung entspricht

$this instanceof $object
Parameters
$object : object
Return values
boolean

propertyExists()

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

public propertyExists(string $name) : boolean
if($obj->propertyExists('myproperty')) {
  $value = $obj->myproperty;
}
Parameters
$name : string

Name der Eigenschaft

Return values
boolean

send()

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

public send([string $host = '127.0.0.1' ][, int $port = 25 ][, string|null $clientHostname = null ]) : Mail
$mail = new \Alvine\Net\Mail\Mail();
$mail->addTo('[email protected]')
     ->setFrom('[email protected]')
     ->setSubject('Testmail')
     ->addAlternativeParts('<html>', 'plain')
     ->send();
Parameters
$host : string = '127.0.0.1'
$port : int = 25
$clientHostname : string|null = null
Tags
throws
Exception
Return values
Mail

setDate()

Setzt das Datum explizit.

public setDate(DateTime $date) : Mail

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

Parameters
$date : DateTime
Return values
Mail

setFrom()

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.

public setFrom(MailAddress $address) : Mail

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
$address : MailAddress
Tags
throws
TypeException
Return values
Mail

setSubject()

Setzt den Betreff der Mail

public setSubject(string $subject) : Mail
Parameters
$subject : string
Return values
Mail

Dieses Objekt

addRecipient()

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

protected addRecipient(string $key, array|string|MailAddress $address) : Mail
Parameters
$key : string
$address : array|string|MailAddress
Tags
throws
TypeException
Return values
Mail

checkAndAdjustSerialisation()

Dealing with versions

protected checkAndAdjustSerialisation(array $serialization) : array<string|int, mixed>

This method checks an object and ideally repairs older copies. If an old copy cannot be restored be restored, an exception is thrown.

This method must be overridden by the derived classes. be overridden. In the derived class, * the parent method should be called. the parent method should be called.

Parameters
$serialization : array

Daten des serialisiertes Objekts

Tags
throws
UnserializeException

Keine Übereinstimmung

Return values
array<string|int, mixed>

encodeSubject()

Wandelt den Betreff einer Mail in einen mailkonformen String um.

protected static encodeSubject(string $subject) : string
Parameters
$subject : string
Return values
string

codierter Betreff


        
On this page

Search results