Skip to content

mailbox.handler

Manage mailbox handlers

Create

Path
POST /v7.0/mailboxes/{mailbox_id}/handler
Description
Add mailbox handler
Authentication required
yes
Scope
mailbox.handler#create
Aliases
new
Blocking
no

Input parameters

Layout
object
Namespace
handler
ParameterTypeRequiredDetails
class_name
Class_name
 String yes

Search by concerned class name

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
order
Order
 Integer no

Template order

Default: null
continue
Continue
 Boolean no

Default: null

Output parameters

Layout
object
Namespace
handler
ParameterTypeDescription
id
Id
 Integer
class_name
Class_name
 String Search by concerned class name
order
Order
 Integer Template order
continue
Continue
 Boolean
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime

Delete

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

Input parameters

No parameters.

Output parameters

No parameters.

Index

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

Input parameters

Layout
object
Namespace
handler
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
handlers
ParameterTypeDescription
id
Id
 Integer
class_name
Class_name
 String Search by concerned class name
order
Order
 Integer Template order
continue
Continue
 Boolean
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime

Show

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

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
handler
ParameterTypeDescription
id
Id
 Integer
class_name
Class_name
 String Search by concerned class name
order
Order
 Integer Template order
continue
Continue
 Boolean
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime

Update

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

Input parameters

Layout
object
Namespace
handler
ParameterTypeRequiredDetails
class_name
Class_name
 String no

Search by concerned class name

Default: null
order
Order
 Integer no

Template order

Default: null
continue
Continue
 Boolean no

Default: null

Output parameters

Layout
object
Namespace
handler
ParameterTypeDescription
id
Id
 Integer
class_name
Class_name
 String Search by concerned class name
order
Order
 Integer Template order
continue
Continue
 Boolean
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime