ATTENTION

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

EmailAccounts

EmailAccounts.add

add a new email account for a given email-address either by id or emailaddr

Permission

admin customer

Parameter

FieldTypeDescription
idintoptional email-address-id of email-address to add the account for
emailaddrstringoptional email-address to add the account for
customeridintoptional, required when called as admin (if $loginname is not specified)
loginnamestringoptional, required when called as admin (if $customerid is not specified)
email_passwordstringpassword for the account
alternative_emailstringoptional email address to send account information to, default is the account that is being created
email_quotaintoptional quota if enabled in MB, default 0
sendinfomailbooloptional, sends the welcome message to the new account (needed for creation, without the user won'tbe able to login before any mail is received), default 1 (true)

Response

string as json-encoded array

EmailAccounts.get

You cannot directly get an email account. You need to call Emails.get()

EmailAccounts.update

update email-account entry for given email-address by either id or email-address

Permission

admin customer

Parameter

FieldTypeDescription
idintoptional, the email-address-id
emailaddrstringoptional, the email-address to update
customeridintoptional, required when called as admin (if $loginname is not specified)
loginnamestringoptional, required when called as admin (if $customerid is not specified)
email_quotaintoptional, update quota
email_passwordstringoptional, update password
deactivatedbooloptional, admin-only

Response

string as json-encoded array

EmailAccounts.listing

You cannot directly list email accounts. You need to call Emails.listing()

EmailAccounts.listingCount

You cannot directly count email accounts. You need to call Emails.listingCount()

EmailAccounts.delete

delete email-account entry for given email-address by either id or email-address

Permission

admin customer

Parameter

FieldTypeDescription
idintoptional, the email-address-id
emailaddrstringoptional, the email-address to delete the account for
customeridintoptional, required when called as admin (if $loginname is not specified)
loginnamestringoptional, required when called as admin (if $customerid is not specified)
delete_userfilesbooloptional, default false

Response

string as json-encoded array