Controller: /siteworx/email/autorespond

Required Permissions:

EMAIL

Required Options:

Email Autoresponders

Action: add

Added in Version:

4.7.0-339

Description:

Add an e-mail autoresponder.

Input Parameters

Name

Type

Required?

Example Values

Default Values

Notes

username

string

Yes

copyto

struct (string)

No

postmaster@example.com, poehler@example.com, mygroup@example.com, myautoresponder@example.com

autorespondmessage

string

Yes

Action: delete

Added in Version:

4.7.0-339

Description:

Delete an e-mail autoresponder.

Input Parameters

Name

Type

Required?

Example Values

Default Values

Notes

username

struct (string)

Yes

myautoresponder

Action: edit

Added in Version:

4.7.0-339

Description:

Edit an e-mail autoresponder.

Input Parameters

Name

Type

Required?

Example Values

Default Values

Notes

username

string

Yes

myautoresponder

copyto

struct (string)

No

postmaster@example.com, poehler@example.com, mygroup@example.com

autorespondmessage

string

No*

my message

* indicates that it’s actually required, but probably already has a valid default value.

Action: fail

Added in Version:

n/a

Description:

Magic function - test for failure mechanism.

Action: list

Added in Version:

4.7.0-339

Description:

List e-mail autoresponders.

Warning

This action has been deprecated as of version 4.8.0-393. 2010-11-18 use listEmailAutoresponders

Sample Output

array (
  'status' => 0,
  'payload' =>
  array (
    0 =>
    array (
      0 => 'myautoresponder',
      1 => '[email protected]',
    ),
  ),
  'reply_code' => 205,
)

Action: listEmailAutoresponders

Added in Version:

4.8.0-393

Description:

List e-mail autoresponders.

Sample Output

array (
  'status' => 0,
  'payload' =>
  array (
    0 =>
    array (
      'username' => 'myautoresponder',
      'email' => '[email protected]',
      'copyto' => '',
      'message' => 'my message',
      'local_delivery' => true,
    ),
  ),
  'reply_code' => 205,
)

Action: reroute

Added in Version:

n/a

Description:

Action to re-route from the current controller to a different one.

Input Parameters

Name

Type

Required?

Example Values

Default Values

Notes

controller

string

Yes

Index, Overview, Email, EmailBox, EmailAlias, EmailGroup, EmailAutorespond, DomainsManage, DomainsPointer, DomainsSub, DomainsPhp, Dns, DomainsAdvanced, Ssl, SslKey, SslChain, SslCrt, SslCsr, Ftp, FtpSessions, MysqlDb, MysqlUser, MysqlPerms, Cron, Htaccess, Softaculous, Users, Logs, Twofactorauth, EmailRemotesetup, EmailFilters, EmailSpf, EmailDomainkeys, EmailDmarc, Backup, BackupSchedule, Prefs, Notice, Logout

Action: wait

Added in Version:

8.1.3-2998

Description:

Magic function - used to simulate a long-running process

Action: win

Added in Version:

n/a

Description:

Magic function - test for testing success mechanism.