Class MailAPI

Hierarchy (View Summary)

BaseAPI
- MailAPI

Index

Constructors

Properties

Methods

changes get query queryChanges set

Constructors

constructor

new MailAPI(client: JMAPClient): MailAPI
Parameters
- client: JMAPClient
Returns MailAPI
Inherited from BaseAPI.constructor
- Defined in api/base.ts:4

Properties

`Protected`client

client: JMAPClient

Methods

changes

changes(
args: ChangesRequest,
): Promise<Response<ProblemDetails | MailChangesResponse>>
RFC 8621 (2.2) - https://datatracker.ietf.org/doc/html/rfc8621#section-2.2
Parameters
- args: ChangesRequest
Returns Promise<Response<ProblemDetails | MailChangesResponse>>
- Defined in api/mailbox.ts:19

get

get(
args: GetRequest,
): Promise<Response<ProblemDetails | GetResponse<Mailbox[]>>>
RFC 8621 (2.1) - https://datatracker.ietf.org/doc/html/rfc8621#section-2.1
Parameters
- args: GetRequest
Returns Promise<Response<ProblemDetails | GetResponse<Mailbox[]>>>
- Defined in api/mailbox.ts:9

query

query(args: MailQueryRequest): Promise<Response<ProblemDetails | QueryResponse>>
RFC 8621 (2.3) - https://datatracker.ietf.org/doc/html/rfc8621#section-2.3
Parameters
- args: MailQueryRequest
Returns Promise<Response<ProblemDetails | QueryResponse>>
- Defined in api/mailbox.ts:29

queryChanges

queryChanges(
args: QueryChangesRequest,
): Promise<Response<ProblemDetails | QueryChangesResponse>>
RFC 8621 (2.4) - https://datatracker.ietf.org/doc/html/rfc8621#section-2.4
Parameters
- args: QueryChangesRequest
Returns Promise<Response<ProblemDetails | QueryChangesResponse>>
- Defined in api/mailbox.ts:39

set

set(args: SetRequest): Promise<Response<ProblemDetails | MailSetResponse>>
RFC 8621 (2.5) - https://datatracker.ietf.org/doc/html/rfc8621#section-2.5
Parameters
- args: SetRequest
Returns Promise<Response<ProblemDetails | MailSetResponse>>
- Defined in api/mailbox.ts:49