Skip to content

Class: ExpiredControllerApi

Hierarchy

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new ExpiredControllerApi(configuration?)

Parameters

Name Type
configuration Configuration

Inherited from

BaseAPI.constructor

Properties

configuration

Protected configuration: Configuration

Inherited from

BaseAPI.configuration

Methods

getExpirationDefaults

getExpirationDefaults(initOverrides?): Promise<ExpirationDefaults>

Return default times used for inbox expiration Get default expiration settings

Parameters

Name Type
initOverrides? RequestInit

Returns

Promise<ExpirationDefaults>


getExpirationDefaultsRaw

getExpirationDefaultsRaw(initOverrides?): Promise<ApiResponse<ExpirationDefaults>>

Return default times used for inbox expiration Get default expiration settings

Parameters

Name Type
initOverrides? RequestInit

Returns

Promise<ApiResponse<ExpirationDefaults>>


getExpiredInboxByInboxId

getExpiredInboxByInboxId(requestParameters, initOverrides?): Promise<ExpiredInboxDto>

Use the inboxId to return an ExpiredInboxRecord if an inbox has expired. Inboxes expire and are disabled if an expiration date is set or plan requires. Returns 404 if no expired inbox is found for the inboxId Get expired inbox record for a previously existing inbox

Parameters

Name Type
requestParameters GetExpiredInboxByInboxIdRequest
initOverrides? RequestInit

Returns

Promise<ExpiredInboxDto>


getExpiredInboxByInboxIdRaw

getExpiredInboxByInboxIdRaw(requestParameters, initOverrides?): Promise<ApiResponse<ExpiredInboxDto>>

Use the inboxId to return an ExpiredInboxRecord if an inbox has expired. Inboxes expire and are disabled if an expiration date is set or plan requires. Returns 404 if no expired inbox is found for the inboxId Get expired inbox record for a previously existing inbox

Parameters

Name Type
requestParameters GetExpiredInboxByInboxIdRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<ExpiredInboxDto>>


getExpiredInboxRecord

getExpiredInboxRecord(requestParameters, initOverrides?): Promise<ExpiredInboxDto>

Inboxes created with an expiration date will expire after the given date and be moved to an ExpiredInbox entity. You can still read emails in the inbox but it can no longer send or receive emails. Fetch the expired inboxes to view the old inboxes properties Get an expired inbox record

Parameters

Name Type
requestParameters GetExpiredInboxRecordRequest
initOverrides? RequestInit

Returns

Promise<ExpiredInboxDto>


getExpiredInboxRecordRaw

getExpiredInboxRecordRaw(requestParameters, initOverrides?): Promise<ApiResponse<ExpiredInboxDto>>

Inboxes created with an expiration date will expire after the given date and be moved to an ExpiredInbox entity. You can still read emails in the inbox but it can no longer send or receive emails. Fetch the expired inboxes to view the old inboxes properties Get an expired inbox record

Parameters

Name Type
requestParameters GetExpiredInboxRecordRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<ExpiredInboxDto>>


getExpiredInboxes

getExpiredInboxes(requestParameters, initOverrides?): Promise<PageExpiredInboxRecordProjection>

Inboxes created with an expiration date will expire after the given date. An ExpiredInboxRecord is created that records the inboxes old ID and email address. You can still read emails in the inbox (using the inboxes old ID) but the email address associated with the inbox can no longer send or receive emails. Fetch expired inbox records to view the old inboxes properties List records of expired inboxes

Parameters

Name Type
requestParameters GetExpiredInboxesRequest
initOverrides? RequestInit

Returns

Promise<PageExpiredInboxRecordProjection>


getExpiredInboxesRaw

getExpiredInboxesRaw(requestParameters, initOverrides?): Promise<ApiResponse<PageExpiredInboxRecordProjection>>

Inboxes created with an expiration date will expire after the given date. An ExpiredInboxRecord is created that records the inboxes old ID and email address. You can still read emails in the inbox (using the inboxes old ID) but the email address associated with the inbox can no longer send or receive emails. Fetch expired inbox records to view the old inboxes properties List records of expired inboxes

Parameters

Name Type
requestParameters GetExpiredInboxesRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<PageExpiredInboxRecordProjection>>


request

Protected request(context, initOverrides?): Promise<Response>

Parameters

Name Type
context RequestOpts
initOverrides? RequestInit

Returns

Promise<Response>

Inherited from

BaseAPI.request


withMiddleware

withMiddleware<T>(...middlewares): T

Type parameters

Name Type
T extends BaseAPI<T>

Parameters

Name Type
...middlewares Middleware[]

Returns

T

Inherited from

BaseAPI.withMiddleware


withPostMiddleware

withPostMiddleware<T>(...postMiddlewares): T

Type parameters

Name Type
T extends BaseAPI<T>

Parameters

Name Type
...postMiddlewares (context: ResponseContext) => Promise<void

Returns

T

Inherited from

BaseAPI.withPostMiddleware


withPreMiddleware

withPreMiddleware<T>(...preMiddlewares): T

Type parameters

Name Type
T extends BaseAPI<T>

Parameters

Name Type
...preMiddlewares (context: RequestContext) => Promise<void

Returns

T

Inherited from

BaseAPI.withPreMiddleware