Beschreibung

Mit Hilfe der Funktion GetSubscriberToNewsletterListRelation kann die Zugehörigkeit einer E-Mail Adresse zu einer bestimmten oder allen Verteilerlisten abgefragt werden. Die Funktion gibt als Anwort die Information zu der Liste (Name, Beschreibung, ID), sowie den Status der E-Mail Adresse in Bezug auf die Liste zurück. Der Status kann folgende Werte annehmen:

• 0: Abonnent IST eingetragen
• 1: Abonnent WAR eingetragen

Das Feld "subscriberAvailable" kann dabei folgende Werte annehmen:

• true: Benutzer existiert im System
• false: Benutzer existiert nicht im System

Wenn eine spezielle Liste abgefragt werden soll, so muss diese im Request angegeben werden. Sollen alle Listen abgefragt werden, so muss als Listen-ID eine 0 angegeben werden. Weiterhin ist im Ergebnis die Information enthalten, ob der Abonnent aktuell im System hinterlegt ist.

Verfügbar ab Backclick-Version: 5.9.0

Um die Abfrage auszuführen müssen folgende Angaben gemacht werden:

• ID des Mandanten
• E-Mail Adresse
• Verteilerliste (ID 0 für die Abfrage aller Listen)
• API-Key (optionale Authentifizierung, wenn nicht angegeben, dann wird die Authentifizierung über die IP-Adressen vorgenommen)

Beispiel

$client = new SoapClient($wsdlUrl);
date_default_timezone_set('Europe/Berlin');
$request = new StdClass();
$request->mandatorId = 0;
$request->newsletterListId = 1;
$request->subscriberEmail = "user@example.com";
try {
  var_dump($client->getSubscriberToNewsletterListRelation($request));
} catch (Exception $e) {
  echo "Error: " . $e->getMessage() . "\r\n";
}

object(stdClass)#3 (2) {
  ["listInformations"]=>
  array(1) {
    [0]=>
    object(stdClass)#4 (4) {
      ["listDescription"]=>
      string(27) "Testbeschreibung 1"
      ["listId"]=>
      int(1)
      ["listName"]=>
      string(15) "Testverteiler 1"
      ["listStatus"]=>
      int(0)
    }
  }
  ["subscriberAvailable"]=>
  bool(true)
}

Quellcode

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

Beispiel für die Abfrage der Listenzugehörigkeit