23. migration
FieldsMethodsMember Objects1. Fields
user
| Function name |
Function signature |
| migration_user_set |
int migration_user_set (object:migration obj, string value) |
|
This function sets the local Axigen users to which the migration will occur
|
account
| Function name |
Function signature |
| migration_account_set |
int migration_account_set (object:migration obj, string value) |
|
This function sets the remote account to be migrated
|
structure_only
| Function name |
Function signature |
| migration_structure_only_get |
int migration_structure_only_get (object:migration obj) |
|
This function returns 1 if only the folder structure is to be created and 0 otherwise
|
| migration_structure_only_set |
int migration_structure_only_set (object:migration obj, int value) |
|
If the 'value' parameter is 1 only the folder structure is migrated, that is, only the folders are crated, but not emails are retrieved from the remote host
|
domain
| Function name |
Function signature |
| migration_domain_set |
int migration_domain_set (object:migration obj, string value) |
|
This function sets the domain in which the remote account resides
|
port
| Function name |
Function signature |
| migration_port_set |
int migration_port_set (object:migration obj, int value) |
|
This function sets the remote port to connect to
|
override_quota
| Function name |
Function signature |
| migration_override_quota_get |
int migration_override_quota_get (object:migration obj) |
|
This function returs 1 if the user quota can be overriden during the migration process and 0 otherwise
|
| migration_override_quota_set |
int migration_override_quota_set (object:migration obj, int value) |
|
If the 'value' parameter is 1, the quota for the local user can be overriden, if it is 0 it cannot and when the quota is reached, the migration stops
|
host
| Function name |
Function signature |
| migration_host_set |
int migration_host_set (object:migration obj, string value) |
|
This function sets the remote host
|
password
| Function name |
Function signature |
| migration_password_set |
int migration_password_set (object:migration obj, string value) |
|
This function sets the remote account's passowd
|
delete_original
| Function name |
Function signature |
| migration_delete_original_get |
int migration_delete_original_get (object:migration obj) |
|
This function returns 1 if the original emails from the remote host should be deleted, and 0 otherwise
|
| migration_delete_original_set |
int migration_delete_original_set (object:migration obj, int value) |
|
If the 'value' parameter is 1, the original emails from the remote host are deletes when migrating, if it 0, they are are left intact
|
2. Methods
| Function name |
Function signature |
| migration_migrate |
int migration_migrate (object:migration data, object:session s) |
|
This function migrates through imap an account from another mail server to Axigen. For this function to work, all the migration paramters must be setted: the account's domain, the local account name, the remote host and port, the remote user, the remote user's password. Optionally, it can be specified: if the local user's quota should be overriden, if the remote account's emails should be deleted or if only the folders present in the remote account should be created but no emails should be retrieved. Returns 0 on succes, -1 on failure
|
| migration_load |
object:migration migration_load (object:session s, object:context_list context) |
| migration_destroy |
int migration_destroy (object:migration data) |
|
This function destroys a migration object
|
3. Member Objects
limits
Functions that apply to member object:
| Function name |
Function signature |
| maillist_limits_get |
object:limits maillist_limits_get (object:maillist maillist, object:session s) |
|
This function returns a limits object. This object can be used for setting various limit parameters for the maillist
|
quotas
Functions that apply to member object:
| Function name |
Function signature |
| maillist_quotas_get |
object:quotas maillist_quotas_get (object:maillist maillist, object:session s) |
|
This function returns a quotas object. This object can be used for setting storage restrictions on the maillist
|
filters
Functions that apply to member object:
| Function name |
Function signature |
| maillist_filters_get |
object:filters maillist_filters_get (object:maillist maillist, object:session s) |
|
This function returns a filter object. This object is used for applying various filters on the maillist's incoming emails
|
services
Functions that apply to member object:
| Function name |
Function signature |
| maillist_services_get |
object:services maillist_services_get (object:maillist obj) |
|
This function returns a services object. This object can be used to check/enable services
|
registry_information
Functions that apply to member object:
| Function name |
Function signature |
| maillist_registry_information_get |
object:registry_information maillist_registry_information_get (object:maillist maillist, object:session s) |
|
This function returns a registry_information object. This object can be used at retrieving various information about the maillist's login (imap, pop3, webmail)
|
webmaildata
Functions that apply to member object:
| Function name |
Function signature |
| maillist_webmaildata_get |
object:webmaildata maillist_webmaildata_get (object:maillist maillist, object:session s) |
|
This function returns a webmaildata object. This can be used at configuring various webmail options for the maillist's admin
|
|
