ATTENTION

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

EmailForwarders

EmailForwarders.add

add new email-forwarder 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 add the forwarder for
customeridintoptional, required when called as admin (if $loginname is not specified)
loginnamestringoptional, required when called as admin (if $customerid is not specified)
destinationstringemail-address to add as forwarder

Response

string as json-encoded array

EmailForwarders.get

You cannot directly get an email forwarder. Try EmailForwarders.listing()

EmailForwarders.update

You cannot update an email forwarder. You need to delete the entry and create a new one.

EmailForwarders.listing

List email forwarders for a given email address

Permission

admin,customer

Parameter

FieldTypeDescription
idintoptional, the email-address-id
emailaddrstringoptional, the email-address to delete the forwarder from
customeridintoptional, admin-only, the customer-id
loginnamestringoptional, admin-only, the loginname

Response

string as json-encoded array count|list

EmailForwarders.listingCount

count email forwarders for a given email address

Permission

admin,customer

Parameter

FieldTypeDescription
idintoptional, the email-address-id
emailaddrstringoptional, the email-address to delete the forwarder from
customeridintoptional, admin-only, the customer-id
loginnamestringoptional, admin-only, the loginname

Response

string as json-encoded response message

EmailForwarders.delete

delete email-forwarder entry for given email-address by either id or email-address and forwarder-id

Permission

admin,customer

Parameter

FieldTypeDescription
idintoptional, the email-address-id
emailaddrstringoptional, the email-address to delete the forwarder from
customeridintoptional, required when called as admin (if $loginname is not specified)
loginnamestringoptional, required when called as admin (if $customerid is not specified)
forwarderidintid of the forwarder to delete

Response

string as json-encoded array