Controller: /siteworx/email/group¶
- Required Permissions
EMAIL
- Required Options
Email Groups
Action: add
¶
- Added in Version
4.7.0-339
- Description
Add an e-mail group.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
Yes |
|||
|
struct (string) |
No* |
postmaster@example.com, poehler@example.com, mygroup@example.com, myautoresponder@example.com |
* 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 |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
struct (string) |
Yes |
mygroup |
Action: edit
¶
- Added in Version
4.7.0-339
- Description
Edit an e-mail group.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
Yes |
mygroup |
||
|
struct (string) |
No* |
postmaster@example.com, poehler@example.com, mygroup@example.com, myautoresponder@example.com |
* 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 => '[email protected]',
),
),
'reply_code' => 205,
)
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' => '[email protected]',
'members' => '[email protected]',
'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 |
---|---|---|---|---|---|
|
string |
Yes |
Index, Overview, Email, EmailBox, EmailAlias, EmailGroup, EmailAutorespond, EmailMailman, DomainsManage, DomainsPointer, DomainsSub, DomainsPhp, Dns, Ssl, SslKey, SslChain, SslCrt, SslCsr, Ftp, FtpSessions, MysqlDb, MysqlUser, MysqlPerms, Cron, Htaccess, Softaculous, Users, Logs, Twofactorauth, EmailRemotesetup, EmailFilters, EmailSpamprefs, EmailSpf, EmailDomainkeys, EmailDmarc, Backup, BackupSchedule, Prefs, Notice, Logout |
Action: win
¶
- Added in Version
n/a
- Description
Magic function - test for testing success mechanism.