Class EmailSubmissionAPI

Hierarchy (View Summary)

BaseAPI
- EmailSubmissionAPI

Index

Constructors

Properties

Methods

changes get query queryChanges set

Constructors

constructor

new EmailSubmissionAPI(client: JMAPClient): EmailSubmissionAPI
Parameters
- client: JMAPClient
Returns EmailSubmissionAPI
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 (7.2) - https://datatracker.ietf.org/doc/html/rfc8621#section-7.2
Parameters
- args: ChangesRequest
Returns Promise<Response<ProblemDetails | ChangesResponse>>
- Defined in api/emailSubmission.ts:22

get

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

query

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

queryChanges

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

set

set(
args: EmailSubmissionSetRequest,
): Promise<Response<ProblemDetails | SetResponse>>
RFC 8621 (7.5) - https://datatracker.ietf.org/doc/html/rfc8621#section-7.5
Parameters
- args: EmailSubmissionSetRequest
Returns Promise<Response<ProblemDetails | SetResponse>>
- Defined in api/emailSubmission.ts:64