Table of Objects

3. connection_data

4. contact_info

8. domain_registration

11. folder_rcpt

15. ldap_connector

22. mapping_data

24. migration_data

28. proxy

29. public_folder

33. registry_information

42. string_list

43. upload_wmfilter

44. url_redirect

48. webmaildata

28. proxy

Fields
Methods
Member Objects

1. Fields

max_auth_errors

Function name	Function signature
proxy_max_auth_errors_get	int proxy_max_auth_errors_get (object:proxy obj)
This function returns the maximum authentication errors number after which the connection is terminated
proxy_max_auth_errors_set	int proxy_max_auth_errors_set (object:proxy obj, int value)
This function sets the maximum authentication errors number after which the connection is terminated. Returns 0 on succes, -1 on failure

userdb_connector_name

Function name	Function signature
proxy_userdb_connector_name_get	string proxy_userdb_connector_name_get (object:proxy obj)
This function returns the userdb connector name
proxy_userdb_connector_name_set	int proxy_userdb_connector_name_set (object:proxy obj, string value)
This function sets the name of the userdb connector. Returns 0 on succes, -1 on failure

max_connection_threads

Function name	Function signature
proxy_max_connection_threads_get	int proxy_max_connection_threads_get (object:proxy obj)
This function returns the maximum number of threads involved in I/O for this service
proxy_max_connection_threads_set	int proxy_max_connection_threads_set (object:proxy obj, int value)
This function sets the maximum number of threads involved in I/O for this service. Returns 0 on succes, -1 on failure

userdb_connector_type

Function name	Function signature
proxy_userdb_connector_type_get	string proxy_userdb_connector_type_get (object:proxy obj)
This function returns the userdb connector type. Expected values are: "local", "ldap" or "ldapbind"
proxy_userdb_connector_type_set	int proxy_userdb_connector_type_set (object:proxy obj, string value)
This function sets the userdb connector type. Valid string values for the 'value' parameter are: "local", "ldap" or "ldapBind"

max_errors

Function name	Function signature
proxy_max_errors_get	int proxy_max_errors_get (object:proxy obj)
This function returns the maximum protocol errors number after which the connection is terminated
proxy_max_errors_set	int proxy_max_errors_set (object:proxy obj, int value)
This function sets the maximum protocol errors number after which the connection is terminated. Returns 0 on succes, -1 on failure

authenticate_on_proxy

Function name	Function signature
proxy_authenticate_on_proxy_get	int proxy_authenticate_on_proxy_get (object:proxy obj)
This function returns 1 if the proxy authentication is also done on proxy and 0 otherwise
proxy_authenticate_on_proxy_set	int proxy_authenticate_on_proxy_set (object:proxy obj, int value)
If the 'value' parameter is 1, the user's authentication is also done through proxy, if it is 0 the authentication is not done on proxy.. Returns 0 on succes, -1 on failure. Please consult the Axigen documentation for more information

log_host

Function name	Function signature
proxy_log_host_get	string proxy_log_host_get (object:proxy obj)
This function returns the host which handles the logging (if the log type is not local)
proxy_log_host_set	int proxy_log_host_set (object:proxy obj, string value)
This function sets the address of the host that offers log services for Axigen. Returns 0 on succes, -1 on failure

allow_start_tls

Function name	Function signature
proxy_allow_start_tls_get	int proxy_allow_start_tls_get (object:proxy obj)
This function returns 1 if the proxy has ssl enabled and 0 otherwise
proxy_allow_start_tls_set	int proxy_allow_start_tls_set (object:proxy obj, int value)
If the 'value' paramter is 1, this function enables secure connections on the proxy, else it disables them. Returns 0 on succes, -1 on failure

log_level

Function name	Function signature
proxy_log_level_get	int proxy_log_level_get (object:proxy obj)
This function returns the log level for this service. For more information of service log level, read the Axigen documentation
proxy_log_level_set	int proxy_log_level_set (object:proxy obj, int value)
This function sets the log level for this service. For more information on service log level, read the Axigen documentation. Returns 0 on succes, -1 on failure

min_connection_threads

Function name	Function signature
proxy_min_connection_threads_get	int proxy_min_connection_threads_get (object:proxy obj)
This function returns the minimum number of threads involved in I/O for this service
proxy_min_connection_threads_set	int proxy_min_connection_threads_set (object:proxy obj, int value)
This function sets the minimum number of threads involved in I/O for this service. Returns 0 on succes, -1 on failure

log_type

Function name	Function signature
proxy_log_type_get	string proxy_log_type_get (object:proxy obj)
This function returns the log the for this service. Expected values are: "internal", "system" or "remote"
proxy_log_type_set	int proxy_log_type_set (object:proxy obj, string value)
This function sets the log type for this service. Valid values for the 'value' parameter are: "internal"(used at logging in a local file), "system"(used at logging in system log) or "remote"(used at logging on a dedicated logging machine)

2. Methods

Function name	Function signature
proxy_load	object:proxy proxy_load (object:session session, object:context_list context)
proxy_save	int proxy_save (object:proxy data, object:session session)
This function saves the webmail configuration back to Axigen
proxy_destroy	int proxy_destroy (object:proxy data)
This function destroys a webmail object

3. Member Objects

connection_data

Functions that apply to member object:

Function name	Function signature
proxy_connection_data_get	object:connection_data proxy_connection_data_get (object:proxy proxy, object:session s)
This function returns the connection data for the proxy. The connection data is used at setting various connections for the proxy connections

listeners

Functions that apply to member object:

Function name	Function signature
proxy_listeners_get	object:listeners proxy_listeners_get (object:proxy proxy, object:session s)
This function returns the listeners list for this proxy

mapping_data

Functions that apply to member object:

Function name	Function signature
proxy_mapping_data_get	object:mapping_data proxy_mapping_data_get (object:proxy proxy, object:session s)
This function returns the mapping data for the proxy. The mapping data is used for configuring Axigen clustering. Please read the Axigen documentation for more information.