Class ImapControllerApi

Hierarchy

BaseAPI
- ImapControllerApi

Index

Constructors

Properties

Methods

imapServerFetch imapServerFetchRaw imapServerGet imapServerGetRaw imapServerList imapServerListRaw imapServerSearch imapServerSearchRaw imapServerStatus imapServerStatusRaw imapServerUpdateFlags imapServerUpdateFlagsRaw request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

new ImapControllerApi(configuration?: Configuration): ImapControllerApi
Parameters
- configuration: Configuration = ...
Returns ImapControllerApi

Inherited from BaseAPI.constructor

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

imapServerFetch

imapServerFetch(requestParameters: ImapServerFetchRequest, initOverrides?: RequestInit): Promise<ImapServerFetchResult>
Fetch message in an inbox
Parameters
- requestParameters: ImapServerFetchRequest
- Optional initOverrides: RequestInit
Returns Promise<ImapServerFetchResult>

imapServerFetchRaw

imapServerFetchRaw(requestParameters: ImapServerFetchRequest, initOverrides?: RequestInit): Promise<ApiResponse<ImapServerFetchResult>>
Fetch message in an inbox
Parameters
- requestParameters: ImapServerFetchRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<ImapServerFetchResult>>

imapServerGet

imapServerGet(requestParameters: ImapServerGetRequest, initOverrides?: RequestInit): Promise<ImapServerGetResult>
Get a message by email ID
Parameters
- requestParameters: ImapServerGetRequest
- Optional initOverrides: RequestInit
Returns Promise<ImapServerGetResult>

imapServerGetRaw

imapServerGetRaw(requestParameters: ImapServerGetRequest, initOverrides?: RequestInit): Promise<ApiResponse<ImapServerGetResult>>
Get a message by email ID
Parameters
- requestParameters: ImapServerGetRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<ImapServerGetResult>>

imapServerList

imapServerList(requestParameters: ImapServerListRequest, initOverrides?: RequestInit): Promise<ImapServerListResult>
List messages in an inbox
Parameters
- requestParameters: ImapServerListRequest
- Optional initOverrides: RequestInit
Returns Promise<ImapServerListResult>

imapServerListRaw

imapServerListRaw(requestParameters: ImapServerListRequest, initOverrides?: RequestInit): Promise<ApiResponse<ImapServerListResult>>
List messages in an inbox
Parameters
- requestParameters: ImapServerListRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<ImapServerListResult>>

imapServerSearch

imapServerSearch(requestParameters: ImapServerSearchRequest, initOverrides?: RequestInit): Promise<ImapServerSearchResult>
Search messages in an inbox
Parameters
- requestParameters: ImapServerSearchRequest
- Optional initOverrides: RequestInit
Returns Promise<ImapServerSearchResult>

imapServerSearchRaw

imapServerSearchRaw(requestParameters: ImapServerSearchRequest, initOverrides?: RequestInit): Promise<ApiResponse<ImapServerSearchResult>>
Search messages in an inbox
Parameters
- requestParameters: ImapServerSearchRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<ImapServerSearchResult>>

imapServerStatus

imapServerStatus(requestParameters: ImapServerStatusRequest, initOverrides?: RequestInit): Promise<ImapServerStatusResult>
Get status for mailbox
Parameters
- requestParameters: ImapServerStatusRequest
- Optional initOverrides: RequestInit
Returns Promise<ImapServerStatusResult>

imapServerStatusRaw

imapServerStatusRaw(requestParameters: ImapServerStatusRequest, initOverrides?: RequestInit): Promise<ApiResponse<ImapServerStatusResult>>
Get status for mailbox
Parameters
- requestParameters: ImapServerStatusRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<ImapServerStatusResult>>

imapServerUpdateFlags

imapServerUpdateFlags(requestParameters: ImapServerUpdateFlagsRequest, initOverrides?: RequestInit): Promise<void>
Update message flags
Parameters
- requestParameters: ImapServerUpdateFlagsRequest
- Optional initOverrides: RequestInit
Returns Promise<void>

imapServerUpdateFlagsRaw

imapServerUpdateFlagsRaw(requestParameters: ImapServerUpdateFlagsRequest, initOverrides?: RequestInit): Promise<ApiResponse<void>>
Update message flags
Parameters
- requestParameters: ImapServerUpdateFlagsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>

`Protected` request

request(context: RequestOpts, initOverrides?: RequestInit): Promise<Response>
Parameters
- context: RequestOpts
- Optional initOverrides: RequestInit
Returns Promise<Response>

Inherited from BaseAPI.request

withMiddleware

withMiddleware<T>(this: T, ...middlewares: Middleware[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...middlewares: Middleware[]
Returns T

Inherited from BaseAPI.withMiddleware

withPostMiddleware

withPostMiddleware<T>(this: T, ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]
Returns T

Inherited from BaseAPI.withPostMiddleware

withPreMiddleware

withPreMiddleware<T>(this: T, ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]
Returns T

Inherited from BaseAPI.withPreMiddleware