47. webmail
FieldsMethodsMember ObjectsIteratorsIterated objects1. Fields
max_auth_errors
| Function name |
Function signature |
| webmail_max_auth_errors_set |
int webmail_max_auth_errors_set (object:webmail obj, int value) |
|
This function sets the maximum authentication errors number after which the connection is terminated. Returns 0 on succes, -1 on failure
|
| webmail_max_auth_errors_get |
int webmail_max_auth_errors_get (object:webmail obj) |
|
This function returns the maximum authentication errors number after which the connection is terminated
|
userdb_connector_name
| Function name |
Function signature |
| webmail_userdb_connector_name_get |
string webmail_userdb_connector_name_get (object:webmail obj) |
|
This function returns the userdb connector name
|
| webmail_userdb_connector_name_set |
int webmail_userdb_connector_name_set (object:webmail obj, string value) |
|
This function sets the name of the userdb connector. Returns 0 on succes, -1 on failure
|
show_domain_list
| Function name |
Function signature |
| webmail_show_domain_list_get |
int webmail_show_domain_list_get (object:webmail obj) |
|
This function returns 1 if domain displaying is enabled at user login and 0 otherwise
|
| webmail_show_domain_list_set |
int webmail_show_domain_list_set (object:webmail obj, int value) |
|
If the 'value' parameter is 1, Webmail displays the domains at login, if it is '0' it does not display them
|
http_body_max_size
| Function name |
Function signature |
| webmail_http_body_max_size_get |
int webmail_http_body_max_size_get (object:webmail obj) |
|
This function returs the maximum allowed size for incoming HTTP body
|
| webmail_http_body_max_size_set |
int webmail_http_body_max_size_set (object:webmail obj, int value) |
|
This function sets the maximum allowed size for incoming HTTP body
|
session_idle_timeout
| Function name |
Function signature |
| webmail_session_idle_timeout_set |
int webmail_session_idle_timeout_set (object:webmail 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
|
| webmail_session_idle_timeout_get |
int webmail_session_idle_timeout_get (object:webmail obj) |
|
This function returns idle the time interval (in seconds) after which the session is terminated
|
max_connection_threads
| Function name |
Function signature |
| webmail_max_connection_threads_get |
int webmail_max_connection_threads_get (object:webmail obj) |
|
This function returns the maximum number of threads involved in I/O for this service
|
| webmail_max_connection_threads_set |
int webmail_max_connection_threads_set (object:webmail 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 |
| webmail_session_activity_timeout_get |
int webmail_session_activity_timeout_get (object:webmail obj) |
|
This function returns the maxim living time for the webmail session
|
| webmail_session_activity_timeout_set |
int webmail_session_activity_timeout_set (object:webmail obj, int value) |
|
This function sets the maxim living time for the webmail session. Returns 0 on succes, -1 on failure
|
http_headers_max_size
| Function name |
Function signature |
| webmail_http_headers_max_size_get |
int webmail_http_headers_max_size_get (object:webmail obj) |
|
This function returns the maximum allowed size for received HTTP headers
|
| webmail_http_headers_max_size_set |
int webmail_http_headers_max_size_set (object:webmail obj, int value) |
|
This function sets the maximum allowed size for received HTTP headers
|
max_errors
| Function name |
Function signature |
| webmail_max_errors_get |
int webmail_max_errors_get (object:webmail obj) |
|
This function returns the maximum protocol errors number after which the connection is terminated
|
| webmail_max_errors_set |
int webmail_max_errors_set (object:webmail obj, int value) |
|
This function sets the maximum protocol errors number after which the connection is terminated. Returns 0 on succes, -1 on failure
|
userdb_connector_type
| Function name |
Function signature |
| webmail_userdb_connector_type_get |
string webmail_userdb_connector_type_get (object:webmail obj) |
|
This function returns the userdb connector type. Expected values are: "local", "ldap" or "ldapbind"
|
| webmail_userdb_connector_type_set |
int webmail_userdb_connector_type_set (object:webmail obj, string value) |
|
This function sets the userdb connector type. Valid string values for the 'value' parameter are: "local", "ldap" or "ldapBind"
|
log_host
| Function name |
Function signature |
| webmail_log_host_get |
string webmail_log_host_get (object:webmail obj) |
|
This function returns the host which handles the logging (if the log type is not local)
|
| webmail_log_host_set |
int webmail_log_host_set (object:webmail 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 |
| webmail_upload_max_size_get |
int webmail_upload_max_size_get (object:webmail obj) |
|
This function returns the the maximum allowed size for incoming upload data
|
| webmail_upload_max_size_set |
int webmail_upload_max_size_set (object:webmail obj, int value) |
|
This function sets the the maximum allowed size for incoming upload data
|
log_level
| Function name |
Function signature |
| webmail_log_level_get |
int webmail_log_level_get (object:webmail obj) |
|
This function returns the log level for this service. For more information of service log level, read the Axigen documentation
|
| webmail_log_level_set |
int webmail_log_level_set (object:webmail 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
|
allow_large_incoming_data
| Function name |
Function signature |
| webmail_allow_large_incoming_data_get |
int webmail_allow_large_incoming_data_get (object:webmail obj) |
|
This function returns 1 if data receiving is allowed after the maximum living time is over and 0 otherwise
|
| webmail_allow_large_incoming_data_set |
int webmail_allow_large_incoming_data_set (object:webmail obj, int value) |
|
If the 'value' parameter is 1, Webmail allows data receiving the maximum living time is over, if it is '0', it does not
|
path
| Function name |
Function signature |
| webmail_path_get |
string webmail_path_get (object:webmail obj) |
|
This function returns webmail's directory path
|
| webmail_path_set |
int webmail_path_set (object:webmail obj, string value) |
|
This function sets the directory path towards the Axigen Webmail
|
allow_keep_alive
| Function name |
Function signature |
| webmail_allow_keep_alive_get |
int webmail_allow_keep_alive_get (object:webmail obj) |
|
This funcion returns 1 if persistent (keep-alive) connections are allowed and 0 otherwise
|
| webmail_allow_keep_alive_set |
int webmail_allow_keep_alive_set (object:webmail obj, int value) |
|
If the 'value' parameter is 1, persistent connections are allowed on Webmail, if it is 0, they're not. Returns 0 on succes, -1 on failure
|
min_connection_threads
| Function name |
Function signature |
| webmail_min_connection_threads_get |
int webmail_min_connection_threads_get (object:webmail obj) |
|
This function returns the minimum number of threads involved in I/O for this service
|
| webmail_min_connection_threads_set |
int webmail_min_connection_threads_set (object:webmail 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 |
| webmail_log_type_get |
string webmail_log_type_get (object:webmail obj) |
|
This function returns the log the for this service. Expected values are: "internal", "system" or "remote"
|
| webmail_log_type_set |
int webmail_log_type_set (object:webmail 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 |
| webmail_url_redirect_remove |
int webmail_url_redirect_remove (object:webmail webmail, object:url_redirect ur) |
|
This function removes an existing url redirect from Axigen
|
| webmail_load |
object:webmail webmail_load (object:session session, object:context_list context) |
| webmail_hostname_resolver_add |
object:hostname_resolver webmail_hostname_resolver_add (object:webmail webmail, string host, string domain) |
|
This function adds a hostname resolver. This maps a hostname to a domain
|
| webmail_reset |
int webmail_reset (object:webmail webmail, object:session session) |
|
This function resets the changes made but not yet saved
|
| webmail_hostname_resolver_remove |
int webmail_hostname_resolver_remove (object:webmail webmail, object:hostname_resolver hr) |
|
This function removes a hostname resolver. Returns 0 on succes, -1 on failure
|
| webmail_destroy |
int webmail_destroy (object:webmail webmail) |
|
This function destroys a webmail object
|
| webmail_url_redirect_add |
object:url_redirect webmail_url_redirect_add (object:webmail webmail, string address, int port, string host) |
|
This function adds a url redirect. This can be used to redirect request for a specific host to another address.
|
| webmail_url_redirect_change |
int webmail_url_redirect_change (object:url_redirect ur, string host, int port) |
|
This function changes an existing url redirect, changing its host and port
|
| webmail_save |
int webmail_save (object:webmail serv, object:session session) |
|
This function saves the webmail configuration back to Axigen
|
| webmail_hostname_resolver_change |
int webmail_hostname_resolver_change (object:hostname_resolver hr, string new_domain) |
|
This function modifies an existing hostname resolver, changing its domain
|
3. Member Objects
listeners
Functions that apply to member object:
| Function name |
Function signature |
| webmail_listeners_get |
object:listeners webmail_listeners_get (object:webmail webmail, object:session s) |
|
This function returns a list of webmail listeners
|
4. Iterators
url_redirect
| Function name |
Function signature |
| webmail_url_redirect_iterator_destroy |
int webmail_url_redirect_iterator_destroy (object:webmail_url_redirect_iterator iter) |
|
This function destroys a url_redirect iterator
|
| webmail_url_redirect_iterator_has_value |
int webmail_url_redirect_iterator_has_value (object:webmail_url_redirect_iterator iter) |
|
This function returns 1 if the iterator has NOT reached the end of the url_redirect list and 0 otherwise
|
| webmail_url_redirect_iterator_begin |
object:webmail_url_redirect_iterator webmail_url_redirect_iterator_begin (object:webmail webmail) |
|
This function returns a url_redirect iterator for iterating through the url_redirect list
|
| webmail_url_redirect_iterator_value |
object:url_redirect webmail_url_redirect_iterator_value (object:webmail_url_redirect_iterator iter) |
|
This function returns a url_redirect object corresponding the iterator's position in the list
|
| webmail_url_redirect_iterator_next |
int webmail_url_redirect_iterator_next (object:webmail_url_redirect_iterator iter) |
|
This function increments a url_redirect iterator
|
5. Iterated objects Object: webmail_url_redirect
Methods
| Function name |
Function signature |
| webmail_url_redirect_remove |
int webmail_url_redirect_remove (object:webmail webmail, object:url_redirect ur) |
|
This function removes an existing url redirect from Axigen
|
| webmail_url_redirect_add |
object:url_redirect webmail_url_redirect_add (object:webmail webmail, string address, int port, string host) |
|
This function adds a url redirect. This can be used to redirect request for a specific host to another address.
|
| webmail_url_redirect_change |
int webmail_url_redirect_change (object:url_redirect ur, string host, int port) |
|
This function changes an existing url redirect, changing its host and port
|
|
