Previous page Previous page

Next page Next page

Locate page Locate page

Print this page

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:

Syntax

autoresponder <command> <autoresponder name> [
<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.

# ./autoresponder --create Autoreply -mail JDoe@example.com -status true -attach "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 --create Autoreply -mail JDoe@example.com

or

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

--update or -u

<autoresponder_name>

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"

--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 --remove Autoreply -mail JDoe@example.com

or

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

--on

<domain_name>

Enables all autoresponders on a specified Plesk mail account.

To enable all existing autoresponders for mail account JDoe@example.com:

# ./autoresponder --on example.com

--off

<domain_name>

Disables all autoresponders on a specified Plesk mail account.

To disable all existing autoresponders for the mail account JDoe@example.com:

# ./autoresponder --off example.com

--attachments or -a

 

Adds/Deletes files to/from an autoresponder attachment files repository.

Requires -files option.

To add files /usr/local/sampleschedule.txt and /usr/local/applicationform.txt to the autoresponder attachment files repository for the mail account JDoe@example.com:

# ./autoresponder --attachments -mail JDoe@example.com -files add:/usr/local/sampleschedule.txt,/usr/local/applicationform.txt

or

# ./autoresponder -a -mail JDoe@example.com -files add:/usr/local/sampleschedule.txt,/usr/local/applicationform.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 --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 --create, --update, --remove, and --info commands.

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

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

-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

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

-replyto

<string>

Specifies the reply to address that will be put into an 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 -u AutoReply -mail JDoe@example.com -replyto help@example.com

-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

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

-attach

add|del:<file_name>[,<file_name_1>,...,<file name_N>]

Adds/Removes files to be attached to an autoresponder's automatic reply message.

Only files that are already added 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 AutoReply for JDoe@example.com:

# ./autoresponder -u AutoReply -mail JDoe@example.com -files add:/usr/local/sampleschedule.txt,/usr/local/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 -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 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 /usr/local/sampleschedule.txt and /usr/local/applicationform.txt to the autoresponder attachment files repository for JDoe@example.com:

# ./autoresponder -a -mail JDoe@example.com -files add:/usr/local/sampleschedule.txt,/usr/local/applicationform.txt