Stream only User-scoped folder invalidations so Mail badges can refresh after durable cache changes. The initial event and lag recovery both ask the client to reread snapshots; message contents never enter this stream (#771).

GET

/api/v1/mail/events

const url = 'https://example.com/api/v1/mail/events';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/mail/events \
  --header 'Authorization: Bearer <token>'

Route: /api/v1/mail/events. Inputs: . Safe reads can use bounded retries.

Authorizations

installationBearer
browserSession

Responses

200

User-scoped Mail folder invalidation stream

text/event-stream

429

application/json

The standard API error response: { "error": { ... } }.

object

error

required

Error details.

object

code

required

Stable machine-readable code.

string

Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable

details

One of:

object
null

Optional field or operation details.

object

key

additional properties

string

message

required

Safe text for logs or a user-facing error message.

string

Example

{
  "error": {
    "code": "bad_request"
  }
}