Desk
Messages that have arrived for one mailbox
Reads the objects written under this team's prefix for one address, in the store the mailbox was bound in. The prefix is derived from the team in the session and the address given, never taken from the caller, so no address can be used to read another team's mail. A page is at most 100 messages and an object that does not parse is counted rather than dropped.
get/api/v1/mail/inbox
Request
- Base URL: http://localhost:5180
- URL: http://localhost:5180/api/v1/mail/inbox
- Auth: API key in cookie better-auth.session_token
Query parameters
addressstring required
The mailbox to read, exactly as it is on the mailbox record.
afterstring
The cursor from the previous page. Absent for the first page.
limitinteger
How many messages to read. Default 50, never more than 100.
Response
One page of messages.
Changes
No recorded changes to this operation across all 1 revision of this API.