FieldsMethodsMember ObjectsIteratorsIterated objects1. Fields
name
| Function name |
Function signature |
| forwarder_name_get |
string forwarder_name_get (object:forwarder obj) |
|
This function returns the name of the forwarder represented by the forwarder object parameter
|
| forwarder_name_set |
int forwarder_name_set (object:forwarder obj, string value) |
|
This function changes the name of the forwarder
|
address_name
| Function name |
Function signature |
| forwarder_address_name_get |
string forwarder_address_name_get (object:forwarder_address obj) |
|
This function retrieves the email address from an forwarder_address object
|
2. Methods
| Function name |
Function signature |
| forwarder_address_add |
int forwarder_address_add (object:forwarder forwarder, string name) |
|
This function adds an email address to which the mails will be forwarded
|
| forwarder_address_remove |
int forwarder_address_remove (object:forwarder forwarder, object:forwarder_address address) |
|
This function removes an email address from this forwarder's list
|
| forwarder_load |
object:forwarder forwarder_load (object:session session, object:context_list context) |
| forwarder_save |
int forwarder_save (object:forwarder data, object:session session) |
|
If the 'value' parameter is 1, this function enables the forwarder, if it is 0, it disables it */
int forwarder_enabled_set(struct forwarder* obj, int value);
/** This function destroys the forwarder object (it does not delete the forwarder from Axigen server)
This function saves the forwarder object configuration into Axigen
|
3. Member Objects
filters
Functions that apply to member object:
| Function name |
Function signature |
| forwarder_filters_get |
object:filters forwarder_filters_get (object:forwarder forwarder, object:session s) |
|
This function returns 1 if the forwarder is enabled and 0 otherwise */
int forwarder_enabled_get(struct forwarder* obj);
/** This function returns a filter object for the forwarder provided as paramter
|
4. Iterators
address
| Function name |
Function signature |
| forwarder_address_iterator_has_value |
int forwarder_address_iterator_has_value (object:forwarder_address_iterator iter) |
|
This function returns 1 if the forwarder iterator can be incremented and 0 otherwise
|
| forwarder_address_iterator_next |
int forwarder_address_iterator_next (object:forwarder_address_iterator iter) |
|
This function increments a forwarder address iterator
|
| forwarder_address_iterator_destroy |
int forwarder_address_iterator_destroy (object:forwarder_address_iterator iter) |
|
This function destroys a forwarder address iterator
|
| forwarder_address_iterator_value |
object:forwarder_address forwarder_address_iterator_value (object:forwarder_address_iterator iter) |
|
This function returns a forwarder_address object from an iterator object. From the forwarder_address object a string representation of the email address can be obtained with the help of the forwarder_address_name_get() function
|
| forwarder_address_iterator_begin |
object:forwarder_address_iterator forwarder_address_iterator_begin (object:forwarder forwarder) |
|
This function returns a forwarder address iterator that can be used at iterating through the list of email address which the forwarder has
|
5. Iterated objects
Object: forwarder_address
Fields
name
| Function name |
Function signature |
| forwarder_address_name_get |
string forwarder_address_name_get (object:forwarder_address obj) |
|
This function retrieves the email address from an forwarder_address object
|
Methods
| Function name |
Function signature |
| forwarder_address_add |
int forwarder_address_add (object:forwarder forwarder, string name) |
|
This function adds an email address to which the mails will be forwarded
|
| forwarder_address_remove |
int forwarder_address_remove (object:forwarder forwarder, object:forwarder_address address) |
|
This function removes an email address from this forwarder's list
|
