Dokumentation Backclick 5
Page tree
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 13 Next »

Beschreibung

Diese Funktion bietet die Möglichkeit einen Newsletter im System anzulegen und zu versenden. Im Gegensatz zu der Methode "SendNewsletter" müssen die Empfänger hier aber nicht jedes mal angegeben werden. Stattdessen bietet diese Funktion die Möglichkeit Newsletter an bestehende Verteilerlisten oder Profilfilter zu senden. Die Funktion gibt als Ergebnis ein Objekt zurück, welches die ID des angelegten Newsletters enthält. So haben Sie dann die Möglichkeit über die Funktionen NewsletterStatistic und BackclickStatistic die Statistiken zu dem Newsletter abzurufen.

Wenn Sie einen Newsletter anlegen/versenden wollen, dann müssen Sie folgende Angaben machen:

  • Betreff des Newsletters
  • ID Ihres Mandanten
  • Empfänger des Newsletters (entweder wird die Verteilerliste oder eine Liste von Profilfiltern angegeben)
    • ID der Verteilerliste
    • Liste mit ID's von Profilfiltern
  • Inhalt des Newsletters, dabei können Sie wahlweise den Inhalt direkt angeben, oder eine ID einer bestehenden Newslettervorlage
    • HTML- oder Textinhalt des Newsletters
    • Alternativtext des Newsletters (falls der Inhalt HTML ist)
    • ID der Newslettervorlage
  • Ersetzung für die Variable $$SPECIAL-REPLACEMENT-TEXT$$ (Standard: "adhockInformation" => "") optionale Angabe
  • Die Versandzeit (Standard: "sendTime" => 0) optionale Angabe
  • Angezeigter Absendername (Standard: "senderName" => "") optionale Angabe
  • Absender E-Mail Adresse (Standard: "senderEmail" => "") optionale Angabe

Als Ergebnis bekommen Sie den Status des Aufrufs. Er enthält die Information, ob der Aufruf erfolgreich war oder nicht. Falls der Aufruf erfolgreich war, enthält das Ergebnis zusätzlich die ID des angelegten Newsletters.

Folgende Fehlermeldungen können bei fehlerhaften Requests auftreten:

  • Invalid domain of sender address ("example.com"). If you want to send email for this domain, please contact your admin.
  • Validation error
  • No templateId AND no newsletterContent given!
  • SOAP-ERROR: Encoding: object has no 'subject' property
  • No subject given.
  • Invalid templateId!
  • Autoimport is running. Please try again later.
  • Filter with ID #id  is non existent.

Beispiel

Erstellen und Versenden eines Newsletters
$client = new SoapClient($wsdlUrl);
$createMailingRequest = new StdClass();
$createMailingRequest->mandatorId = 0;
$createMailingRequest->newsletterContent = utf8_encode("<html><body>HTML-Inhalt des Newsletters</body></html>");
$createMailingRequest->alternativeContent = utf8_encode("Text-Inhalt des Newsletters");
$createMailingRequest->subject = utf8_encode("Betreff des Newsletters");
$createMailingRequest->senderName = "Absendername";
$createMailingRequest->senderEmail = "user@example.com";
$createMailingRequest->recipients = new StdClass();
$createMailingRequest->recipients->newsletterListId = 1;
date_default_timezone_set('Europe/Berlin');
$createMailingRequest->sendTime = time();
try {
  $result = $client->createMailing($createMailingRequest);
  var_dump($result);
} catch (Exception $e) {
  echo "\n" . $e->getMessage() . "\n";
  if (is_array($e->detail->ValidationError)) {
    foreach ($e->detail->ValidationError as $ve) {
      echo $ve . "\n"; 
    } 
  } else {
    echo $e->detail->ValidationError . "\n";
  }
}
Beispielausgabe
object(stdClass)#4 (2) {
  ["success"]=>
  bool(true)
  ["newsletterId"]=>
  int(10153)
}

 Quellcode

Damit Sie ein funktionsfähiges Beispiel testen können, haben wir Ihnen hier den Quellcode zum Download zur Verfügung gestellt.

Beispiel für den Versand eines Newsletters

  • No labels