KAS API Dokumentation
Back to top  

Functions

Anlegen einer Mail-Weiterleitungen

add_mailforward(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
  • local_part: der local_part, RFC2822
  • domain_part: FQDN, RFC2822
  • target_N: die Weiterleitungs-Ziele RFC2822 (N als fortlaufende Nummer, optional)

Exceptions

TRUE die Aktion wurde durchgeführt
\missing_parameter ein Pflichtparameter fehlt
\couldnt_get_kas_ressources
\domain_part_doesnt_exist
\hostname_syntax_incorrect
\mail_forward_adress_syntax_incorrect
\mail_forward_exists_as_emailaccount
\mail_forward_exists_as_forward
\max_mail_forward_reached
\target_email_duplicate
\mail_loop_detected
\target_email_like_forward
\target_email_syntax_incorrect
\targets_limit_reached

Löschen einer Mail-Weiterleitung

delete_mailforward(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
  • mail_forward: die zu löschende Mail-Weiterleitung

Exceptions

TRUE die Aktion wurde durchgeführt
\missing_parameter ein Pflichtparameter fehlt
\in_progress das KAS Objekt ist zZt noch in Bearbeitung
\mail_forward_domain_not_found_in_kas
\mail_forward_not_found_in_kas
\mail_loop_detected

Auslesen der Mail-Weiterleitungen

get_mailforwards(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
  • mail_forward: die Mailweiterleitung (optional)

Exceptions

\array_return Array mit den vorhandenen Weiterleitungen

Bearbeiten der Mail-Weiterleitungen

update_mailforward(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
  • mail_forward: die zu bearbeitende Mail-Weiterleitung
  • target_N: die Weiterleitungs-Ziele RFC2822 (N als fortlaufende Nummer, optional)

Exceptions

TRUE die Aktion wurde durchgeführt
\missing_parameter ein Pflichtparameter fehlt
\in_progress das KAS Objekt ist zZt noch in Bearbeitung
\nothing_to_do es wurde nichts geändert
\mail_forward_adress_syntax_incorrect
\mail_forward_not_found
\mail_loop_detected
\target_email_duplicate
\target_email_like_forward
\target_email_syntax_incorrect
\targets_limit_reached