FieldsMethodsMember Objects
1. Fields
username
| Function name |
Function signature |
| session_username_get |
string session_username_get (object:session) |
| Closes up the connection and frees the connection object */ void session_close(struct session*); /** A function that returns the logged username |
timeout
| Function name |
Function signature |
| session_timeout_set |
int session_timeout_set (object:session s, int timeout) |
| This function return the socket read/write timeout in milliseconds */ int session_timeout_get(struct session* s); /** This function sets the connection read/write timeout in milliseconds |
2. Methods
| Function name |
Function signature |
| session_register_domain |
object:domain_registration session_register_domain (object:session s, string path) |
| This function registers a domain from the Axigen server. |
| session_unregister_domain |
int session_unregister_domain(struct session* s, const char* name) |
| This function unregisters a domain from the Axigen server. |
| session_context_ensure |
int session_context_ensure (object:session, object:context_list) |
| session_context_finalize |
int session_context_finalize (object:session, object:context_list, int) |
| session_list_domains |
object:domain_list session_list_domains (object:session s, string filter) |
| This function saves the current Axigen configuration into it's configuration file */ int session_save_config(struct session*); struct domain_list; /** This function returns a domain_list object, a string list of domains which match the supplied filter (ex: filter = "mydomains*" |
| session_update_domain |
object:domain session_update_domain (object:session s, string name) |
| This function creates a domain into the Axigen mail server. The name of the domain, it's path and the domain postmaster's password must be supplied */ struct domain_registration* session_create_domain(struct session* s, const char* name, const char* path, const char* postmaster_passwd); /** This function returns a domain object. This object contains properties of the domain and can be used to perform various operations on the domain |
| session_open_timeout |
object:session session_open_timeout (string ip, int port, string username, string password, int timeout) |
| Function that opens up a cli connection to a axigen server and makes a login request */ struct session* session_open(const char* ip, int port, const char* username, const char* password); /** Function that opens up a cli connection to a axigen server and makes a login request, also the read/write socket timeout * can be specified (in milliseconds) |
3. Member Objects
connection
Functions that apply to member object:
| Function name |
Function signature |
| session_connection_get |
object:tcp_connection session_connection_get (object:session) |
imap_migration
Functions that apply to member object:
| Function name |
Function signature |
| session_imap_migration_get |
object:migration session_imap_migration_get (object:session s) |
| This function returns a server object used in performing various server configurations */ struct server* session_config_server(struct session* s); /** This function returns a migration_data object used in migrating from another mailserver to Axigen |
context
Functions that apply to member object:
| Function name |
Function signature |
| session_context_get |
object:context_list session_context_get (object:session) |
current_context
Functions that apply to member object:
| Function name |
Function signature |
| session_current_context_get |
object:context_list session_current_context_get (object:session) |
