The mail.exe utility serves to manage mail accounts. The utility allows the following operations:
Syntax
mail.exe <command> [[<mail_name>@]<domain>] [
<option1><param1>[<param2>…<param n>]
[<option2><param1>[<param2>…<param n>]]
…[<option N><param>[<param2>…<param n>]]
]
Example
The following command line creates the johndoe@domain1.com account, sets the MyPass password for it, disables access to this email account via Plesk control panel, restricts the size of the email box to 200 KB, and enables bidirectional email checkup for viruses.
>mail.exe --create johndoe@domain1.com -passwd MyPass -cp_access false -mbox_quota 200 -antivirus inout
Commands
Command |
Parameter |
Description |
Example |
|---|---|---|---|
|
|
Creates a mail account with the specified name. |
To create an email account for John Doe on somewhere.com: >mail.exe -create John_Doe@somewhere.com or >mail.exe -c John_Doe@somewhere.com |
|
|
Updates the mail account. |
To update the size of the email box for John@somewhere.com: >mail.exe --update John@somewhere.com -mbox_quota 500 or >mail.exe -u John@somewhere.com -mbox_quota 500 |
|
|
Removes the specified mail account from domain. |
To remove the e-mail account of John Doe from somewhere.com: >mail.exe --remove John_Doe@somewhere.com or >mail.exe -r John_Doe@somewhere.com |
|
|
Enables the email service on the specified domain. |
To enable the email service on somewhere.com: >mail.exe --on somewhere.com |
|
|
Disables the email service on the specified domain. |
To disable the email service on somewhere.com: >mail.exe --off somewhere.com |
|
|
Retrieves info about the specified email account. |
To retrieve info about the John_Doe@somewhere.com email account: >mail.exe --info John_Doe@somewhere.com or >mail.exe –i John_Doe@somewhere.com |
|
|
Displays help on the use of the utility. |
To see the help info on the use of the > >mail.exe --help or >mail.exe -h |
Options
Option |
Parameter |
Description |
Example |
|---|---|---|---|
|
|
Enables access to the email account via Plesk Control Panel (CP). |
To enable access to John_Doe@somewhere.com via Plesk CP: >mail.exe --update John_Doe@somewhere.com -cp_access true |
|
|
Creates/removes an email box. |
To remove the John_Doe mail box: >mail.exe --update John_Doe -mailbox false |
|
|
Sets the password for an email box. |
To set the JD_password password for John_Doe@somewhere.com: >mail.exe --update John_Doe -passwd JD_password |
|
|
This option is the alias of |
To set the JD_password password for John_Doe@somewhere.com: >mail.exe --update John_Doe -boxpass JD_password |
|
|
Restricts the size of the email box to the specified value (in KB). |
To restrict the size of the email box for John_Doe@somewhere.com to 500 KB: >mail.exe --update John_Doe@somewhere.com -mbox_quota 500 |
|
|
This option is the alias of the |
To restrict the size of the email box for John_Doe@somewhere.com to 500 KB: >mail.exe --update John_Doe@somewhere.com -boxquota 500 |
|
|
Adds or deletes email alias(es) to/from the specified email account. |
To add JD, John_D mail aliases to John_Doe@somewhere.com: >mail.exe --update John_Doe@somewhere.com -aliases add:JD, John_D |
|
|
Adds or removes the email account to/from the email group. |
To remove John_Doe@somewhere.com from the Partners email group: >mail.exe --update John_Doe@somewhere.com -mgroups del:Partners |
|
|
Enables/disables the email redirect option for the specified email account. |
To enable redirect of the email correspondence from John_Doe@somewhere.com to John_Doe@redirect.com: >mail.exe --update John_Doe@somewhere.com -redirect true -rediraddr John_Doe@redirect.com |
|
|
Specifies the target email address where to redirect. Is required when enabling the email redirect option for the email account. |
To set the target address where to redirect to John_Doe@redirect.com: >mail.exe --update John_Doe@somewhere.com -redirect true -rediraddr John_Doe@redirect.com |
|
|
Makes the specified email account an email group. |
To disable the email group property for John_Doe@somewhere.com: >mail.exe --update John_Doe@somewhere.com -group false |
|
|
Associates/removes the specified address(-es) with/from the email group. |
To associate Address1@doman.name with the John_Doe@somewhere.com email group: >mail.exe --update John_Doe@somewhere.com -groupmem add: Address1@domain.name |
|
|
Adds/removes the file to/from the repository of email attachments for the specified email address. If the file is located in the folder other than |
To add attach.zip located in >mail.exe --update John_Doe@somewhere.com -repo add:"c:\my files\attach.zip" |
|
|
Enables/disables all autoresponders (automatically generated email replies) for the specified email address. |
To enable all autoresponders: >mail.exe --update John_Doe@somewhere.com -autorsp true |
|
|
Sets the name of the autoresponder for the specified mailname. |
To set the autojohn autoresponder name for the john@somedom.com mailname: >mail.exe --update john@somedom.com -autoname autojohn |
|
|
Enables/disables the autoresponder with the specified name. Is set to true by default. |
To enable the JD_autoresponder autoresponder for John_Doe@somewhere.com: >mail.exe --update John_Doe -autoname JD_autoresponder -autostatus true |
|
|
Specifies the condition under which the autoresponder will be activated. The conditions are: the specified pattern is discovered in the email subject or body, or the autoresponder is always active. |
To reply to email messages received by John_Doe@somewhere.com and containing Need help in the subject using JD_autoresponder: >mail.exe --update John_Doe -autoname JD_autoresponder -autoreq subj:"Need help" |
|
|
Specifies whether to put the original subject or a special string to the autoresponder's subject. |
To reply to email messages received by John_Doe@somewhere.com using JD_autoresponder with the Help information subject: >mail.exe --update John_Doe -autoname JD_autoresponder -autosubj "Help information" |
|
|
Specifies the reply to address that will be put into the autoresponder's messages. |
To set the reply to address to helpserver@somewhere.com for JD_autoresponder associated with John_Doe@somewhere.com: >mail.exe --update John_Doe -autoname JD_autoresponder -auto_replyto helpserver@somewhere.com |
|
|
Specifies the message text for a certain autoresponder. |
To change the autoresponder message text to Thank you for your inquiry for JD_autoresponder associated with John_Doe@somewhere.com: >mail.exe --update John_Doe -autoname JD_autoresponder -autotext "Thank you for your inquiry" |
|
|
Adds/removes the autoresponder's attached files. If the file to attach is located in the folder other than |
To add attach.zip located in >mail.exe --update John_Doe -autoname JD_autoresponder -autoatch add:"c:\my files\attach.zip" |
|
|
Specifies the maximal number of replies sent to a unique email address per day. |
To set sending not more than 5 replies to a unique email address per day for JD_autoresponder associated with John_Doe@somewhere.com: >mail.exe --update John_Doe -autoname JD_autoresponder -autofrg 5 |
|
|
Defines the number of unique email addresses for the specified autoresponder. |
To restrict the number of unique addresses to 10 for JD_autoresponder associated with John_Doe@somewhere.com: >mail.exe --update John_Doe -autoname JD_autoresponder -autostor 10 |
|
|
Specifies the email address to forward all incoming correspondence to. |
To forward all incoming mail to help@somewhere.com for JD_autoresponder associated with John_Doe@somewhere.com: >mail.exe --update John_Doe -autoname JD_autoresponder -autored help@somewhere.com |
|
|
Sets up the antivirus checkup of the email traffic. One can disable this option, or enable this checkup for the incoming mail only, or for the outgoing email only, or for both. |
To enable the antivirus checkup for all email messages sent to John_Doe@somewhere.com: >mail.exe --update John_Doe@somewhere.com -antivirus in |