3.4.1. Purpose
The majority of tasks related to administration of mail accounts can be handled by the mail.exe utility. The following tasks can be performed with its help: creation/update/removal of mail names, setup of preferences for mailboxes, redirects and mail groups. Autoresponder settings can also be controlled with this utility.
3.4.2. Usage
Usage: mail.exe command <mail_name> [options]
Available commands and options:
| Command | Parameter | Action |
|---|---|---|
| --create or -c | <mail_name>@<domain> | creates a mail account |
| --update or -u | <mail_name>@<domain> | updates mail account parameters |
| --remove or -r | <mail_name>@<domain> | removes a mail account |
| --on | <domain> | enables mail service for a domain |
| --off | <domain> | disables mail service for a domain |
| --info or -i | <mail_name>@<domain> | retrieves mail account information |
| --help or -h | displays help on the utility usage | |
| Option | Parameter | Note |
| -cp_access | <true|false> | enables control panel access |
| -mailbox | <true|false> | creates/removes a mailbox |
| -passwd | <passwd> | sets a mailbox password |
| -boxpass | <passwd> | an obsolete alias for the "passwd" option (this option may be removed from future releases) |
| -passwd_type | <plain|crypt> | specifies the type of the mailbox password; ignored if no password is specified |
| -mbox_quota | <KB> | limits the mailbox quota to the desired amount |
| -aliases | <add|del>:<name1[,name2]> | adds or deletes mail alias(es) to/from a mail name |
| -mgroups | <add|del>:<list1[,list2]> | adds or removes a mail name to/from a mail group |
| -redirect | <true|false> | switches mail redirect on/off |
| -rediraddr | <addr> | sets redirect to an address (required if redirect is enabled) |
| -group | <true|false> | switches a mail group on/off |
| -groupmem | <add|del>:<addr1[,addr2]> | adds/removes address(-es) to/from a mail group |
| -repo | <add|del>:<file1[,file2]> | adds/removes file to/from the attachments repository |
| -autorsp | <true|false> | switches all autoresponders on/off |
| -autoname | <name> | autoresponder name (required for all autoresponder options) |
| -autostatus | <true|false> | switches on/off autoresponder with the specified name |
| -autoreq | <subj|body>:<string> or <always> | defines the condition for autoresponder - either to be activated when the specified pattern is encountered in the subject or body, or to respond always |
| -autosubj | <original|string> | the subject line to be set up in autoresponder ("Re: <incoming subject>") or a custom string. |
| -auto_replyto | <string> | returns the address that will be set up in the autoresponder messages |
| -autotext | <string> | autoresponder message text |
| -autoatch | <add|del>:<file1[,file2]> | adds/removes autoresponder attachment files |
| -autofrq | <number> | defines the maximum number of responses to a unique e-mail address per day |
| -autostor | <number> | defines the number of unique addresses to be stored for autoresponder |
| -autored | <addr> | defines the e-mail address to forward all incoming mail to |