Skip to main content

Module methods

Module methods 

Source
Expand description

Typed JMAP Mail method wrappers — response types, SessionClient, constants, and helpers.

Response types mirror RFC 8620 standard shapes (§5.1 /get, §5.5 /query, §5.2 /changes, §5.3 /set). Method implementations live in sub-modules and operate on SessionClient.

Modules§

email
JMAP Mail — Email/* method implementations on SessionClient.
identity
JMAP Mail — Identity/* method implementations on SessionClient.
mailbox
JMAP Mail — Mailbox/* method implementations on SessionClient.
search_snippet
JMAP Mail — SearchSnippet/get method implementation on SessionClient.
submission
JMAP Mail — EmailSubmission/* method implementations on SessionClient.
thread
JMAP Mail — Thread/* method implementations on SessionClient.
vacation
JMAP Mail — VacationResponse/get and VacationResponse/set implementations on SessionClient.

Structs§

AddedItem
A single item added to a query result set (RFC 8620 §5.6).
ChangesResponse
RFC 8620 §5.2 — Foo/changes response shape.
EmailCopyParams
Extra args for Email/copy (RFC 8621 §4.7).
EmailGetParams
Extra args for Email/get (RFC 8621 §4.1.8).
EmailImportCreated
Per-creation success entry in an EmailImportResponse (RFC 8621 §4.8).
EmailImportInput
Per-creation EmailImport object for Email/import (RFC 8621 §4.8).
EmailImportResponse
Response to Email/import (RFC 8621 §4.8).
EmailParseParams
Extra args for Email/parse (RFC 8621 §4.9).
EmailParseResponse
Response to Email/parse (RFC 8621 §4.9).
EmailSubmissionSetParams
Extra args for EmailSubmission/set (RFC 8621 §7.5).
GetResponse
RFC 8620 §5.1 — Foo/get response shape.
MailboxSetParams
Extra args for Mailbox/set (RFC 8621 §2.5).
QueryChangesResponse
RFC 8620 §5.6 — Foo/queryChanges response shape.
QueryResponse
RFC 8620 §5.5 — Foo/query response shape.
SessionClient
A JmapClient bound to a JMAP session.
SetError
A per-item failure in a /set response (RFC 8620 §5.3).
SetResponse
RFC 8620 §5.3 — Foo/set response shape.