Chapter 75: Controller: /siteworx/email/filters Up Part III: SiteWorx API Spec Chapter 77: Controller: /siteworx/email/remotesetup 

76 Controller: /siteworx/email/group

Required Permissions "EMAIL"
Required Options E-mail Groups
Action: add
Added in version 4.7.0-339
Description Add an e-mail group.
Input Parameters
Name Type Notes Required?
username string Yes
forwardsto struct (string) Example Values
postmaster@example.com, poehler@example.com, mygroup@example.com, myautoresponder@example.com
No*
* indicates that it’s actually required, but probably already has a valid default value
Action: delete
Added in version 4.7.0-339
Description Delete an e-mail group.
Input Parameters
Name Type Notes Required?
username struct (string) Example Values
mygroup
Yes
Action: edit
Added in version 4.7.0-339
Description Edit an e-mail group.
Input Parameters
Name Type Notes Required?
username string Example Values
mygroup
Yes
forwardsto struct (string) Example Values
postmaster@example.com, poehler@example.com, mygroup@example.com, myautoresponder@example.com
Example Default Value
["poehler@interworx.com"]
No*
* 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 groups.
Warning This action has been deprecated as of version 4.8.0-393. 2010-11-18 use listEmailGroups
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
0 => ’mygroup’,
1 => ’mygroup@example.com’,
),
),
)
Action: listEmailGroups
Added in version 4.8.0-393
Description List e-mail groups.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
’username’ => ’mygroup’,
’email’ => ’mygroup@example.com’,
’members’ => ’poehler@interworx.com’,
),
),
)
Action: reroute
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
Action: win
Added in version n/a
Description Magic function - test for testing success mechanism.
 Chapter 75: Controller: /siteworx/email/filters Up Part III: SiteWorx API Spec Chapter 77: Controller: /siteworx/email/remotesetup 

(C) 2018 by InterWorx LLC