KAS API Dokumentation
Back to top  

Functions

Anlegen einer Mailingliste

add_mailinglist(array $parameter) 
link Beispiel

Parameters

$parameter

array

folgende Parameter sind möglich:

  • kas_login: das betreffende KAS Login
  • kas_auth_data: die Authentifizierungsdaten
  • kas_auth_type: der Authentifizierungstyp
  • mailinglist_name: der Listenname
  • mailinglist_domain: der Domainname zur Liste
  • mailinglist_password: das Listenpasswort

Exceptions

TRUE die Aktion wurde durchgeführt
\missing_parameter ein Pflichtparameter fehlt
\couldnt_get_kas_ressources
\mailinglist_already_exists
\mailinglist_domain_doesnt_exist
\mailinglist_domain_syntax_incorrect
\mailinglist_syntax_incorrect
\max_mailinglists_reached
\missing_parameter
\password_syntax_incorrect

Löschen einer Mailingliste

delete_mailinglist(array $parameter) 
link Beispiel

Parameters

$parameter

array

folgende Parameter sind möglich:

  • kas_login: das betreffende KAS Login
  • kas_auth_data: die Authentifizierungsdaten
  • kas_auth_type: der Authentifizierungstyp
  • mailinglist_name: die zu löschende Mailingliste

Exceptions

TRUE die Aktion wurde durchgeführt
\missing_parameter ein Pflichtparameter fehlt
\in_progress das KAS Objekt ist zZt noch in Bearbeitung
\mailinglist_domain_not_found_in_kas
\mailinglist_not_found
\mailinglist_syntax_incorrect

Auslesen der Mailinglisten

get_mailinglists(array $parameter) 
link Beispiel

Parameters

$parameter

array

folgende Parameter sind möglich:

  • kas_login: das betreffende KAS Login
  • kas_auth_data: die Authentifizierungsdaten
  • kas_auth_type: der Authentifizierungstyp
  • mailinglist_name: die gewünsche Liste (optional)

Exceptions

\array_return Array mit den vorhandenen Mailinglisten

Bearbeiten einer Mailingliste

update_mailinglist(array $parameter) 
link Beispiel

Parameters

$parameter

array

folgende Parameter sind möglich:

  • kas_login: das betreffende KAS Login
  • kas_auth_data: die Authentifizierungsdaten
  • kas_auth_type: der Authentifizierungstyp
  • mailinglist_name: die zu bearbeitende Mailingliste
  • subscriber: die Listenteilnehmer als RFC2822 (mehrere mit Zeilenumbruch getrennt, optional)
  • restrict_post: die Resrict-Post-Adressen RFC2822 (mehrere mit Zeilenumbruch getrennt, optional)
  • config: die komplette Konfigurationsdatei als Klartext
  • is_active: ist die Mailingliste aktiv: Y|N (optional)

Exceptions

TRUE die Aktion wurde durchgeführt
\missing_parameter ein Pflichtparameter fehlt
\in_progress das KAS Objekt ist zZt noch in Bearbeitung
\cannot_connect_to_majordomo
\cannot_login_to_majordomo
\cannot_open_tmp_config
\cannot_open_tmp_restrict_post
\cannot_open_tmp_subscriber
\cannot_write_tmp_config
\cannot_write_tmp_restrict_post
\cannot_write_tmp_subscriber
\cannot_write_to_majordomo
\is_active_syntax_incorrect
\mailinglist_not_found
\mailinglist_syntax_incorrect
\parse_error_in_tmp_config
\restrict_post_email_syntax_incorrect
\subscriber_email_syntax_incorrect