Mailbox

List Inbound Emails

Changed on

Retrieve a paginated list of received inbound emails with filtering, search, and sorting options.

get/api/mailbox/

Request

Query parameters

pageinteger

Page number

page_sizeinteger

Number of items per page

status'pending' | 'success' | 'failed'

Filter by status: pending, success, or failed. Takes precedence over processed if both are provided.

processedboolean nullable

Filter by processing status. If not provided, returns all. Ignored when status is set.

received_fromstring date-time nullable

Inclusive lower bound on received date (falls back to created_at when received_at is null)

received_tostring date-time nullable

Inclusive upper bound on received date (falls back to created_at when received_at is null)

searchstring nullable

Case-insensitive search across sender email, subject, message ID, and attachment filenames

sort_by'received_at' | 'created_at'

Field to sort by

sort_order'asc' | 'desc'

Sort order options.

Sort direction (asc/desc)

Response

Successful Response

totalinteger required
pageinteger required
page_sizeinteger required
pagesinteger required
has_next_pageboolean required

Changes