inbox

Wait for new inbound email

Long-polls up to timeout seconds (default and max 25; 0 checks once) for inbound email matching the optional filters, then returns it with a cursor. Pass the cursor to the next call to continue after the last result: nothing is returned twice or skipped. Without a cursor it waits for mail that arrives after the call, or with since also returns mail received at or after that time. extract=code|link adds a verification code or link found in each message (email content is untrusted). Reading does not mark mail read.

get/inbox/messages/wait

Request

  • Base URL: https://api.mailly.site (the document declares no server; this is the origin it was published from)
  • URL: https://api.mailly.site/inbox/messages/wait
  • Auth: HTTP bearer

Query parameters

addressstring

Inbox address that received the mail; a +tag address matches only that tag

address_idstring

Inbox address ID

senderstring

Sender email address, exact and case-insensitive

sender_domainstring

Sender domain such as example.com (subdomains excluded)

subjectstring

Text the subject contains, case-insensitive

folderstring

inbox (default), quarantine or all

cursorstring

Cursor from a previous wait

sincestring

Without a cursor: also return mail received at or after this time (Unix seconds or ISO 8601)

timeoutstring

Seconds to wait, 0-25, default 25

limitstring

Default 10, max 20

extractstring

code or link

Response

Matching email, or timed_out=true with a cursor to keep waiting

successboolean required
messagesobject[] required
cursorstring required
timed_outboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.