HostingMailboxGet

This function can be used to retrieve details about an email address.

Request

Field

Type

RegExp

Null?

Description

auth

AuthData

no

Authentication data

address

string

EMAIL(128)

no

E-Mail address to query

Response

Field

Type

Null?

Description

alias

string[]

yes

Array with alias names for this domain

mailbox

integer

yes

0 = only forward mails, 1 = POP3/IMAP mailbox

password

string

yes

Password or password hash (if available; for migration purposes)

weblogin

integer

yes

Allow login to LiveConfig? (1 = yes)

quota

integer

yes

Maximum mailbox size (MB) (required for POP3/IMAP mailboxes)

forwarding

integer

yes

E-Mail forwarding enabled? (1 = yes)

forward

string[]

yes

Array with e-mail addresses to forward incoming e-mails to

autoresponder

integer

yes

Autoresponder enabled? (0 = no, 1 = yes)

autosubject

string

yes

Subject for autoresponder (required when autoresponder=1)

automessage

string

yes

Message for autoresponder (required when autoresponder=1)

greylisting

integer

yes

Greylisting enabled? (only if greylisting is supported!) (1 = yes)

spamfilter

integer

yes

Spam check enabled? (only if spam filter is supported!) (1 = yes)

spamwarn

integer

yes

Warn threshold for spam filter (only when spamfilter=1)

spamreject

integer

yes

Reject threshold for spam filter (only when spamfilter=1)

spamprefix

string

yes

Prefix for e-mail subject, when warn threshold is reached (only when spamfilter=1)

spamwhitelist

string

yes

Whitelist records for spam filter (since v2.10)

spamblacklist

string

yes

Blacklist records for spam filter (since v2.10)


Last updated on May 04, 2020.
next: HostingPasswordPathAdd
previous: HostingMailboxEdit