KAS API Dokumentation
Back to top  

Functions

Anlegen eines Mailaccounts

add_mailaccount(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_password: das Mailaccountpasswort
  • webmail_autologin: automatisches Login vom KAS ins Webmail möglich: Y|N (optional, default Y)
  • local_part: der local_part, RFC2822
  • domain_part: FQDN, RFC2822
  • responder: aktiver Responder: N|Y oder start|ende (start und ende als Timestamps mit "|" als Trenner, optional, default N)
  • mail_responder_content_type: der Content-Type des Responder-Textes: html|text (optional, default text)
  • mail_responder_displayname: der Anzeigename des Absenders bei dem Autoresponder, z.B. "mein Autoresponder Max Mustermann" (optional, default leer)
  • responder_text: der Respondertext (optional, default leer)
  • copy_adress: die Kopieempfängeradressen: RFC2822 (mehrere Adressen mit Komma getrennt sind möglich, optional, default leer)
  • mail_sender_alias: erlaubte Aliasadressen, mit denen ein Versenden im FROM möglich ist (optional, default leer)
  • mail_xlist_enabled: XLIST aktiv: Y|N (optional, default Y)
  • mail_xlist_sent: XLIST Name "gesendete Objekte" (optional, default Sent)
  • mail_xlist_drafts: XLIST Name "Entwürfe" (optional, default Drafts)
  • mail_xlist_trash: XLIST Name "Papierkorb" (optional, default Trash)
  • mail_xlist_spam: XLIST Name "Spam" (optional, default Spam)
  • mail_xlist_archiv: XLIST Name "Archiv" (optional, default Archiv)

Exceptions

TRUE die Aktion wurde durchgeführt
\missing_parameter ein Pflichtparameter fehlt
\copy_adress_like_mailaccount
\copy_adress_syntax_incorrect
\couldnt_get_kas_ressources
\email_already_exists
\email_domain_doesnt_exist
\email_syntax_incorrect
\mail_loop_detected
\max_emails_reached
\max_sender_alias_reached
\password_syntax_incorrect
\responder_contentype_syntax_incorrect
\responder_displayname_syntax_incorrect
\responder_not_allowed_for_catchall_adresses
\responder_startdate_gt_enddate
\responder_syntax_incorrect
\responder_text_is_empty
\sender_alias_domain_in_kas
\sender_alias_syntax_incorrect
\mail_xlist_enabled_syntax_incorrect
\mail_xlist_sent_syntax_incorrect
\mail_xlist_drafts_syntax_incorrect
\mail_xlist_trash_syntax_incorrect
\mail_xlist_spam_syntax_incorrect
\mail_xlist_archiv_syntax_incorrect
\mail_xlist_duplicate_folder
\webmail_autologin_syntax_incorrect

Löschen eines Mailaccounts

delete_mailaccount(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_login: der zu löschende Mailaccount

Exceptions

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

Auslesen der Mailaccounts

get_mailaccounts(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_login: das gewünschte Maillogin (optional)

Exceptions

\array_return Array mit den vorhandenen Mailaccounts

Bearbeiten eines Mailaccounts

update_mailaccount(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_login: das zu bearbeitende Login
  • mail_new_password: das neue Mailaccountpasswort (optional)
  • webmail_autologin: automatisches Login vom KAS ins Webmail möglich: Y|N (optional, default Y)
  • responder: aktiver Responder: N|Y oder start|ende (start und ende als Timestamps mit "|" als Trenner, optional)
  • mail_responder_content_type: der Content-Type des Responder-Textes: html|text (optional)
  • mail_responder_displayname: der Anzeigename des Absenders bei dem Autoresponder, z.B. "mein Autoresponder Max Mustermann" (optional)
  • responder_text: der Respondertext (optional)
  • copy_adress: die Kopieempfängeradressen: RFC2822 (mehrere Adressen mit Komma getrennt sind möglich, optional)
  • is_active: ist das Postfach aktiv: Y|N|forbidden (N: kein Empfang aber Abruf ist noch möglich, optional)
  • mail_sender_alias: erlaubte Aliasadressen, mit denen ein Versenden im FROM möglich ist (optional)
  • mail_xlist_enabled: XLIST aktiv: Y|N (optional)
  • mail_xlist_sent: XLIST Name "gesendete Objekte" (optional)
  • mail_xlist_drafts: XLIST Name "Entwürfe" (optional)
  • mail_xlist_trash: XLIST Name "Papierkorb" (optional)
  • mail_xlist_spam: XLIST Name "Spam" (optional)
  • mail_xlist_archiv: XLIST Name "Archiv" (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
\copy_adress_like_mailaccount
\copy_adress_syntax_incorrect
\email_already_exists
\email_domain_doesnt_exist
\mail_loop_detected
\is_active_syntax_incorrect
\mail_login_not_found
\max_sender_alias_reached
\password_syntax_incorrect
\responder_contentype_syntax_incorrect
\responder_displayname_syntax_incorrect
\responder_not_allowed_for_catchall_adresses
\responder_startdate_gt_enddate
\responder_syntax_incorrect
\responder_text_is_empty
\sender_alias_domain_in_kas
\sender_alias_syntax_incorrect
\mail_xlist_enabled_syntax_incorrect
\mail_xlist_sent_syntax_incorrect
\mail_xlist_drafts_syntax_incorrect
\mail_xlist_trash_syntax_incorrect
\mail_xlist_spam_syntax_incorrect
\mail_xlist_archiv_syntax_incorrect
\mail_xlist_duplicate_folder
\webmail_autologin_syntax_incorrect
\webmail_autologin_change_requires_new_password