Controller: EmailBox

API Controller /siteworx/email/box
Required Permissions ["EMAIL"]
Required Options E-mail Boxes
Action Description
add Add an e-mail box.
delete Delete an e-mail box.
edit Edit an e-mail box.
list List e-mail boxes (pop/imap). DEPRECATED in version 4.8.0-393
listEmailBoxes List e-mail boxes (pop/imap).

Action: add

Add an e-mail box.

Input Parameters

Name Type Notes Required?
username string Yes
password string Yes
confirm_password string
Help Entry
Confirm the password field by providing it again. Must match the password provided.
 Yes
diskspacequota integer
Description
Megabytes
Example Default Value
999999999
 No*
copyto string
Example Values
postmaster@example.com, poehler@example.com, mygroup@example.com, myautoresponder@example.com
 No
groups struct (string)
Example Values
mygroup
 No
* indicates that it's actually required, but probably already has a valid default value

Action: delete

Delete an e-mail box.

Input Parameters

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

Action: edit

Edit an e-mail box.

Input Parameters

Name Type Notes Required?
username string
Example Values
postmaster
 Yes
password string No
confirm_password string
Help Entry
Confirm the password field by providing it again. Must match the password provided.
 No
diskspacequota integer
Description
Megabytes
Example Default Value
999999999
 No*
copyto string
Example Values
postmaster@example.com, poehler@example.com, mygroup@example.com, myautoresponder@example.com
 No
groups struct (string)
Example Values
mygroup
 No
onvacation integer
Example Values
1, 0
Example Default Value
0
 No*
vacation_message string 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 listEmailBoxes

List e-mail boxes (pop/imap).

Example Output

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

Action: listEmailBoxes (Added in version 4.8.0-393)

List e-mail boxes (pop/imap).

Example Output

array (
  'status' => 0,
  'payload' => 
  array (
    0 => 
    array (
      'username' => 'postmaster',
      'email' => 'postmaster@example.com',
      'quota' => '##LG_NOQUOTA##',
      'quota_bytes' => 0,
      'copyto' => '',
      'on_vacation' => false,
      'box_size' => '20480',
      'box_pct' => 0,
    ),
  ),
)