Documentation

mailaccount

Table of Contents

Functions

add_mailaccount()  : mixed
Anlegen eines Mailaccounts
delete_mailaccount()  : mixed
Löschen eines Mailaccounts
update_mailaccount()  : mixed
Bearbeiten eines Mailaccounts

Functions

add_mailaccount()

Anlegen eines Mailaccounts

add_mailaccount(array<string|int, mixed> $parameter) : mixed
Parameters
$parameter : array<string|int, mixed>

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)
  • mail_allow_nets: Zugriffe nur für bestimmte Clients (optional, z.B. 1.2.3.4, 12.34.0.0/16, webmail)
Tags
link

Beispiel

throws
true

die Aktion wurde durchgeführt

throws
missing_parameter

ein Pflichtparameter fehlt

throws
copy_adress_like_mailaccount
throws
copy_adress_syntax_incorrect
throws
couldnt_get_kas_ressources
throws
email_already_exists
throws
email_domain_doesnt_exist
throws
email_syntax_incorrect
throws
mail_loop_detected
throws
max_emails_reached
throws
max_sender_alias_reached
throws
password_syntax_incorrect
throws
responder_contentype_syntax_incorrect
throws
responder_displayname_syntax_incorrect
throws
responder_not_allowed_for_catchall_adresses
throws
responder_startdate_gt_enddate
throws
responder_syntax_incorrect
throws
responder_text_is_empty
throws
sender_alias_domain_in_kas
throws
sender_alias_syntax_incorrect
throws
mail_xlist_enabled_syntax_incorrect
throws
mail_xlist_sent_syntax_incorrect
throws
mail_xlist_drafts_syntax_incorrect
throws
mail_xlist_trash_syntax_incorrect
throws
mail_xlist_spam_syntax_incorrect
throws
mail_xlist_archiv_syntax_incorrect
throws
mail_xlist_duplicate_folder
throws
webmail_autologin_syntax_incorrect

delete_mailaccount()

Löschen eines Mailaccounts

delete_mailaccount(array<string|int, mixed> $parameter) : mixed
Parameters
$parameter : array<string|int, mixed>

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
Tags
link

Beispiel

throws
true

die Aktion wurde durchgeführt

throws
missing_parameter

ein Pflichtparameter fehlt

throws
in_progress

das KAS Objekt ist zZt noch in Bearbeitung

throws
mail_login_not_found
throws
mail_loop_detected

update_mailaccount()

Bearbeiten eines Mailaccounts

update_mailaccount(array<string|int, mixed> $parameter) : mixed
Parameters
$parameter : array<string|int, mixed>

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)
  • mail_allow_nets: Zugriffe nur für bestimmte Clients (optional, z.B. 1.2.3.4, 12.34.0.0/16, webmail)
Tags
link

Beispiel

throws
true

die Aktion wurde durchgeführt

throws
missing_parameter

ein Pflichtparameter fehlt

throws
in_progress

das KAS Objekt ist zZt noch in Bearbeitung

throws
nothing_to_do

es wurde nichts geändert

throws
copy_adress_like_mailaccount
throws
copy_adress_syntax_incorrect
throws
email_already_exists
throws
email_domain_doesnt_exist
throws
mail_loop_detected
throws
is_active_syntax_incorrect
throws
mail_login_not_found
throws
max_sender_alias_reached
throws
password_syntax_incorrect
throws
responder_contentype_syntax_incorrect
throws
responder_displayname_syntax_incorrect
throws
responder_not_allowed_for_catchall_adresses
throws
responder_startdate_gt_enddate
throws
responder_syntax_incorrect
throws
responder_text_is_empty
throws
sender_alias_domain_in_kas
throws
sender_alias_syntax_incorrect
throws
mail_xlist_enabled_syntax_incorrect
throws
mail_xlist_sent_syntax_incorrect
throws
mail_xlist_drafts_syntax_incorrect
throws
mail_xlist_trash_syntax_incorrect
throws
mail_xlist_spam_syntax_incorrect
throws
mail_xlist_archiv_syntax_incorrect
throws
mail_xlist_duplicate_folder
throws
webmail_autologin_syntax_incorrect
throws
webmail_autologin_change_requires_new_password

        
On this page

Search results