E-Mail Mailinglisten API


Beschreibung

Download:

scmaillist.inc.php.txt [3.158 Bytes]

Die Mailinglisten API für PHP5 bietet Ihnen die Möglichkeiten aus Ihren eigenen Websitescripten heraus direkt auf Site Control zugreifen zu können. Der Zugriff ist dabei beschränkt darauf E-Mail Adressen zu einer Mailingliste hinzuzufügen oder eine Adresse aus einer Liste zu entfernen.

 


Beispielscript

Das folgende Beispiel zeigt Ihnen, wie Sie die API Klasse einbinden und nutzen können.  
?php
require('scmaillist.inc.php');

try {
    $mymaillist = new scmaillist('example.org', 'user', 
                       'password', 'maillist@example.org');
}
catch (Exception $e) {
    echo $e->getMessage();
}

$retval1 = $mymaillist->add_address('anna@example.org');
if ($retval1 != 0) {
    echo $mymaillist->errmsg;
}

$retval2 = $mymaillist->remove_address('mike@example.org');
if ($retval1 != 0) {
    echo $mymaillist->errmsg;
}
?>

Das einfache Beispielscript erzeugt zunächst eine Instanz der scmaillist-Klasse. Die erzeugte Instanz ist immer fest mit einer speziellen Maillingliste verknüpft. Für das Bearbeiten weiterer Maillinglisten müssen neue Klasseninstanzen erzeugt werden.

Ist einer der Parameter des Konstruktors ungültig oder fehlt, wird eine Exception geworfen. Achten Sie also darauf, dass Sie diese entsprechend abfangen.

Im Anschluss wird jeweils eine E-Mail Adresse der Mailingliste hinzugefügt und gelöscht.

 


Konstruktor

public function __construct($masterdomain, $user, $pw, $maillist)
Beim Anlegen einer neuen Klasseninstanz müssen Sie dem Konstruktor immer die Masterdomain Ihres Accounts, einen gültigen Site Control Benutzernamen und Passwort sowie die Adresse der zu bearbeitenden Mailingliste übergeben.

Der Login kann zwar Ihr normaler Site Control Login sein, allerdings empfehlen wir aus Sicherheitsgründen, einen neuen Benutzer in Site Control anzulegen mit Zugriffsrechten auf die Mailinglisten API.

Im Fehlerfall wirft der Konstruktor Exceptions, was zur Folge hat, dass keine gültige Objektinstanz erzeugt wird. Mögliche Exceptions sind:

  • Invalid parameter count
  • Invalid masterdomain
  • No valid maillist

 


Funktion add_address

public function add_address($new_address)
Die Funktion add_address fügt der Mailingliste eine weitere E-Mail Adresse als Empfänger hinzu. Als Parameter wird die neue E-Mail Adresse erwartet.

Funktioniert das Hinzufügen fehlerfrei, dann ist der Rückgabewert der Funktion 0. Mögliche Fehlerwerte sind:

  • 1 - Logindaten ungültig
  • 2 - Mailinglistenadresse ungültig
  • 3 - Neue E-Mail Adresse ungültig
  • 4 - Ausgewählte Mailingliste existiert nicht
  • 5 - Neue E-Mail Adresse ist bereits in der Mailingliste eingetragen
  • 10 - Site Control Request fehlgeschlagen

 


Funktion remove_address

public function remove_address($old_address)

Die Funktion remove_address enfernt die angegebene E-Mail Adresse aus der Mailingliste der Klasseninstanz. Als einziger Parameter muss die alte E-Mail Adresse angegeben werden.

Klappt das Löschen fehlerfrei, dann ist der Rückgabewert der Funktion 0. Mögliche Fehlerwerte sind:

  • 1 - Logindaten ungültig
  • 2 - Mailinglistenadresse ungültig
  • 3 - Alte E-Mail Adresse ungültig
  • 4 - ausgewählte Mailingliste existiert nicht
  • 5 - Alte E-Mail Adresse ist nicht in der Mailingliste eingetragen
  • 10 - Site Control Request fehlgeschlagen

 


Funktion add_moderator

public function add_moderator($mod_address)

Die Funktion add_moderator fügt die angegebene E-Mail Adresse der Liste der Adressen hinzu, welche berechtigt sind an die Mailingliste zu schreiben. Solange hier keine E-Mail Adresse eingetragen ist, gilt die Mailingliste als unmoderiert, sodass jeder schreibberechtigt ist.

Klappt das Hinzufügen fehlerfrei, dann ist der Rückgabewert der Funktion 0. Mögliche Fehlerwerte sind:

  • 1 - Logindaten ungültig
  • 2 - Mailinglistenadresse ungültig
  • 3 - E-Mail Adresse ungültig
  • 4 - ausgewählte Mailingliste existiert nicht
  • 10 - Site Control Request fehlgeschlagen

 


Funktion remove_moderator

public function remove_moderator($mod_address)

Die Funktion remove_moderator entfernt die angegebene E-Mail Adresse von der Liste der Adressen, welche berechtigt sind an die Mailingliste zu schreiben. Sind hier keine E-Mail Adressen mehr eingetragen, gilt die Mailingliste als unmoderiert, sodass jeder schreibberechtigt ist.

Klappt das Entfernen fehlerfrei, dann ist der Rückgabewert der Funktion 0. Mögliche Fehlerwerte sind:

  • 1 - Logindaten ungültig
  • 2 - Mailinglistenadresse ungültig
  • 3 - E-Mail Adresse ungültig
  • 4 - ausgewählte Mailingliste existiert nicht
  • 10 - Site Control Request fehlgeschlagen

 


Funktion membercnt

public function membercnt()

Die Funktion membercnt gibt die Anzahl aller bisher eingetragenen E-Mail Adressen in der aktuellen Mailingliste zurück.

Ist die Abfrage fehlerfrei, dann ist der Rückgabewert der Funktion die Anzahl E-Mail Adressen als Integer. Mögliche Fehlerwerte sind:

  • -1 - Logindaten ungültig
  • -2 - Mailinglistenadresse ungültig
  • -4 - ausgewählte Mailingliste existiert nicht

 
zurück  IndexDomains Verwaltung