Account Context

The commands available for the Account 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

SET commands

• SET [name <name>] – sets the account's name - only usable in an UPDATE operation

• SET [password <password> [respectEnforcement <yes|no>]] – sets password for the account, optionally respecting current enforcement rules

• SET [mustChangePass <yes|no>] – forces the user to change password at the next login

• SET [accountType <basic|premium>] – sets the account type

• SET [twoFactorConfigured <yes|no>] – sets if two factor authentication has been configured

• SET [customerReference <string>] – sets the customer reference for use with external billing like systems

• SET [publishContactInfo <yes|no>] – enables/disables this recipient published in domain contacts

• SET [filteringOption <pass|discard|sendNDR|moveToFilteredEmail|moveToFilteredEmailWithIC>] – sets the filtering option for the account

LIST commands

• LIST Aliases – lists aliases for current account

• LIST Delegates – list delegate permissions for current account

• LIST MEMBERSHIP [noGroups][noLists][sameDomain][directReference] – list groups and/or mailing lists referring to the current account

• LIST Folders – lists folders for current account

• LIST SecurityMethods – list account security methods

CONFIG sub-contexts

• CONFIG WebmailData – enters the webmaildata context

• CONFIG Filters – enters the filters context

• CONFIG Quotas – enters the quota context

• CONFIG Limits – enters the limits context

• CONFIG SendRecvRestrictions – enters the send/recv restrictions context

• CONFIG ContactInfo – enters the contact information context

• CONFIG WebmailAdvertising – enters the webmail advertising context

Alias commands

• ADD Alias <aliasName> – adds an alias for the account

• REMOVE Alias <aliasName> – removes an alias from the account

Delegate commands

• ADD Delegate <delegateName> resource <calendar|tasks|freebusy> permissions r|w|rw – adds a delegate permission for a resource. The delegateName is the local part of an account in the same domain (e.g. user2, not user2@domain.com)

• REMOVE Delegate <delegateName> [resource <calendar|tasks|freebusy>] – remove a delegate permission for a resource, or on all resources if resource is omitted

Security method commands

• ADD securityMethod <sms|email> <target> – adds the corresponding security method

• REVOKE securityMethod <methodId> – revokes the given account security method

• REVOKE all securityMethods – revokes all account security methods

PURGE commands

• PURGE account folders <folderName> [, <folderName>]* [<purgeCondition>] – purge mails from specified folders of the current user

• PURGE calendarMetadata – purge calendar metadata belonging to the current user

• PURGE calendarMetadata folder <folderName> – purge calendar metadata from the specified folder belonging to the current user

• PURGE caldav propertiesForFolder <folderName> – purge caldav properties (such as calendar color, order) for the specified local calendar folder

• PURGE caldav sharedProperties – purge caldav shared properties (such as calendar color, order) for all the shared calendar folders accessible to the user

• PURGE caldav inviteMessages – purge caldav invite messages (purges all the invite notifications received by this user)

RESET commands

• RESET ldapAssociation – resets the ldap associations

• RESET messageMetadata attachments|calendar [allfolders|folder <foldername> [<folderName>]*] – resets part of cached message metadata to force reevaluation of some properties

• RESET folder <folderName> [<folderName>]* – re-creates the folder attempting to keep the messages; in case of a search folder a new search is initiated

• RESET messageConversationIds – forces synchronization of conversation IDs between conversation database and messages database

SHOW commands

• SHOW RegistryInformation – shows registry information

• SHOW SearchIndexInformation [diag] – shows general information about the mail search-index data of the current account

• SHOW SearchIndexInformation [diag] allfolders – shows search-index information for all mail folders containing indexes of the current account

• SHOW SearchIndexInformation [diag] folder <foldername> – shows search-index information for the provided mail folder of the current account

• SHOW CalendarSearchIndexInformation [diag] – shows general information about the calendar search-index data of the current account

• SHOW CalendarSearchIndexInformation [diag] allfolders – shows search-index information for all calendar folders containing indexes of the current account

• SHOW CalendarSearchIndexInformation [diag] folder <foldername> – shows search-index information for the provided calendar folder of the current account

• SHOW ContactSearchIndexInformation [diag] – shows general information about the contact search-index data of the current account

• SHOW ContactSearchIndexInformation [diag] allfolders – shows search-index information for all contact folders containing indexes of the current account

• SHOW ContactSearchIndexInformation [diag] folder <foldername> – shows search-index information for the provided contact folder of the current account

• SHOW SortIndexInformation – shows general information about the sort-index data of the current account

• SHOW SortIndexInformation allfolders – shows sort-index information for all folders containing sort indexes of the current account

• SHOW SortIndexInformation folder <foldername> – shows sort-index information for the provided folder of the current account

• SHOW ConversationIndexInformation [diag] – shows general information about the conversation-index data of the current account

Other commands

• ARCHIVE folder <folderName> older than <days> – archive items older than specified number of days from given folder

• INHERIT SETTINGS FROM domainDefaults – inherit settings from domain defaults (explicit values will not be reset)

• INHERIT SETTINGS FROM accountClass <accountClassName> – inherit settings from specified account class (explicit values will not be reset)

• IMPORTCONTACTS file <file_path> [folder <name>] [duplicatesPolicy <allow|ignore|mergeServerWins|mergeClientWins>] – import contacts from a CSV file, defaults: folder 'Contacts', duplicatesPolicy allow

• REPAIR contacts in folder <folder> remove invalid bday – removes non-ISO8601 bday fields from specified contacts folder

• REPAIR contacts in folder <folder> remove duplicates – removes duplicates from specified contacts folder based on first name, last name, email uniqueness