autoresponder: Mail Autoresponders

The autoresponder utility is used to manage mail autoresponders through CLI. 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

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 Plesk 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.

plesk bin 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 with the An autoreply message subject:

plesk bin autoresponder --update -mail JDoe@example.com -subject "An autoreply message"

or

plesk bin autoresponder -u -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 for the mail account JDoe@example.com:

plesk bin autoresponder --info -mail JDoe@example.com

or

plesk bin autoresponder -i -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:

plesk bin autoresponder --help

or

plesk bin autoresponder -h

Options
Option Parameter Description Example

-mail

<mail@domain>

Specifies a mail account for which an autoresponder is created.

Required with --update and --info commands.

To set up mail autoresponder for JDoe@example.com:

plesk bin autoresponder -u -mail JDoe@example.com -status true

-redirect

<mail@domain>

Specifies an email address to which incoming mail will be forwarded.

To forward all incoming mail for autoresponder associated with JohnDoe@example.com to help@example.com:

plesk bin autoresponder -u -mail JDoe@example.com -redirect help@example.com

-status

true|false

Enables/Disables an autoresponder.

Is false by default.

To enable autoresponder for JDoe@example.com:

plesk bin autoresponder -u -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 JDoe@example.com using autoresponder with the Help information subject:

plesk bin autoresponder -u -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 for JDoe@example.com to "Thank you for your inquiry.":

plesk bin autoresponder -u -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 for JDoe@example.com:

plesk bin autoresponder -u -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 for JDoe@example.com:

plesk bin autoresponder -u -mail JDoe@example.com -charset UTF-8

-end-date

off|<YYYY-MM-DD>

Specifies the autoresponder end date.

To set the end date of the autoresponder for the JDoe@example.com mail account to December 31st, 2015:

plesk bin autoresponder -u -mail JDoe@example.com -end-date 2015-12-31

-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 Plesk 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 for JDoe@example.com:

plesk bin autoresponder -u -mail JDoe@example.com -attach add:sampleschedule.txt,applicationform.txt

-frq

<number>

Specifies the maximum number of automatic responses to a unique email address per day.

To send no more than 5 emails in a day in response to all emails sent to JDoe@example.com from any unique email address:

plesk bin autoresponder -u -mail JDoe@example.com -frq 5

 

 

Leave your comments on this page

Leave your feedback or question on this documentation topic below. For technical assistance, contact your hosting service provider or submit a request to Plesk support. Suggest new features for Plesk here. Discuss general questions on the Plesk forum. All offtopic comments will be removed.