ATTENTION

You're browsing the documentation for an development version of froxlor.
The current stable version's documentation can be found here.

Emails

Emails.add

add a new email address

Permission

admin customer

Parameter

FieldTypeDescription
email_partstringname of the address before @
domainstringdomain-name for the email-address
iscatchallbooleanoptional, make this address a catchall address, default: no
customeridintoptional, required when called as admin (if $loginname is not specified)
loginnamestringoptional, required when called as admin (if $customerid is not specified)
descriptionstringoptional custom description (currently not used/shown in the frontend), default empty

Response

string as json-encoded array

Emails.get

return a email-address entry by either id or email-address

Permission

admin customer

Parameter

FieldTypeDescription
idintoptional, the email-address-id
emailaddrstringoptional, the email-address

Response

string as json-encoded array

Emails.update

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

Permission

admin customer

Parameter

FieldTypeDescription
idintoptional, the email-address-id
emailaddrstringoptional, the email-address
customeridintoptional, required when called as admin (if $loginname is not specified)
loginnamestringoptional, required when called as admin (if $customerid is not specified)
iscatchallbooleanoptional
descriptionstringoptional custom description (currently not used/shown in the frontend), default empty

Response

string as json-encoded array

Emails.listing

list all email addresses, if called from an admin, list all email addresses of 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

Emails.listingCount

returns the total number of accessible email addresses

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

Emails.delete

delete an email address by either id or username

Permission

admin customer

Parameter

FieldTypeDescription
idintoptional, the email-address-id
emailaddrstringoptional, the email-address
customeridintoptional, required when called as admin (if $loginname is not specified)
loginnamestringoptional, required when called as admin (if $customerid is not specified)
delete_userfilesbooleanoptional, delete email data from filesystem, default: 0 (false)

Response

string as json-encoded array