Class EmailAPI

Hierarchy (View Summary)

BaseAPI
- EmailAPI

Index

Constructors

Properties

Methods

changes copy get import parse query queryChanges set

Constructors

constructor

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

Properties

`Protected`client

client: JMAPClient

Methods

changes

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

copy

copy(args: CopyRequest): Promise<Response<ProblemDetails | CopyResponse>>
RFC 8621 (4.7) - https://datatracker.ietf.org/doc/html/rfc8621#section-4.7
Parameters
- args: CopyRequest
Returns Promise<Response<ProblemDetails | CopyResponse>>
- Defined in api/email.ts:59

get

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

import

import(args: CopyRequest): Promise<Response<ProblemDetails | CopyResponse>>
RFC 8621 (4.8) - https://datatracker.ietf.org/doc/html/rfc8621#section-4.8
Parameters
- args: CopyRequest
Returns Promise<Response<ProblemDetails | CopyResponse>>
- Defined in api/email.ts:69

parse

parse(
args: EmailParseRequest,
): Promise<Response<ProblemDetails | EmailParseResponse>>
RFC 8621 (4.9) - https://datatracker.ietf.org/doc/html/rfc8621#section-4.9
Parameters
- args: EmailParseRequest
Returns Promise<Response<ProblemDetails | EmailParseResponse>>
- Defined in api/email.ts:79

query

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

queryChanges

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

set

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