Mailings

OMC_Mailing

Die Klasse OMC_Mailing repräsentiert im OMC Connector (PHP) die im Online Marketing Cockpit gespeicherten Mailings. Die Instanzmethoden dieser Klasse finden Sie weiter unten in diesem Dokument.

Klassenmethoden

`OMC_Mailing __construct([array $fields = array()])`
Aufgabe: Erstellt eine neue lokale Instanz eines Mailings. Zugriff: `$neues_mailing = new OMC_Mailing();` Rückgabewert: Die Instanz des Mailings. Exceptions: –

`OMC_MailingBounce bounce(string $code, [string $info=""])`
Aufgabe: Meldet dem OMC, dass es sich bei dieser E-Mail um einen Rückläufer handelt. Rückgabewert: Die Instanz des Rückläufers Exceptions: `OMC_UnauthorizedAccessException`, `OMC_ResourceNotFoundException`

`OMC_Mailing create([array $properties = array()])`
Aufgabe: Erstellt im OMC ein neues Mailing mit den angegebenen Feldern. Rückgabewert: Die Instanz des Mailings. Exceptions: `OMC_UnauthorizedAccessException`, `OMC_ResourceInvalidException`

`OMC_MailingDecode decode(string $code)`
Aufgabe: Dekodiert einen (beispielsweise aus einem Rückläufer stammenden) Mailing-`$code`. Rückgabewert: Die Instanz des MailingDecodes. Exceptions: `OMC_UnauthorizedAccessException`, `OMC_ResourceNotFoundException`, `OMC_ResourceInvalidException`

`OMC_Mailing find(integer $scope, [array $params = array()])`
Aufgabe: Findet ein Mailing anhand der gegebenen ID (`$scope`) im OMC. Rückgabewert: Die Instanz des Mailings. Exceptions: `OMC_UnauthorizedAccessException`, `OMC_ResourceNotFoundException`

`OMC_MailingUnsubscribe unsubscribe(string $code)`
Aufgabe: Bestellt ein Mailing für die in `$code` kodierte Person ab. Rückgabewert: Die Instanz des `MailingUnsubscribe`. Exceptions: `OMC_UnauthorizedAccessException`, `OMC_ResourceNotFoundException`, `OMC_ResourceInvalidException`

Instanzmethoden

`boolean close()`
Aufgabe: Schließt dieses Mailing im OMC. Rückgabewert: Meldet, ob das Schließen erfolgreich war. Exceptions: `OMC_UnauthorizedAccessException`

`array getFields()`
Aufgabe: Listet alle nicht leeren Felder dieser Person auf. Rückgabewert: Ein Array mit Name/Wert-Paaren verschiedenen Typs (String, Integer, Boolean usw.) Exceptions: –

`boolean isNewRecord()`
Aufgabe: Überprüft, ob diese Person bereits im OMC existiert. Rückgabewert: `true`, wenn es sich um eine bisher noch nicht gespeicherte Kontaktperson handelt. Exceptions: –

`boolean release()`
Aufgabe: Gibt dieses Mailing im OMC frei. Rückgabewert: Meldet, ob das Freigeben erfolgreich war. Exceptions: `OMC_UnauthorizedAccessException`

`boolean reopen()`
Aufgabe: Öffnet dieses Mailing im OMC erneut. Rückgabewert: Meldet, ob das erneute Öffnen erfolgreich war. Exceptions: `OMC_UnauthorizedAccessException`

`boolean save()`
Aufgabe: Speichert die lokalen Änderungen dieses Mailing im OMC, oder erstellt ein neues Mailing, falls es noch nicht existiert. Rückgabewert: Meldet, ob das Speichern erfolgreich war. Exceptions: `OMC_UnauthorizedAccessException`, `OMC_ResourceInvalidException`

`boolean updateAttributes(array $attributes)`
Aufgabe: Ändert die Felder dieses Mailings und speichert sie im OMC. Rückgabewert: Meldet, ob die Änderungen erfolgreich waren. Exceptions: `OMC_UnauthorizedAccessException`, `OMC_ResourceInvalidException`

`void updateFields(array $fields)`
Aufgabe: Überschreibt die angegebenen Felder aus `$fields` des Mailings lokal. Felder, die dieses Mailing hat, die jedoch nicht in `$fields` angegeben sind, werden nicht gelöscht oder überschrieben. Rückgabewert: – Exceptions: –

OMC_MailingBounce, OMC_MailingDecode, OMC_MailingUnsubscribe

Die Klassen OMC_MailingBounce, OMC_MailingDecode und OMC_MailingUnsubscribe repräsentieren im OMC Connector (PHP) die Antworten des Online Marketing Cockpits auf den Aufruf von bounce, decode und unsubscribe. Mit Hilfe der zurückgegebenen Instanzen dieser Klassen kann man auf die gelieferten Felder zugreifen.

Instanzmethoden

`array getFields()`
Aufgabe: Listet alle nicht leeren Felder dieses Objektes auf. Rückgabewert: Ein Array mit Name/Wert-Paaren verschiedenen Typs (String, Integer, Boolean usw.) Exceptions: –