Mail Autoresponders: autoresponder Utility

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

Usage

autoresponder <command> <e-mail address> [
<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 --update -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

--update or -u

 

Updates autoresponder settings.

Requires -mail option.

To reply to mail messages received by JohnDoe@example.com using autoresponder AutoReply with the An autoreply message subject:

# ./autoresponder --update AutoReply -mail JDoe@example.com -subject "An autoreply message"

or

# ./autoresponder -u AutoReply -mail JDoe@example.com -subject "An autoreply message"

--info or -i

 

Displays information about a mail autoresponder.

Requires -mail option.

To view information about autoresponder AutoReply for the mail account JDoe@example.com:

# ./autoresponder --info AutoReply -mail JDoe@example.com

or

# ./autoresponder -i AutoReply -mail JDoe@example.com

--help or -h

 

Displays help on the use of the utility.

To view help on the use of the autoresponder utility:

# ./autoresponder --help

or

# ./autoresponder -h

Options

Option

Parameter

Description

Example

-mail

<email>

Specifies a mail account for which an autoresponder is created.

Required with --update and --info commands.

To create mail autoresponder AutoReply for JDoe@example.com:

# ./autoresponder -u -mail JDoe@example.com -status true

-redirect

<email>

Specifies an email 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 -u AutoReply -mail JDoe@example.com -redirect help@example.com

-status

true|false

Enables/Disables an autoresponder.

Is false by default.

To enable autoresponder AutoReply for JDoe@example.com:

# ./autoresponder -u AutoReply -mail JDoe@example.com -status true

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 -u AutoReply -mail JDoe@example.com -subject "Help information"

-text

<string>

Specifies an 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 -u AutoReply -mail JDoe@example.com -text "Thank you for your inquiry."

-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 -u AutoReply -mail JDoe@example.com -format html

-charset

<string>

Specifies the charset used to encode autoresponder's automatic reply messages.

To use the UTF-8 charset to encode automatic reply messages of the autoresponder AutoReply for JDoe@example.com:

# ./autoresponder -u AutoReply -mail JDoe@example.com -charset UTF-8

-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 -u AutoReply -mail JDoe@example.com -attach add:sampleschedule.txt,applicationform.txt

 

Please send us your feedback on this help page.