Skip to content

mailbox

Manage mailboxes

Create

Path
POST /v7.0/mailboxes
Description
Create a mailbox
Authentication required
yes
Scope
mailbox#create
Aliases
new
Blocking
no

Input parameters

Layout
object
Namespace
mailbox
ParameterTypeRequiredDetails
label
Label
 String yes

Default: null

Validation rules
RuleDetails
Present

Must be supplied and cannot be null. Must not be empty; strings must contain a non-whitespace character.

Validation error message: must be present and non-empty
server
Server
 String yes

Default: null

Validation rules
RuleDetails
Present

Must be supplied and cannot be null. Must not be empty; strings must contain a non-whitespace character.

Validation error message: must be present and non-empty
port
Port
 Integer no

Default: null
user
User
 String yes

Default: null

Validation rules
RuleDetails
Present

Must be supplied and cannot be null. Must not be empty; strings must contain a non-whitespace character.

Validation error message: must be present and non-empty
password
Password
 String yes

Auto-generated password

Default: null

Validation rules
RuleDetails
Present

Must be supplied and cannot be null. Must not be empty; strings must contain a non-whitespace character.

Validation error message: must be present and non-empty
enable_ssl
Enable_ssl
 Boolean no

Default: true

Output parameters

Layout
object
Namespace
mailbox
ParameterTypeDescription
id
ID
 Integer
label
Label
 String
server
Server
 String
port
Port
 Integer
user
User
 String
enable_ssl
Enable_ssl
 Boolean
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime

Delete

Path
DELETE /v7.0/mailboxes/{mailbox_id}
Description
Delete mailbox
Authentication required
yes
Scope
mailbox#delete
Aliases
destroy
Blocking
no

Input parameters

No parameters.

Output parameters

No parameters.

Index

Path
GET /v7.0/mailboxes
Description
List mailboxes
Authentication required
yes
Scope
mailbox#index
Aliases
list
Blocking
no

Input parameters

Layout
object
Namespace
mailbox
ParameterTypeRequiredDetails
from_id
From ID
 Integer no

List objects with IDs greater or lower than this value

Default: null

Validation rules
RuleDetails
Number
  • Must be a number after parameter type conversion.
  • Minimum: 0 (inclusive).

Validation error message: must be at least 0
limit
Limit
 Integer no

Number of objects to retrieve

Default: null

Validation rules
RuleDetails
Number
  • Must be a number after parameter type conversion.
  • Minimum: 0 (inclusive).
  • Maximum: 1000 (inclusive).

Validation error message: must be between 0 and 1000

Output parameters

Layout
object_list
Namespace
mailboxes
ParameterTypeDescription
id
ID
 Integer
label
Label
 String
server
Server
 String
port
Port
 Integer
user
User
 String
enable_ssl
Enable_ssl
 Boolean
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime

Show

Path
GET /v7.0/mailboxes/{mailbox_id}
Description
Show mailbox
Authentication required
yes
Scope
mailbox#show
Aliases
find
Blocking
no

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
mailbox
ParameterTypeDescription
id
ID
 Integer
label
Label
 String
server
Server
 String
port
Port
 Integer
user
User
 String
enable_ssl
Enable_ssl
 Boolean
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime

Update

Path
PUT /v7.0/mailboxes/{mailbox_id}
Description
Update mailbox
Authentication required
yes
Scope
mailbox#update
Aliases
Blocking
no

Input parameters

Layout
object
Namespace
mailbox
ParameterTypeRequiredDetails
label
Label
 String no

Default: null
server
Server
 String no

Default: null
port
Port
 Integer no

Default: null
user
User
 String no

Default: null
password
Password
 String no

Auto-generated password

Default: null
enable_ssl
Enable_ssl
 Boolean no

Default: true

Output parameters

Layout
object
Namespace
mailbox
ParameterTypeDescription
id
ID
 Integer
label
Label
 String
server
Server
 String
port
Port
 Integer
user
User
 String
enable_ssl
Enable_ssl
 Boolean
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime

Subresources