Mail Autoresponders: autoresponder.exe

The autoresponder.exe utility is used to manage mail autoresponders. By using this utility, you can perform the following tasks:

creating/deleting autoresponders
enabling/disabling autoresponders
editing autoresponder settings
managing autoresponder attachment files
managing automatic reply message parameters

Location

%plesk_cli%

Usage

autoresponder.exe <command> [<autoresponder name>|<domain name>] [

<option_1> [<param>]

[<option_2> [<param>]]

… [<option_N> [<param>]]

Example

The following command creates and enables autoresponder named AutoReply for Parallels Plesk Panel mail account JDoe@example.com, sets the text to "Thank you for your inquiry. The application form is attached." and the subject line to "application form" for the automatic reply message, attached to the message file applicationform.txt from the autoresponders attachment file repository.

>autoresponder.exe --create AutoReply -mail JDoe@example.com -status true -attach add:"applicationform.txt" -subject "application form" -text "Thank you for your inquiry. The application form is attached."

Commands

Command	Parameter	Description	Example
`--create` or `-c`	`<autoresponder name>`	Creates a mail autoresponder. Requires `-mail` option.	To create mail autoresponder AutoReply for the mail account JDoe@example.com: >autoresponder.exe --create Autoreply -mail JDoe@example.com or >autoresponder.exe -c AutoReply -mail JDoe@example.com
`--update` or `-u`	`<autoresponder name>`	Changes autoresponder settings. Requires `-mail` option.	To reply to mail messages received by JohnDoe@example.com using autoresponder AutoReply with the Automatic Reply Message subject: >autoresponder.exe --update AutoReply -mail JDoe@example.com -subject "An autoreply message" or >autoresponder.exe -u AutoReply -mail JDoe@example.com -subject "Automatic Reply Message"
`--remove` or `-r`	`<autoresponder name>`	Deletes a mail autoresponder. Requires `-mail` option.	To delete mail autoresponder AutoReply for the mail account JDoe@example.com: >autoresponder.exe --remove Autoreply -mail JDoe@example.com or >autoresponder.exe -r AutoReply -mail JDoe@example.com
`--on`	`<mail name>`	Enables all autoresponders on a specified Parallels Plesk Panel mail account.	To enable all existing autoresponders for mail account JDoe@example.com: >autoresponder.exe --on JDoe@example.com
`--off`	`<mail name>`	Disables all autoresponders on a specified Plesk mail account.	To disable all existing autoresponders for the mail account JDoe@example.com: >autoresponder.exe --off JDoe@example.com
`--attachments` or `-a`		Adds/Deletes files to/from mail account's repository of autoresponder attachment files. Requires `-mail` and `-files` options.	To add files `D:\mail-attachments\sampleschedule.txt` and `D:\mail-attachments\applicationform.txt` to the autoresponder attachment files repository for the mail account JDoe@example.com: >autoresponder.exe --attachments -mail JDoe@example.com -files add:"D:\mail-attachments\sampleschedule.txt","D:\mail-attachments\sampleschedule.txt" or >autoresponder.exe -a -mail JDoe@example.com -files add:"D:\mail-attachments\sampleschedule.txt","D:\mail-attachments\sampleschedule.txt"
`--info` or `-i`	`<autoresponder name>`	Displays information about a mail autoresponder. Requires `-mail` option.	To view information about autoresponder AutoReply for the mail account JDoe@example.com: >autoresponder.exe --info AutoReply -mail JDoe@example.com or >autoresponder.exe -i AutoReply -mail JDoe@example.com
`--help` or `-h`		Displays help on the utility usage.	To view help on the use of the `autoresponder` utility: >autoresponder.exe --help or >autoresponder.exe -h

Options

Option	Parameter	Description	Example
`-mail`	`<email>`	Specifies a mail account which holds the operated autoresponder. Required with `--create`, `--update`, `--remove`, `--attachments` and `--info` commands.	To create mail autoresponder AutoReply for JDoe@example.com: >autoresponder.exe -c AutoReply -mail JDoe@example.com
`-status`	`true\|false`	Enables/Disables an autoresponder. Is `false` by default.	To enable autoresponder AutoReply for JDoe@example.com: >autoresponder.exe -u AutoReply -mail JDoe@example.com -status true
`-requires`	`always\|<subj\|body>:<string>`	Specifies the condition under which the autoresponder will be activated. The following conditions are available: the specified pattern is discovered in the mail subject (`<subject>:<string>`) the specified pattern is discovered in the mail body (`<body>:<string>`) the autoresponder is always active (`always`).	To set up automatic replying to messages delivered to JDoe@example.com using autoresponder AutoReply only when an incoming message subject line contains the information request pattern: >autoresponder.exe -u AutoReply -mail JDoe@example.com -requires subj:"information request"
`subject`	`<string>`	Specifies the subject line of the automatic reply message for an autoresponder. Is `Re:<incoming_message_subject>` by default.	To reply to mail messages received by JohnDoe@example.com using autoresponder AutoReply with the Help information subject: >autoresponder.exe -u AutoReply -mail JDoe@example.com -subject "Help information"
`-replyto`	`<string>`	Specifies the reply-to address that will be put into autoresponder's messages.	To set the reply-to address of the automatic reply message for autoresponder AutoReply forJDoe@example.com to help@example.com: >autoresponder.exe -u AutoReply -mail JDoe@example.com -replyto help@example.com
`-text`	`<string>`	Specifies autoresponder's automatic reply message body text.	To set the automatic reply message body text for the autoresponder Autoreply for JDoe@example.com to "Thank you for your inquiry.": >autoresponder.exe -u AutoReply -mail JDoe@example.com -text "Thank you for your inquiry."
`-redirect`	`<email>`	Specifies an e-mail address to which incoming mail will be forwarded.	To forward all incoming mail for autoresponder AutoReply associated with JohnDoe@example.com to help@example.com: >autoresponder.exe -u AutoReply -mail JDoe@example.com -redirect help@example.com
`-format`	`plain\|html`	Specifies the format of an autoresponder's automatic reply message.	To send automatic reply messages in the HTML format by using autoresponder AutoReply for JDoe@example.com: >autoresponder.exe -u AutoReply -mail JDoe@example.com -format html
`-store`	`<number>`	Limits the number of unique email addresses to be stored for an autoresponder.	To restrict the maximum number of unique addresses for autoresponder AutoReply associated with JohnDoe@example.com to 200: >autoresponder.exe -u AutoReply -mail JDoe@example.com -store 200
`-attach`	`add\|del:<file_name>[,<file_name_1>,...,<file name_N>]`	Adds/Removes attached files to/from autoresponder's automatic reply message. Only files that are already added (with the help of the `--attachments` command) to the Parallels Plesk Panel mail account's attachment files repository can be added to the autoresponder's attachments. Used with the `--create` and `--update` commands only.	To add files `sampleschedule.txt` and `applicationform.txt` from the attachment files repository to the autoresponder AutoReply for JDoe@example.com: >autoresponder.exe -u AutoReply -mail JDoe@example.com -attach add:sampleschedule.txt,applicationform.txt
`-frq`	`<number>`	Limits the number of replies that can be sent to a unique email address per day.	To set the maximum number of replies that can be sent to a unique email address per day by using autoresponder AutoReply for JDoe@example.com to 5: >autoresponder.exe -u AutoReply -mail JDoe@example.com -frq 5
`-files`	`add\|del:<file_name>[,<file_name_1>,...,<file name_N>]`	Specifies files to be added/deleted to/from mail account's autoresponder attachment files repository. Used with the `--attachments` command only. Required with the `--attachments`. When adding files to the repository, `<file name>` in the option argument must include the full path to the file. When deleting files from the repository, `<file name>` must include only the file name.	To add files `D:\mail-attachments\sampleschedule.txt` and `D:\mail-attachments\applicationform.txt` to the autoresponder attachment files repository for the mail account JDoe@example.com: >autoresponder.exe --attachments -mail JDoe@example.com -files add:"D:\mail-attachments\sampleschedule.txt","D:\mail-attachments\sampleschedule.txt"