Table of Objects

3. connection_data

4. contact_info

8. domain_registration

11. folder_rcpt

15. ldap_connector

22. mapping_data

24. migration_data

29. public_folder

33. registry_information

42. string_list

43. upload_wmfilter

44. url_redirect

46. webadmin

48. webmaildata

46. webadmin

Fields
Methods
Member Objects
Iterators
Iterated objects

1. Fields

max_auth_errors

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

session_idle_timeout

Function name	Function signature
webadmin_session_idle_timeout_get	int webadmin_session_idle_timeout_get (object:webadmin obj)
This function returns idle the time interval (in seconds) after which the session is terminated
webadmin_session_idle_timeout_set	int webadmin_session_idle_timeout_set (object:webadmin obj, int value)
This function sets idle the time interval (in seconds) after which the session is terminated. Returns 0 on succes, -1 on failure. Returns 0 on succes, -1 on failure

http_body_max_size

Function name	Function signature
webadmin_http_body_max_size_get	int webadmin_http_body_max_size_get (object:webadmin obj)
This function returs the maximum allowed size for incoming HTTP body
webadmin_http_body_max_size_set	int webadmin_http_body_max_size_set (object:webadmin obj, int value)
This function sets the maximum allowed size for incoming HTTP body

max_connection_threads

Function name	Function signature
webadmin_max_connection_threads_get	int webadmin_max_connection_threads_get (object:webadmin obj)
This function returns the maximum number of threads involved in I/O for this service
webadmin_max_connection_threads_set	int webadmin_max_connection_threads_set (object:webadmin 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

session_activity_timeout

Function name	Function signature
webadmin_session_activity_timeout_set	int webadmin_session_activity_timeout_set (object:webadmin obj, int value)
This function sets the maxim living time for the webadmin session. Returns 0 on succes, -1 on failure
webadmin_session_activity_timeout_get	int webadmin_session_activity_timeout_get (object:webadmin obj)
This function returns the maxim living time for the webadmin session

http_headers_max_size

Function name	Function signature
webadmin_http_headers_max_size_set	int webadmin_http_headers_max_size_set (object:webadmin obj, int value)
This function sets the maximum allowed size for received HTTP headers
webadmin_http_headers_max_size_get	int webadmin_http_headers_max_size_get (object:webadmin obj)
This function returns the maximum allowed size for received HTTP headers

max_errors

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

log_host

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

upload_max_size

Function name	Function signature
webadmin_upload_max_size_get	int webadmin_upload_max_size_get (object:webadmin obj)
This function returns the the maximum allowed size for incoming upload data
webadmin_upload_max_size_set	int webadmin_upload_max_size_set (object:webadmin obj, int value)
This function sets the the maximum allowed size for incoming upload data

allow_keep_alive

Function name	Function signature
webadmin_allow_keep_alive_get	int webadmin_allow_keep_alive_get (object:webadmin obj)
This funcion returns 1 if persistent (keep-alive) connections are allowed and 0 otherwise
webadmin_allow_keep_alive_set	int webadmin_allow_keep_alive_set (object:webadmin obj, int value)
If the 'value' parameter is 1, persistent connections are allowed on webadmin, if it is 0, they're not. Returns 0 on succes, -1 on failure

allow_large_incoming_data

Function name	Function signature
webadmin_allow_large_incoming_data_set	int webadmin_allow_large_incoming_data_set (object:webadmin obj, int value)
If the 'value' parameter is 1, webadmin allows data receiving the maximum living time is over, if it is '0', it does not
webadmin_allow_large_incoming_data_get	int webadmin_allow_large_incoming_data_get (object:webadmin obj)
This function returns 1 if data receiving is allowed after the maximum living time is over and 0 otherwise

path

Function name	Function signature
webadmin_path_get	string webadmin_path_get (object:webadmin obj)
This function returns webadmin's directory path
webadmin_path_set	int webadmin_path_set (object:webadmin obj, string value)
This function sets the directory path towards the Axigen webadmin

log_level

Function name	Function signature
webadmin_log_level_set	int webadmin_log_level_set (object:webadmin obj, int val)
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
webadmin_log_level_get	int webadmin_log_level_get (object:webadmin obj)
This function returns the log level for this service. For more information of service log level, read the Axigen documentation

min_connection_threads

Function name	Function signature
webadmin_min_connection_threads_get	int webadmin_min_connection_threads_get (object:webadmin obj)
This function returns the minimum number of threads involved in I/O for this service
webadmin_min_connection_threads_set	int webadmin_min_connection_threads_set (object:webadmin 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
webadmin_log_type_get	string webadmin_log_type_get (object:webadmin obj)
This function returns the log the for this service. Expected values are: "internal", "system" or "remote"
webadmin_log_type_set	int webadmin_log_type_set (object:webadmin 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
webadmin_destroy	int webadmin_destroy (object:webadmin webadmin)
This function destroys a webadmin object
webadmin_url_redirect_add	object:url_redirect webadmin_url_redirect_add (object:webadmin webadmin, string address, int port, string host)
This function returns the address to which the http request is redirected
webadmin_save	int webadmin_save (object:webadmin serv, object:session session)
This function saves the webadmin configuration back to Axigen
webadmin_url_redirect_remove	int webadmin_url_redirect_remove (object:webadmin webadmin, object:url_redirect ur)
This function removes an existing url redirect from Axigen
webadmin_reset	int webadmin_reset (object:webadmin webadmin, object:session session)
This function resets the changes made but not yet saved
webadmin_url_redirect_change	int webadmin_url_redirect_change (object:url_redirect ur, string host, int port)
This function changes an existing url redirect, changing its host and port
webadmin_load	object:webadmin webadmin_load (object:session session, object:context_list context)

3. Member Objects

listeners

Functions that apply to member object:

Function name	Function signature
webadmin_listeners_get	object:listeners webadmin_listeners_get (object:webadmin webadmin, object:session s)
This function returns a list of webadmin listeners

4. Iterators

url_redirect

Function name	Function signature
webadmin_url_redirect_iterator_begin	object:webadmin_url_redirect_iterator webadmin_url_redirect_iterator_begin (object:webadmin webadmin)
This function returns a url_redirect iterator for iterating through the url_redirect list
webadmin_url_redirect_iterator_value	object:url_redirect webadmin_url_redirect_iterator_value (object:webadmin_url_redirect_iterator iter)
This function returns a url_redirect object corresponding the iterator's position in the list
webadmin_url_redirect_iterator_destroy	int webadmin_url_redirect_iterator_destroy (object:webadmin_url_redirect_iterator iter)
This function destroys a url_redirect iterator
webadmin_url_redirect_iterator_next	int webadmin_url_redirect_iterator_next (object:webadmin_url_redirect_iterator iter)
This function increments a url_redirect iterator
webadmin_url_redirect_iterator_has_value	int webadmin_url_redirect_iterator_has_value (object:webadmin_url_redirect_iterator iter)
This function returns 1 if the iterator has NOT reached the end of the url_redirect list and 0 otherwise

5. Iterated objects

Object: webadmin_url_redirect

Methods

Function name	Function signature
webadmin_url_redirect_add	object:url_redirect webadmin_url_redirect_add (object:webadmin webadmin, string address, int port, string host)
This function returns the address to which the http request is redirected
webadmin_url_redirect_remove	int webadmin_url_redirect_remove (object:webadmin webadmin, object:url_redirect ur)
This function removes an existing url redirect from Axigen
webadmin_url_redirect_change	int webadmin_url_redirect_change (object:url_redirect ur, string host, int port)
This function changes an existing url redirect, changing its host and port