Controller: EmailAutorespond

API Controller /siteworx/email/autorespond
Required Permissions ["EMAIL"]
Required Options E-mail Autoresponders
Action Description
add Add an e-mail autoresponder.
delete Delete an e-mail autoresponder.
edit Edit an e-mail autoresponder.
list List e-mail autoresponders. DEPRECATED in version 4.8.0-393
listEmailAutoresponders List e-mail autoresponders.

Action: add

Add an e-mail autoresponder.

Input Parameters

Name Type Notes Required?
username string Yes
copyto string
Example Values
postmaster@example.com, poehler@example.com, mygroup@example.com, myautoresponder@example.com
 No
autorespondmessage string Yes

Action: delete

Delete an e-mail autoresponder.

Input Parameters

Name Type Notes Required?
username struct (string)
Example Values
myautoresponder
 Yes

Action: edit

Edit an e-mail autoresponder.

Input Parameters

Name Type Notes Required?
username string
Example Values
myautoresponder
 Yes
copyto string
Example Values
postmaster@example.com, poehler@example.com, mygroup@example.com, myautoresponder@example.com
 No
autorespondmessage string
Example Default Value
my message
 No*
* indicates that it's actually required, but probably already has a valid default value

Action: list

This action has been deprecated as of version 4.8.0-393.

MESSAGE: 2010-11-18 use listEmailAutoresponders

List e-mail autoresponders.

Example Output

array (
  'status' => 0,
  'payload' => 
  array (
    0 => 
    array (
      0 => 'myautoresponder',
      1 => 'myautoresponder@example.com',
    ),
  ),
)

Action: listEmailAutoresponders (Added in version 4.8.0-393)

List e-mail autoresponders.

Example Output

array (
  'status' => 0,
  'payload' => 
  array (
    0 => 
    array (
      'username' => 'myautoresponder',
      'email' => 'myautoresponder@example.com',
      'copyto' => '',
      'message' => 'my message',
    ),
  ),
)