FieldsMethodsMember Objects1. Fields
max_auth_errors
| Function name |
Function signature |
| imap_max_auth_errors_get |
int imap_max_auth_errors_get (object:imap obj) |
|
This function returns the maximum authentication errors number after which the connection is terminated
|
| imap_max_auth_errors_set |
int imap_max_auth_errors_set (object:imap obj, int value) |
|
This function sets the maximum authentication errors number after which the connection is terminated
|
userdb_connector_name
| Function name |
Function signature |
| imap_userdb_connector_name_get |
string imap_userdb_connector_name_get (object:imap obj) |
|
This function returns the userdb connector name
|
| imap_userdb_connector_name_set |
int imap_userdb_connector_name_set (object:imap obj, string value) |
|
This function sets the name of the userdb connector
|
max_connection_threads
| Function name |
Function signature |
| imap_max_connection_threads_get |
int imap_max_connection_threads_get (object:imap obj) |
|
This function returns the maximum number of threads involved in I/O for this service
|
| imap_max_connection_threads_set |
int imap_max_connection_threads_set (object:imap obj, int value) |
|
This function sets the maximum number of threads involved in I/O for this service
|
secure_connection_allow_login
| Function name |
Function signature |
| imap_secure_connection_allow_login_get |
int imap_secure_connection_allow_login_get (object:imap obj) |
|
This function returns 1 if plain text authentication is allowed on secure connections and 0 otherwise
|
| imap_secure_connection_allow_login_set |
int imap_secure_connection_allow_login_set (object:imap obj, int value) |
|
If the 'value' parameter is 1 plain authentication of secure connections is allowed for this service, if it is 0 plain auth is not allowed for secure connections.
|
max_errors
| Function name |
Function signature |
| imap_max_errors_get |
int imap_max_errors_get (object:imap obj) |
|
This function returns the maximum protocol errors number after which the connection is terminated
|
| imap_max_errors_set |
int imap_max_errors_set (object:imap obj, int value) |
|
This function sets the maximum protocol errors number after which the connection is terminated
|
userdb_connector_type
| Function name |
Function signature |
| imap_userdb_connector_type_get |
string imap_userdb_connector_type_get (object:imap obj) |
|
This function returns the userdb connector type. Expected values are: "local", "ldap" or "ldapbind"
|
| imap_userdb_connector_type_set |
int imap_userdb_connector_type_set (object:imap obj, string value) |
|
This function sets the userdb connector type. Valid string values for the 'value' parameter are: "local", "ldap" or "ldapBind"
|
plain_connection_auth_types
| Function name |
Function signature |
| imap_plain_connection_auth_types_get |
string imap_plain_connection_auth_types_get (object:imap obj) |
|
This function gets a list of the allowed authentication methods on a plain connection. The returned string can look like this: "(plain login cram-md5 digest-md5 gssapi)"
|
| imap_plain_connection_auth_types_set |
int imap_plain_connection_auth_types_set (object:imap obj, string value) |
|
This function sets the list of the allowed authentication methods on a plain connection. The supplied string parameter must look like this: "(plain login cram-md5 digest-md5 gssapi)"
|
log_host
| Function name |
Function signature |
| imap_log_host_get |
string imap_log_host_get (object:imap obj) |
|
This function returns the host which handles the logging (if the log type is not local)
|
| imap_log_host_set |
int imap_log_host_set (object:imap obj, string value) |
|
This function sets the address of the host that offers log services for Axigen
|
allow_start_tls
| Function name |
Function signature |
| imap_allow_start_tls_get |
int imap_allow_start_tls_get (object:imap obj) |
|
This function returns 1 if the secure connection (which start with STARTTLS) are allowed for this service and 0 otherwise
|
| imap_allow_start_tls_set |
int imap_allow_start_tls_set (object:imap obj, int val) |
|
If the 'value' parameter is 1, secure connections (which start with STARTTLS) are allowed for this service, if it is 0 secure connection are not allowed
|
secure_connection_auth_types
| Function name |
Function signature |
| imap_secure_connection_auth_types_get |
string imap_secure_connection_auth_types_get (object:imap obj) |
|
This function gets a list of the allowed authentication methods on a secure connection. The returned string can look like this: "(plain login cram-md5 digest-md5 gssapi)"
|
| imap_secure_connection_auth_types_set |
int imap_secure_connection_auth_types_set (object:imap obj, string value) |
|
This function sets the list of the allowed authentication methods on a secure connection. The supplied string parameter must look like this: "(plain login cram-md5 digest-md5 gssapi)"
|
log_level
| Function name |
Function signature |
| imap_log_level_set |
int imap_log_level_set (object:imap obj, int val) |
|
This function sets the log level for this service. For more information of service log level, read the Axigen documentation
|
| imap_log_level_get |
int imap_log_level_get (object:imap 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 |
| imap_min_connection_threads_get |
int imap_min_connection_threads_get (object:imap obj) |
|
This function returns the minimum number of threads involved in I/O for this service
|
| imap_min_connection_threads_set |
int imap_min_connection_threads_set (object:imap obj, int value) |
|
This function sets the minimum number of threads involved in I/O for this service
|
log_type
| Function name |
Function signature |
| imap_log_type_get |
string imap_log_type_get (object:imap obj) |
|
This function returns the log the for this service. Expected values are: "internal", "system" or "remote"
|
| imap_log_type_set |
int imap_log_type_set (object:imap 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 |
| imap_load |
object:imap imap_load (object:session session, object:context_list context) |
| imap_destroy |
int imap_destroy (object:imap imap) |
|
This function destroys a imap object
|
| imap_reset |
int imap_reset (object:imap imap, object:session session) |
|
This function resets the changes made but not yet saved
|
| imap_save |
int imap_save (object:imap serv, object:session session) |
|
This function saves the imap configuration back to Axigen
|
3. Member Objects
listeners
Functions that apply to member object:
| Function name |
Function signature |
| imap_listeners_get |
object:listeners imap_listeners_get (object:imap imap, object:session s) |
|
This function returns the listener list of this service
|
