Beschreibung

Mit Hilfe der Funktion DeleteSubscriber können Abonnenten von Verteilerlisten abgemeldet werden. Wenn ein Abonnent danach keine Listenzugehörigkeit mehr hat, wird er komplett aus dem System entfernt. Bei dieser Methode können in einem Request mehrere Adressen angegeben werden, für alle diese Adressen gelten dann die selben Listen, von denen sie abgemeldet werden sollen. Es ist nicht möglich, für jede Adresse einzelne Listen anzugeben. Über die Angabe des Double-Opt-Out Templates kann eine Bestätigung des Empfängers ausgelöst werden. Wenn keine oder eine falsche Template-ID angegeben ist, dann werden die Adressen sofort abgemeldet.

Verfügbar ab Backclick-Version: 5.9.0

Wenn ein Abonnent von einer Liste abgemeldet werden soll, müssen folgende Angaben gemacht werden:

• ID des Mandanten
• E-Mail Adresse(n)
• Verteilerliste(n)
• ID eines Double-Opt-Out Templates (Standard: 0 => kein DOO); optionale Angabe
• API-Key (optionale Authentifizierung, wenn nicht angegeben, dann wird die Authentifizierung über die IP-Adressen vorgenommen)

Als Ergebnis wird eine Liste mit abgemeldeten und nicht abgemeldeten E-Mail Adressen ausgegeben.

Beispiel

$client = new SoapClient($wsdlUrl);
$request = new StdClass();
$request->mandatorId = 0;
$request->subscriberEmails = array();
array_push($request->subscriberEmails, "user@example.com");
$request->newsletterListIdsToDelete = array();
array_push($request->newsletterListIdsToDelete, 1);
try {
  var_dump($client->deleteSubscriber($request));
} catch (Exception $e) {
  echo "Error: " . $e->getMessage() . "\r\n";
}

object(stdClass)#3 (2) {
  ["deletedSubscribers"]=>
  string(27) "user@example.com"
  ["notDeletedSubscribers"]=>
  string(0) ""
}

Anmerkung

Da E-Mail Adressen auch HTML-Sonderzeichen beinhalten können wird empfohlen die Werte z.B. mit 

$email = htmlspecialchars($email, ENT_COMPAT,'ISO-8859-1', true);

zu escapen (HTML-Escape) da sonst Fehler beim Absetzen des SOAP-Requests auftreten können.

Quellcode

Um ein funktionsfähiges Beispiel testen zu können, steht hier der Quellcode zum Download zur Verfügung.

Beispiel zum Abmelden eines Abonnenten