abstract class MailPart extends Content

Bestandteil einer E-Mail

Abstrakte Klasse eines Bestandteils einer Mail. Hiervon abgeleitet werden die einzelnen Typen einer Mail, z.B. Text, HTML, Image, etc.

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.

DEFAULT_KEY

Text-Schlüssel

TEXT

Type Text

TEXT_KEY

Text-Schlüssel

IMAGE

Bilder

IMAGE_KEY

Bild-Schlüssel

VIDEO

Videoas

VIDEO_KEY

Video-Schlüssel

AUDIO

Audios

AUDIO_KEY

Audio-Schlüssel

APPLICATION

Allgemeine Binärdaten

APPLICATION_KEY

Anwendungsdaten

MESSAGE

Mailnachricht

MESSAGE_KEY

Messages

MODEL

3D Modell

MODEL_KEY

4D Modell

OTHER

Sonstiges

OTHER_KEY

Sonstiges

MULTIPART

Verschachtelte Typen

MULTIPART_KEY

Multipart-Schlüssel

ORIGINAL

Ohne Encoding

BASE64

Codierung als BASE64

BIT8

Codierung als 8bit

BINARY

Codierung in Binary

GZIP

Codierung erfolgt als GZIP (256 + 1)

QUOTEDPRINTABLE

Quoted Printable

Properties

protected boolean $hasAssociatedProperties from SerializableImplementation
protected boolean $hasVolatileProperties from SerializableImplementation
protected array $properties from Alvine
protected string $hash Eindeutige ID from Alvine
static protected int $typeMap from MIMEType
protected int $type from MIMEType
protected string $subtype from MIMEType
protected string $content from Content
protected integer $encoding from Content

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

Inhalt als Zeichenkette

from Content
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(integer|string $type, string $subtype, integer $encoding = null)

Erstellt in abgeleiteten Klassen einen neuen Bestandteil.

array
getTypeMap()

Typ-Map

from MIMEType
string
getType()

Gibt den Haupttyp zurück (z.B. images)

from MIMEType
string
getSubType()

Gibt den Untertyp zurück (z.B. gif)

from MIMEType
string
getMimeType()

Gibt en MimeType als String zurück (z.B. image/gif)

from MIMEType
string
getContentType()

Inhaltstyp

from Content
static MIMEType
getDefaultMimeType(string|null $type = null)

Standard-Typ

from MIMEType
static Content
getInstance(string $content, MIMEType $mimetype)

Neue Instanz erstellen

from Part
setEncoding(integer $encoding)

Kodierung setzen

from Content
integer
getEncoding()

Kodierung

from Content
string
getEncodedContent()

Kodierter Inhalt

from Content
initDefinition(array $body, array $parameter = array())

Quelltext der Mail erstellen

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 Content at line 162
string __toString()

Inhalt als Zeichenkette

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 59
__construct(integer|string $type, string $subtype, integer $encoding = null)

Erstellt in abgeleiteten Klassen einen neuen Bestandteil.

Parameters

integer|string $type Typ (KEY oder ID)
string $subtype Untertyp des Teils
integer $encoding Ausgabe-Kodierung (Base64, QuotedPrintable oder Binary)

in MIMEType at line 220
array getTypeMap()

Typ-Map

Return Value

array

in MIMEType at line 238
string getType()

Gibt den Haupttyp zurück (z.B. images)

Return Value

string Haupttyp

in MIMEType at line 247
string getSubType()

Gibt den Untertyp zurück (z.B. gif)

Return Value

string Untertyp

in MIMEType at line 256
string getMimeType()

Gibt en MimeType als String zurück (z.B. image/gif)

Return Value

string MimeType-String

in Content at line 173
string getContentType()

Inhaltstyp

Spezialisierte Zeichenkette mit Parametern

Return Value

string Zeichenkette

in MIMEType at line 297
static MIMEType getDefaultMimeType(string|null $type = null)

Standard-Typ

Diese Methode definiert für jeden Haupttypen und für die Übergabe von null einen wie folgt definierten Typen:

AUDIO audio/mpeg APPLICATION application/octet-stream IMAGE image\png MESSAGE message\rfc822 MODEL model\vrml OTHER other\x-unknown TEXT text/plain VIDEO video/mpeg

Parameters

string|null $type Der gewünschte Haupttyp

Return Value

MIMEType Neues MIMETypeObjekt

in Part at line 48
static Content getInstance(string $content, MIMEType $mimetype)

Neue Instanz erstellen

Neue Instanz anhand eines MIMETypes erstellen

Parameters

string $content Inhalt
MIMEType $mimetype MIMEType

Return Value

Content Ein spezialisiertes Content-Objekt in Abhängigkeit des MIMETypes

Exceptions

UnsupportedMIMETypeException

in Content at line 118
Content setEncoding(integer $encoding)

Kodierung setzen

Setzt die Kodierung (Base64, quotedprintable oder gzip). Wird gzip verwedent, so kommt als Kommpressionsfaktor 9 zum Einsatz.

Parameters

integer $encoding Codierung

Return Value

Content Dieses Objekt

in Content at line 130
integer getEncoding()

Kodierung

Holt die Codierung (Base64 oder quotedprintable)

Return Value

integer Kodierung

in Content at line 145
protected string getEncodedContent()

Kodierter Inhalt

Der Inhalt wird mittels dem in $this->encoding definierten Verfahren codiert. Wird gzip verwedent, so kommt als Kommpressionsfaktor 9 zum Einsatz.

Return Value

string Kodierter Inhalt

See also

$this->encoding Encoding

at line 86
MailPart initDefinition(array $body, array $parameter = array())

Quelltext der Mail erstellen

Zentrale Funktion zum Bauen eines Quelltextes. Die abgeleiteten Klassen können diese Funktion überschreiben oder implizit aufrufen. Als Ergebnis wird ein Array mit den Bestandteilen des Inhalts zurückgegeben. Beim Erstellen des Bodys können über den Parameter $parameter explizite Schlüssel/Werte an den Body übergeben werden.

$body = array();
$content->initDefinition($body, array('x-version'=>'1425'));
// Body hat dann folgende Struktur
// $body[0]['x-version']='1425';

Parameters

array $body &$body Referenz auf eine Body-Liste
array $parameter Parameter

Return Value

MailPart Dieses Objekt