Domain context | Axigen Documentation

When creating domains, one message storage location with the default 32GB size is recommended for each predicted 20GB of message occupied storage space. For larger spaces, additional message storage locations should be created or the default parameters modified in order to increase total average size for the location to correspond to the number of 20GB storages you need. It is recommended that the occupied space is 2/3 out of the storage location size.

You can add multiple message storage locations using CLI only within the domain creation context. After creating the domain, additional locations cannot be added. The command to create multiple message storage locations is the following:

The commands available for the Domain context are:

EXIT/QUIT - exits CLI and closes connection to Axigen
HELP - prints this help message
BACK - cancels any changes made and switches back to the previous context
COMMIT - commits the changes made in this context
SHOW [ATTR <param>] - shows information about this context
LIST Aliases - lists aliases for current domain
LIST Accounts [wildcard (ex: account*)] - lists accounts for current domain
LIST Groups [wildcard (ex: account*)] - lists groups for current domain
LIST FolderRcpts [wildcard (ex: account*)] - lists folder recipients for current domain
LIST Lists [wildcard (ex: account*)] - lists mail lists for current domain
LIST AccountClasses [wildcard (ex: account*)] - lists account classes for current domain
SHOW RegistryInformation - shows registry information
SHOW StorageInformation [details] - shows storage files information (with details per file if option present)
SHOW StorageStatistics [details][average] - shows total or average storage statistics (with details per file if option present)
SHOW DisposableMetadataInformation - shows information about the size occupied by disposable meta-data in the storage
PURGE disposableMetadata searchIndexes | sortIndexes | normalizedMessages
SET [name <name>] - sets the domain's name - only usable in an UPDATE operation
SET [assignedIp <ip>] - sets the assigned ip
SET [services (list of services)] - sets the services for this domain
SET [showWebmailLogin <yes|no>] - enables/disables displaying this domain at WebMail login
SET [createUsersFromLdap <yes|no>] - enables/disables auto-creation of users authenticated from LDAP
SET [publishRcptContacts <yes|no>] - switch indicating if domain recipients contacts are published
SET [enableAppender <yes|no>] - enables/disables the message appender
SET [catchAllType <type>] - sets the type of Catch-All behaviour
SET [catchAllAccountName <value>] - sets the name of the account used to store all messages with unknown recipient
SET [catchAllFolderName <value>] - sets the name of the folder used to store all messages with unknown recipient
SET [enableLDAPSync <yes - enables/disables LDAP-Axigen synchronization
SET [ldapSyncConnectorName <name>] - sets the name of the LDAP connector to use
SET [customerReference <string>] - sets the customer reference for use with external billing like systems
SET [defaultTimezone <timezone>] - sets the default timezone
SET [defaultLanguage <lang>] - sets the default language
SET [disposableMetadataQuotaThreshold <no.>] - sets the disposable meta-data quota threshold
ESET appenderText - this text will be appended to all messages sent from this domain
CONFIG MIGRATIONDATA - enters the migrationdata context
CONFIG FILTERS - enters the domain filters context
CONFIG adminLimits - enters the admin limits context
CONFIG accountDefaultFilters - enters the account default filters context
CONFIG accountDefaultLimits - enters the account default limits context
CONFIG accountDefaultQuotas - enters the account default quotas context
CONFIG accountDefaultSendRecvRestrictions - enters the account default send/recv restrictions context
CONFIG accountDefaultWebmailAdvertising - enters the account default WebMail advertising context
CONFIG PUBLIC-FOLDER - enters the Public Folders context
CONFIG PERMISSIONS - enters the Permissions context
ADD Account [name] <name> password <password> - adds an account to the domain (changes context)
UPDATE Account [name] <name> - updates an account from the domain (changes context)
REMOVE Account [name] <name> - removes an account from the domain
SHOW Account [name] <name> [ATTR <param>] - shows the given account
ADD Group [name] <name> - adds a group to the domain (changes context)
UPDATE Group [name] <name> - updates a group from the domain (changes context)
REMOVE Group [name] <name> - removes a group from the domain
SHOW Group [name] <name> [ATTR <param>] - shows the given group
ADD FolderRcpt [name] <name> - adds a folder recipient to the domain (changes context)
UPDATE FolderRcpt [name] <name> - updates a folder recipient from the domain (changes context)
REMOVE FolderRcpt [name] <name> - removes a folder recipient from the domain
SHOW FolderRcpt [name] <name> [ATTR <param>] - shows the given folder recipient
ADD List [name] <listName> password <password> adminEmail <email> - adds a list to this domain (changes context)
UPDATE List [name] <listName> - updates a list from this domain (changes context)
REMOVE List [name] <listName> - removes a list from this domain
SHOW List [name] <listName> [ATTR <param>] - shows the given list
ADD Alias <aliasName> - adds an alias for the domain
REMOVE Alias <aliasName> - removes an alias from the domain
ADD accountClass [name] <accountClassName> - adds an account class for the domain (changes context)
UPDATE accountClass [name] <accountClassName> - updates an account class from the domain (changes context)
REMOVE accountClass [name] <accountClassName> - removes an account class from the domain
MIGRATE - migrate command which has the following parameters:
- account <accountName> - the account name for migration
- remoteHost <host> - the host of the migration server
- remotePort <port> - the port of the migration server
- remoteUser <imap-user> - the imap username of the migration server
- remotePass <imap-pass> - the imap password of the migration server
- [ignoreFolders (folders)] - specifies a list of folders as displayed by LIST separated by spaces which will not be migrated
- [overrideQuota <yes - specifies if the mailbox quota should be overridden (default: no)
- [deleteOriginal <yes - enables/disables deletion of all migrated messages on the remote server (default: no)
- [structureOnly <yes - enables migration of only the directory structure (default: no)
- [verbose <yes - specifies if the command should be verbose (default: no)

The MIGRATE command, when the parameter "overrideQuota" is set to its "no" default, will migrate mails until the mailbox Quota is reached. If overrideQuota is set to yes, all the mails will be migrated but the mailbox Quota could be exceeded, in which case, the account will no longer receive any more mails.

LIST Storages - lists all storages registered to Axigen
COMPACT All [forced] - compacts all storages registered to Axigen
COMPACT Storage usid <storage_usid> [forced] - compacts a storage from the list
ENABLE StorageStatistics - enables I/O statistics for all storages in domain
DISABLE StorageStatistics - disables I/O statistics for all storages in domain
UPGRADE Storage - upgrades storage representation of configuration data and folders to current version
REPAIR Accounts <accountName> [<accountName>...] - tries to recover lost accounts
SYNCCONTACTS - synchronizes Domain Contacts folder with domain's objects contact information
FINDINVALIDMSG <accountName> [<accountName>...] [purge] - lists and optionally removes faulty messages from specified accounts