Methods
Member Objects
Iterators
Iterated objects
1. Fields
name
| Function name | Function signature |
|---|---|
| domain_name_get | string domain_name_get (object:domain) |
| This function gets the name the Axigen domain represented by the domain object | |
| domain_name_set | int domain_name_set (object:domain domain, string value) |
| This function changes the domain name | |
assigned_ip
| Function name | Function signature |
|---|---|
| domain_assigned_ip_get | string domain_assigned_ip_get (object:domain domain) |
| This function obtains the assigned ip for this domain | |
| domain_assigned_ip_set | int domain_assigned_ip_set (object:domain domain, string value) |
| This function assignes an ip for this domain | |
appender_text
| Function name | Function signature |
|---|---|
| domain_appender_text_get | string domain_appender_text_get (object:domain domain) |
| This function retrieves the text that will be appended to each email sent by a user from this domain | |
| domain_appender_text_set | int domain_appender_text_set (object:domain domain, string value) |
| This function sets the text that will be appended to each email sent by a user from this domain | |
2. Methods
| Function name | Function signature |
|---|---|
| domain_update_account | object:account domain_update_account (object:domain dom, object:session session, string account_name) |
| This function returns an account object for an account present in the domain | |
| domain_alias_value | string domain_alias_value (object:domain_alias_iterator iter) |
| Returns the name of the domain alias for the domain_alias object | |
| domain_remove_forwarder | int domain_remove_forwarder (object:domain dom , object:session session, string forwarder_name) |
| This function removes a forwarder from the specified domain | |
| domain_load | object:domain domain_load (object:session, object:context_list) |
| This function destroys a domain object | |
| domain_update_forwarder | object:forwarder domain_update_forwarder (object:domain dom, object:session session, string fwd_name) |
| This function obtains an forwarder object for an existing Axigen forwarder | |
| domain_save | int domain_save (object:domain, object:session) |
| This function saves a Axigen domain | |
| domain_add_folder_rcpt | object:folder_rcpt domain_add_folder_rcpt (object:domain dom, object:session session, string frcpt_name) |
| This function creates a new folderrcpt within the Axigen domain. A folder recipient binds a name (like folder_rcpt_name@mydomain) to a folder. The emails received on the respective address will be stored in the folder. This is usefull for public-folders. | |
| domain_add_forwarder | object:forwarder domain_add_forwarder (object:domain dom, object:session session, string fwd_name) |
| This function adds a forwarder into the domain | |
| domain_add_maillist | object:maillist domain_add_maillist (object:domain dom, object:session session, string maillist_name, string passwd, string adminEmail) |
| This function creates a maillist within the Axigen domain | |
| domain_update_folder_rcpt | object:folder_rcpt domain_update_folder_rcpt (object:domain dom, object:session session, string frcpt_name) |
| This function obtains an object for an existing folderrcpt | |
| domain_update_maillist | object:maillist domain_update_maillist (object:domain dom, object:session session, string maillist_name) |
| This function obtains a maillist object for an existing maillist | |
| domain_remove_account | int domain_remove_account (object:domain dom , object:session session, string account_name) |
| This function removes an account from the specified domain | |
| domain_add_account | object:account domain_add_account (object:domain dom, object:session session, string account_name, stringpasswd) |
| This function adds an account in the specified domain | |
| domain_remove_maillist | int domain_remove_maillist (object:domain dom , object:session session, string maillist_name) |
| This function removes a maillist from the specified domain | |
| domain_remove_folder_rcpt | int domain_remove_folder_rcpt (object:domain dom , object:session session, string folder_rcpt_name) |
| This function removes a folder rcpt from the specified domain | |
3. Member Objects
registration
Functions that apply to member object:| Function name | Function signature |
|---|---|
| domain_registration_get | object:domain_registration domain_registration_get (object:domain domain, object:session sesion) |
| This function returns a domain registration object | |
filters
Functions that apply to member object:| Function name | Function signature |
|---|---|
| domain_filters_get | object:filters domain_filters_get (object:domain domain, object:session session) |
| This function returns the migration_data object for a Axigen domains. With the help of this object, accounts can be migrated from other servers into Axigen */ struct migration_data* domain_migration_data_get(struct domain* dom, struct session* session); /** This function returns the filters object for the specified domain | |
services
Functions that apply to member object:| Function name | Function signature |
|---|---|
| domain_services_get | object:services domain_services_get (object:domain domain) |
| This function returns a services object used at enabling/disabling Axigen services like POP3, IMAP | |
spe
Functions that apply to member object:| Function name | Function signature |
|---|---|
| domain_spe_get | object:spe domain_spe_get (object:domain dom, object:session session) |
| This function returns a secure-password-enforcement object for the specified domain | |
public_folders
Functions that apply to member object:| Function name | Function signature |
|---|---|
| domain_public_folders_get | object:public_folders domain_public_folders_get (object:domain dom, object:session session) |
| This function returns a public-folders object for the specified domain. This object can be used to add/delete public folders and to impose quotas on them. | |
4. Iterators
alias
| Function name | Function signature |
|---|---|
| domain_alias_iterator_next | int domain_alias_iterator_next (object:domain_alias_iterator iter) |
| This function increments the domain alias iterator, returns 1 on succes and 0 on failure | |
| domain_alias_iterator_begin | object:domain_alias_iterator domain_alias_iterator_begin (object:domain domain) |
| This function obtains an iterator at the list of aliases for the specified domain | |
| domain_alias_iterator_destroy | int domain_alias_iterator_destroy (object:domain_alias_iterator iter) |
| This function distroys domain alias itearator | |
| domain_alias_iterator_has_value | int domain_alias_iterator_has_value (object:domain_alias_iterator iter) |
| This function returns 1 if the iterator can be incremented and 0 otherwise | |
| domain_alias_iterator_value | object:domain_alias domain_alias_iterator_value (object:domain_alias_iterator iter) |
| This function returns a domain alias object coresponding the current value of the iterator | |
5. Iterated objects
Object: domain_alias
Methods
| Function name | Function signature |
|---|---|
| domain_alias_value | string domain_alias_value (object:domain_alias_iterator iter) |
| Returns the name of the domain alias for the domain_alias object | |