AgentController
List scoped inbox emails for an agent
Returns paginated email previews for one inbox after checking the agent key has AGENT_READ_EMAIL and is scoped to the inbox.
get/agent/inboxes/{inboxId}/emails
Request
- Base URL: https://api.mailslurp.com
- URL: https://api.mailslurp.com/agent/inboxes/{inboxId}/emails
- Auth: API key in header x-api-key
Path parameters
inboxIdstring uuid required
ID of inbox the agent may read
Query parameters
pageinteger
Optional page index in inbox emails list pagination
sizeinteger
Optional page size in inbox emails list pagination
sort'ASC' | 'DESC'
Optional createdAt sort direction ASC or DESC
sincestring date-time
Optional filter by received after given date time
beforestring date-time
Optional filter by received before given date time
syncConnectorsboolean
Sync connectors before fetching emails
Response
OK
Changes
No recorded changes to this operation across all 1 revision of this API.