Class MailboxApi

Hierarchy (View Summary)

BaseAPI
- MailboxApi

Index

Constructors

Properties

Methods

createMailbox createMailboxRaw deleteMailbox deleteMailboxRaw getMailboxes getMailboxesRaw isJsonMime request updateMailbox updateMailboxRaw withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

new MailboxApi(configuration?: Configuration): MailboxApi
Parameters
- configuration: Configuration = DefaultConfig
Returns MailboxApi
Inherited from BaseAPI.constructor
- Defined in sdk/runtime.ts:104

Properties

`Protected`configuration

configuration: Configuration = DefaultConfig

Methods

createMailbox

createMailbox(
requestParameters: CreateMailboxRequest,
initOverrides?: any,
): Promise<Mailbox>
Create a new mailbox Create mailbox
Parameters
- requestParameters: CreateMailboxRequest
- OptionalinitOverrides: any
Returns Promise<Mailbox>
- Defined in sdk/apis/MailboxApi.ts:99

createMailboxRaw

createMailboxRaw(
requestParameters: CreateMailboxRequest,
initOverrides?: any,
): Promise<ApiResponse<Mailbox>>
Create a new mailbox Create mailbox
Parameters
- requestParameters: CreateMailboxRequest
- OptionalinitOverrides: any
Returns Promise<ApiResponse<Mailbox>>
- Defined in sdk/apis/MailboxApi.ts:63

deleteMailbox

deleteMailbox(
requestParameters: DeleteMailboxRequest,
initOverrides?: any,
): Promise<void>
Delete specific mailbox by id. Delete mailbox
Parameters
- requestParameters: DeleteMailboxRequest
- OptionalinitOverrides: any
Returns Promise<void>
- Defined in sdk/apis/MailboxApi.ts:142

deleteMailboxRaw

deleteMailboxRaw(
requestParameters: DeleteMailboxRequest,
initOverrides?: any,
): Promise<ApiResponse<void>>
Delete specific mailbox by id. Delete mailbox
Parameters
- requestParameters: DeleteMailboxRequest
- OptionalinitOverrides: any
Returns Promise<ApiResponse<void>>
- Defined in sdk/apis/MailboxApi.ts:108

getMailboxes

getMailboxes(initOverrides?: any): Promise<MailboxModelArray>
Get user mailboxes. Get mailboxes
Parameters
- OptionalinitOverrides: any
Returns Promise<MailboxModelArray>
- Defined in sdk/apis/MailboxApi.ts:176

getMailboxesRaw

getMailboxesRaw(initOverrides?: any): Promise<ApiResponse<MailboxModelArray>>
Get user mailboxes. Get mailboxes
Parameters
- OptionalinitOverrides: any
Returns Promise<ApiResponse<MailboxModelArray>>
- Defined in sdk/apis/MailboxApi.ts:150

`Protected`isJsonMime

isJsonMime(mime: string | null | undefined): boolean
Check if the given MIME is a JSON MIME. JSON MIME examples: application/json application/json; charset=UTF8 APPLICATION/JSON application/vnd.company+json
Parameters
- mime: string | null | undefined
  MIME (Multipurpose Internet Mail Extensions)
Returns boolean
True if the given MIME is JSON, false otherwise.
Inherited from BaseAPI.isJsonMime
- Defined in sdk/runtime.ts:134

`Protected`request

request(context: RequestOpts, initOverrides?: any): Promise<any>
Parameters
- context: RequestOpts
- OptionalinitOverrides: any
Returns Promise<any>
Inherited from BaseAPI.request
- Defined in sdk/runtime.ts:141

updateMailbox

updateMailbox(
requestParameters: UpdateMailboxRequest,
initOverrides?: any,
): Promise<void>
Update specific mailbox by id. Update mailbox
Parameters
- requestParameters: UpdateMailboxRequest
- OptionalinitOverrides: any
Returns Promise<void>
- Defined in sdk/apis/MailboxApi.ts:229

updateMailboxRaw

updateMailboxRaw(
requestParameters: UpdateMailboxRequest,
initOverrides?: any,
): Promise<ApiResponse<void>>
Update specific mailbox by id. Update mailbox
Parameters
- requestParameters: UpdateMailboxRequest
- OptionalinitOverrides: any
Returns Promise<ApiResponse<void>>
- Defined in sdk/apis/MailboxApi.ts:185

withMiddleware

withMiddleware<T extends BaseAPI>(this: T, ...middlewares: Middleware[]): T
Type Parameters
- T extends BaseAPI
Parameters
- this: T
- ...middlewares: Middleware[]
Returns T
Inherited from BaseAPI.withMiddleware
- Defined in sdk/runtime.ts:108

withPostMiddleware

withPostMiddleware<T extends BaseAPI>(
    this: T,
    ...postMiddlewares: (
        ((context: ResponseContext) => Promise<any>)
        | undefined
    )[],
): T
Type Parameters
- T extends BaseAPI
Parameters
- this: T
- ...postMiddlewares: (((context: ResponseContext) => Promise<any>) | undefined)[]
Returns T
Inherited from BaseAPI.withPostMiddleware
- Defined in sdk/runtime.ts:119

withPreMiddleware

withPreMiddleware<T extends BaseAPI>(
    this: T,
    ...preMiddlewares: (
        ((context: RequestContext) => Promise<void | FetchParams>)
        | undefined
    )[],
): T
Type Parameters
- T extends BaseAPI
Parameters
- this: T
- ...preMiddlewares: (((context: RequestContext) => Promise<void | FetchParams>) | undefined)[]
Returns T
Inherited from BaseAPI.withPreMiddleware
- Defined in sdk/runtime.ts:114