- ListAccounts [ domainName ]
lstacnt [ domainName ]
- Use this command to get the list of all accounts in the domain. The command produces output data - a
dictionary with the keys listing all accounts in the specified (or default) domain.
- domainName : string
- This optional parameter specifies the domain name. If the domain name is not specified, the
command applies to the administrator domain.
- CreateAccount accountName [accountType] [ external ] [settings]
cracnt accountName [accountType] [settings]
- Use this command to create new accounts.
- accountName : string
- This parameter specifies the name for the new account.
The name can contain the @sign followed by the domain name, in this case
the account is created in the specified domain. If the domain name is not specified, the
command applies to the administrator domain.
- accountType : MultiMailbox | TextMailbox | MailDirMailbox
- This optional parameter specifies the type of the account to create. If no account
type is specified a MultiMailbox-type account is created.
- external
- This optional flag tells the system to create an account with an external (visible for legacy mailers) INBOX.
- settings : dictionary
- This optional parameter specifies the initial account settings. Account is created
using the settings specified in the Account Template for the target domain. If the
settings parameter is specified, it is used to modify the Template settings.
This command can be used by a domain administrator only if the domain administrator has
the CanCreateAccounts access right.
If this command is used by a domain administrator, it will use only those account settings
that the domain administrator is allowed to modify.
- RenameAccount oldAccountName into newAccountName
rnacnt oldAccountName into newAccountName
- Use this command to rename accounts.
- oldAccountName : string
- This parameter specifies the name of an existing account. The name can include the domain name (see above).
- newAccountName : string
- This parameter specifies the new account name. The name can include the domain name (see above).
This command can be used by a domain administrator only if the domain administrator has
the CanCreateAccounts access right.
- DeleteAccount oldAccountName
dlacnt oldAccountName
- Use this command to remove accounts.
- oldAccountName : string
- This parameter specifies the name of an existing account. The name can include the domain name (see above).
This command can be used by a domain administrator only if the domain administrator has
the CanCreateAccounts access right.
- GetAccount accountName
gtacnt accountName
- Use this command to get the account settings. The command produces an output - a dictionary
with the account settings.
- accountName : string
- This parameter specifies the name of an existing account. The name can include the domain name (see above).
You can also specify the single asterisk sign (*) instead of an account name.
This will indicate the current authenticated account.
Note: All users can send the GetAccount command for their own accounts.
- UpdateAccount accountName newSettings
updacnt accountName newSettings
- Use this command to update the account settings.
- accountName : string
- This parameter specifies the name of an existing account. The name can include the domain name (see above).
- newSettings : dictionary
- This dictionary is used to update the account settings
dictionary. It does not have to contain all settings data, the omitted settings will be left unmodified.
If a new setting value is specified as the string default, the account setting value is removed,
so the default account setting value will be used.
If this command is used by a domain administrator, it will update only those account settings
that the domain administrator is allowed to modify.
- GetAccountAliases accountName
gtacntals accountName
- Use this command to get the list of account aliases. The command produces an output - an array
with the account alias names.
- accountName : string
- This parameter specifies the name of an existing account. The name can include the domain name (see above).
- SetAccountAliases accountName newAliases
stacntals accountName newAliases
- Use this command to set the account aliases.
- accountName : string
- This parameter specifies the name of an existing account. The name can include the domain name (see above).
- newAliases : array
- This array should contain the account alias name strings. All old account aliases are removed.
This command can be used by a domain administrator only if the domain administrator has
the CanCreateAliases access right.
- GetAccountRules accountName
gtacntrl accountName
- Use this command to get the list of account Rules. The command produces an output - an array
of the Rules specified for the account.
- accountName : string
- This parameter specifies the name of an existing account. The name can include the domain name (see above).
- SetAccountRules accountName newRules
stacntrl accountName newRules
- Use this command to set the account Rules.
- accountName : string
- This parameter specifies the name of an existing account. The name can include the domain name (see above).
- newRules : array
- This array should contain the account Rules. All old account Rules are removed.
This command can be used by a domain administrator only if the domain administrator has
the CanModifyRules access right.
- GetAccountRPOP accountName
- Use this command to get the list of account RPOP records. The command produces an output - an array
of the RPOP records specified for the account.
- accountName : string
- This parameter specifies the name of an existing account. The name can include the domain name (see above).
- SetAccountRPOP accountName newRecords
- Use this command to set the account RPOP records.
- accountName : string
- This parameter specifies the name of an existing account. The name can include the domain name (see above).
- newRecords : array
- This array should contain the account RPOP records. All old account RPOP records are removed.
This command can be used by a domain administrator only if the domain administrator has
the CanModifyRPOP access right.
- GetAccountRights accountName
gtacntrghtaccountName
- Use this command to get the array of the Server or Domain access rights granted to the specified user.
The command produces output data - an array listing all account Server Access rights.
- accountName : string
- This parameter specifies the name of an existing account. The name can include the domain name.
- GetAccountInfo accountName Key keyName
gtacntinf accountName Key keyName
- Use this command to get an element of the account "info" dictionary.
The command produces an output - the content of the "info" element retrieved.
If the element is not found, the output is an empty string - two quotation marks ("").
- accountName : string
- This parameter specifies the name of an existing account. The name can include the domain name (see above).
You can also specify the single asterisk sign (*) instead of an account name.
This will indicate the current authenticated account.
- keyName : string
- This parameter specifies the name of the requested "info" element. Note that when
accounts "info" data are stored in .info dictionary files, the "info" elements
have dictionary names starting with the hash sign. You should NOT include the hash sign
into the keyName parameter of the GetAccountInfo command.
Sample:- GetAccountInfo "user1@domain1.com" Key LastLogin
Note: the "info" element names are case-sensitive.
Note: All users can use the GetAccountInfo command to retrieve elements from
their own account "info" data.
- GetWebUser accountName
gtwusr accountName
- Use this command to get the account WebUser Settings. The command produces an output - a dictionary
with all user (account) WebUser Settings.
- accountName : string
- This parameter specifies the name of an existing account. The name can include the domain name (see above).
- SetWebUser accountName newSettings
stwusr accountName newSettings
- Use this command to set the account WebUser Settings.
- accountName : string
- This parameter specifies the name of an existing account. The name can include the domain name (see above).
- newSettings : dictionary
- This dictionary should contain the new account WebUser Settings. All old account WebUser Settings are removed.
- LISTMAILBOXES accountName [ FILTER filter] [ AUTH authaccountname]
lstmbx accountName [ FILTER filter] [ AUTH authaccountname]
- Use this command to get the list of account mailboxes. The command produces an output - a dictionary
where each key specifies a mailbox name, and the key value contains mailbox attributes.
- accountName : string
- This parameter specifies the name of an existing account. The asterisk sign (*) can be used to specify the
current authenticated account.
- filter : string
- This optional parameter specifies the filter string to apply to account mailboxes. The filter
can use the same wildcard symbols "*" and "%" as the IMAP LIST command. If the filter is not specified,
the filter string "*" is assumed, and all account mailboxes are returned.
- authaccountname : string
- This optional parameter specifies the name of an account on whose behalf the LIST operation
should be executed. If this name is specified, the output includes only those mailboxes for which the
specified account has the "Lookup" mailbox access right.