HostingMailboxAdd¶

This function allows the creation of new email addresses or mailboxes.

The password can optionally be passed as a salted MD5 password hash (e.g. $1$abcdefgh$abcdefghijklmnopqrstuv); this is then directly passed to the password database (important for importing existing mailbox passwords from other control panels). In this case, however, the authentication mechanism CRAM-MD5 should be disabled on the server, otherwise problems can occur when trying to log in. Alternatively, existing passwords with the prefix {CRAM-MD5} can be imported unchanged.

Request¶
Field	Type	RegExp	Null?	Description
`auth`	AuthData		no	Authentication data
`subscription`	string	`^[a-z][a-z0-9_-]{1,63}$`	no	Subscription name
`name`	string	`^[a-z0-9+_&.-]{1,64}$`	no	Name of the e-mail address (left part, before „@“)
`domain`	string	`^[^+<>&%\s]{1,255}$`	no	Full domain name (right part, after „@“)
`alias`	string[]	`^[\w_]{1,64}$`	yes	Array with alias names for this domain (usually up to 10)
`mailbox`	integer	`^[01]$`	no	`0` = only forward mails, `1` = POP3/IMAP mailbox
`password`	string	`^.{5,200}$`	yes	Password (required for POP3/IMAP mailboxes, optionally in all other cases)
`weblogin`	integer	`^[01]?$`	yes	Allow login to LiveConfig? (`1` = yes)
`quota`	integer	`^\d{1,6}$`	yes	Mailbox size (MB) (required for POP3/IMAP mailboxes)
`forward`	string[]	`EMAIL(128)`	yes	Array with e-mail addresses to forward incoming e-mails to
`autoresponder`	integer	`^[01]$`	no	Autoresponder enabled? (`0` = no, `1` = yes)
`autosubject`	string	`^.{5,80}$`	yes	Subject for autoresponder (required when `autoresponder=1`)
`automessage`	string	`^.{5,4096}$`	yes	Message for autoresponder (required when `autoresponder=1`)
`greylisting`	integer	`^[01]?$`	yes	Greylisting enabled? (only if greylisting is supported!) (`1` = yes)
`spamfilter`	integer	`^[01]?$`	yes	Spam check enabled? (only if spam filter is supported!) (`1` = yes)
`spamwarn`	integer	`^(\\d+([.,]\\d+)?)?$`	yes	Warn threshold for spam filter (only when `spamfilter=1`)
`spamreject`	integer	`^(\\d+([.,]\\d+)?)?$`	yes	Reject threshold for spam filter (only when `spamfilter=1`)
`spamprefix`	string	`^.{0,128}$`	yes	Prefix for e-mail subject, when warn threshold is reached (only when `spamfilter=1`)
`spamwhitelist`	string	`^.{0,1024}$`	yes	Whitelist records for spam filter (since v2.10)
`spamblacklist`	string	`^.{0,1024}$`	yes	Blacklist records for spam filter (since v2.10)

Response¶
Field	Type	Null?	Description
`id`	string	no	Datensatz-ID
`folder`	string	yes	Folder where the POP3/IMAP mailbox has been created (the mailbox is usually located at `/var/mail/<subscription>/<folder>/`)

Zuletzt aktualisiert am 17.02.2021.

weiter: HostingMailboxEdit
zurück: HostingLookup