Prev Chapter 71: Controller: /siteworx/email/alias
Up Part III: SiteWorx API Spec
Chapter 73: Controller: /siteworx/email/box Next
72 Controller: /siteworx/email/autorespond
Required Permissions "EMAIL"
Required Options E-mail Autoresponders
Added in version 4.7.0-339
Description Add an e-mail autoresponder.
Input Parameters
| Name | Type | Notes | Required? |
| username | string | Yes | |
| copyto | struct (string) |
Example Values postmaster@example.com, poehler@example.com, mygroup@example.com, myautoresponder@example.com |
No |
| autorespondmessage | string | Yes |
Added in version 4.7.0-339
Description Delete an e-mail autoresponder.
Input Parameters
| Name | Type | Notes | Required? |
| username | struct (string) |
Example Values myautoresponder |
Yes |
Added in version 4.7.0-339
Description Edit an e-mail autoresponder.
Input Parameters
| Name | Type | Notes | Required? |
| username | string |
Example Values myautoresponder |
Yes |
| copyto | struct (string) |
Example Values postmaster@example.com, poehler@example.com, mygroup@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 | |||
Added in version n/a
Description Magic function - test for failure mechanism.
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 => ’myautoresponder@example.com’,
),
),
)
Added in version 4.8.0-393
Description List e-mail autoresponders.
Sample output
array (’status’ => 0,
’payload’ =>
array (
0 =>
array (
’username’ => ’myautoresponder’,
’email’ => ’myautoresponder@example.com’,
’copyto’ => ’’,
’message’ => ’my message’,
),
),
)
Added in version n/a
Description Action to re-route from the current controller to a different one.
Input Parameters
| Name | Type | Notes | Required? |
| controller | string |
Example Values Index, Overview, Email, EmailBox, EmailAlias, EmailGroup, EmailAutorespond, DomainsSlave, DomainsPointer, DomainsSub, DomainsPhp, Dns, Ssl, SslKey, SslChain, SslCrt, SslCsr, Ftp, FtpSessions, MysqlDb, MysqlUser, MysqlPerms, Cron, Htaccess, Simplescripts, Users, Logs, Twofactorauth, EmailRemotesetup, EmailFilters, EmailSpamprefs, EmailSpf, EmailDomainkeys, Backup, BackupSchedule, Prefs, Notice, Logout |
Yes |
Added in version n/a
Description Magic function - test for testing success mechanism.
Prev Chapter 71: Controller: /siteworx/email/alias
Up Part III: SiteWorx API Spec
Chapter 73: Controller: /siteworx/email/box Next
(C) 2018 by InterWorx LLC