Skip to content
ATTENTION
You are viewing the documentation of the current development state (git-main / nightly).
The current latest stable documentation can be found here.

EmailDomains

EmailDomains.listing

list all domains with email addresses connected to it. If called from an admin, list all domains with email addresses connected to it from all customers you are allowed to view, or specify id or loginname for one specific customer

Permission

admin customer

Parameter

FieldTypeDescription
customeridintoptional, admin-only, select email addresses of a specific customer by id
loginnamestringoptional, admin-only, select email addresses of a specific customer by loginname
sql_searcharrayoptional array with index = fieldname, and value = array with 'op' => operator (one of <, > or =),LIKE is used if left empty and 'value' => searchvalue
sql_limitintoptional specify number of results to be returned
sql_offsetintoptional specify offset for resultset
sql_orderbyarrayoptional array with index = fieldname and value = ASC|DESC to order the resultset by one or morefields

Response

string as json-encoded array count|list

EmailDomains.listingCount

returns the total number of accessible domains with email addresses connected to

Permission

admin customer

Parameter

FieldTypeDescription
customeridintoptional, admin-only, select email addresses of a specific customer by id
loginnamestringoptional, admin-only, select email addresses of a specific customer by loginname

Response

string as json-encoded response message

EmailDomains.get

You cannot directly access email-domains

Permission

admin customer

Response

string as json-encoded array

EmailDomains.add

You cannot directly add email-domains

Permission

admin customer

Response

string as json-encoded array

EmailDomains.update

toggle catchall flag of given email address either by id or email-address

Permission

admin customer

Response

string as json-encoded array

EmailDomains.delete

You cannot directly delete email-domains

Permission

admin customer

Response

string as json-encoded array