FieldsMethodsMember ObjectsIteratorsIterated objects1. Fields
name
| Function name |
Function signature |
| account_name_get |
string account_name_get (object:account obj) |
|
This function returns the account name
|
| account_name_set |
int account_name_set (object:account obj, string value) |
|
This function sets the name for the supplied account
|
sender_not_in_address_book_action
| Function name |
Function signature |
| account_sender_not_in_address_book_action_get |
string account_sender_not_in_address_book_action_get (object:account obj) |
| account_sender_not_in_address_book_action_set |
int account_sender_not_in_address_book_action_set (object:account obj, string value) |
alias_name
| Function name |
Function signature |
| account_alias_name_get |
string account_alias_name_get (object:account_alias obj) |
|
This function returns the name of an account alias
|
password
| Function name |
Function signature |
| account_password_get |
string account_password_get (object:account obj) |
|
This function is useless, the passwords cannot be seen, it will return a string like "******"
|
| account_password_set |
int account_password_set (object:account obj, string value) |
|
This function sets the password for the supplied account
|
2. Methods
| Function name |
Function signature |
| account_alias_add |
int account_alias_add (object:account account, string name) |
|
This functions adds an account alias
|
| account_load |
object:account account_load (object:session session, object:context_list context) |
| account_upload_wmfilter |
int account_upload_wmfilter (object:account, object:session, string file) |
|
This function uploads a sieve filter to the Axigen account supplied as a parameter. Sieve filters are small scripts used at performing various operations like out-of-office messages or mail filtering. The file parameter is the valid path for the script file.
|
| account_alias_remove |
int account_alias_remove (object:account account, object:account_alias alias) |
|
This function removes an account alias
|
| account_destroy |
int account_destroy (object:account account) |
|
This function destroys the account object
|
| account_save |
int account_save (object:account data, object:session session) |
|
This function saves the changes made to an account back to Axigen server
|
3. Member Objects
limits
Functions that apply to member object:
| Function name |
Function signature |
| account_limits_get |
object:limits account_limits_get (object:account account, object:session s) |
|
This function returns a limits object which contains the restrictions (like pop3 max connection count) for the supplied account. The limits object can also be used at setting these restrictions.
|
quotas
Functions that apply to member object:
| Function name |
Function signature |
| account_quotas_get |
object:quotas account_quotas_get (object:account account, object:session s) |
|
This function returns a quotas object for the supplied account. The quotas object imposes storage limitations on an account. Properties like total message count can be obtained or setted.
|
filters
Functions that apply to member object:
| Function name |
Function signature |
| account_filters_get |
object:filters account_filters_get (object:account account, object:session s) |
|
This function returns a filter object for the supplied account
|
contact_info
Functions that apply to member object:
| Function name |
Function signature |
| account_contact_info_get |
object:contact_info account_contact_info_get (object:account account, object:session s) |
|
This function returns a contact info object containing various informations about the user like phones, addresses, etc.
|
services
Functions that apply to member object:
| Function name |
Function signature |
| account_services_get |
object:services account_services_get (object:account obj) |
|
This function returns a services object representing the the available services for the supplied account
|
webmaildata
Functions that apply to member object:
| Function name |
Function signature |
| account_webmaildata_get |
object:webmaildata account_webmaildata_get (object:account account, object:session s) |
|
This function returns a webmaildata object for a supplied account used at configuring various settings in Axigen webmailfor the specified account
|
4. Iterators
alias
| Function name |
Function signature |
| account_alias_iterator_begin |
object:account_alias_iterator account_alias_iterator_begin (object:account account) |
|
This function returns an account alias iterator used at iterating through a list of account aliases
|
| account_alias_iterator_next |
int account_alias_iterator_next (object:account_alias_iterator iter) |
|
This function increments an account alias iterator
|
| account_alias_iterator_value |
object:account_alias account_alias_iterator_value (object:account_alias_iterator iter) |
|
This function returns an account_alias object corresponding the position of the iterator in the account alias list
|
| account_alias_iterator_destroy |
int account_alias_iterator_destroy (object:account_alias_iterator iter) |
|
This function destroys the account_alias_iterator object
|
| account_alias_iterator_has_value |
int account_alias_iterator_has_value (object:account_alias_iterator iter) |
|
This function returs 1 if the account alias iterator can be incremented (has a value) and 0 otherwise
|
5. Iterated objects
Object: account_alias
Fields
name
| Function name |
Function signature |
| account_alias_name_get |
string account_alias_name_get (object:account_alias obj) |
|
This function returns the name of an account alias
|
Methods
| Function name |
Function signature |
| account_alias_add |
int account_alias_add (object:account account, string name) |
|
This functions adds an account alias
|
| account_alias_remove |
int account_alias_remove (object:account account, object:account_alias alias) |
|
This function removes an account alias
|
