Skip to main content
POST
Search email account at provider

Authorizations

Authorization
string
header
required

Access token issued by gtm.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.

Team-SID
string
header
required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Headers

Email-Box-SID
string

Email server (em_bx_...) the call is for, from search_email_boxes. Omitted: the primary server.

Pattern: ^em_bx_[A-Za-z0-9]{12}$

Path Parameters

sid
string
required

Path segment {sid}.

Required string length: 18
Pattern: ^em_ac_

Body

application/json

Request body of search_email_account_provider.

q
string
required

Words, matched where the provider matches them: subject, body, participants. Plain words, not the provider's query syntax.

Required string length: 1 - 128
email_folder_sid
string | null

Search this folder of the mailbox alone. Default: the whole mailbox (the inbox on a plain IMAP server).

Required string length: 18
Pattern: ^em_fd_
since
string | null

ISO 8601 date, inclusive.

before
string | null

ISO 8601 date, after since.

limit
integer | null

1 to 50. Default 20.

Required range: 1 <= x <= 50

Response

action success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
action
action
string
required

kebab-case verb; matches the route segment.

item
object | null
required
result
object
required
meta
object
required