MailSlurp JS

Globals / ExpiredControllerApi

Class: ExpiredControllerApi

ExpiredControllerApi - object-oriented interface

export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Inherited from BaseAPI.constructor

Defined in src/generated/api.ts:57

Parameters:

NameTypeDefault value
configuration?Configuration-
basePathstringBASE_PATH
fetchFetchAPIportableFetch

Returns: ExpiredControllerApi

Properties

basePath

Protected basePath: string

Inherited from BaseAPI.basePath

Defined in src/generated/api.ts:61


configuration

Protected configuration: Configuration

Inherited from BaseAPI.configuration

Defined in src/generated/api.ts:57


fetch

Protected fetch: FetchAPI

Inherited from BaseAPI.fetch

Defined in src/generated/api.ts:62

Methods

getExpirationDefaults

getExpirationDefaults(options?: any): Promise<ExpirationDefaults>

Defined in src/generated/api.ts:16270

Return default times used for inbox expiration

summary Get default expiration settings

throws {RequiredError}

memberof ExpiredControllerApi

Parameters:

NameType
options?any

Returns: Promise<ExpirationDefaults>


getExpiredInboxByInboxId

getExpiredInboxByInboxId(inboxId: string, options?: any): Promise<ExpiredInboxDto>

Defined in src/generated/api.ts:16284

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

summary Get expired inbox record for a previously existing inbox

throws {RequiredError}

memberof ExpiredControllerApi

Parameters:

NameTypeDescription
inboxIdstringID of inbox you want to retrieve (not the inbox ID)
options?any-

Returns: Promise<ExpiredInboxDto>


getExpiredInboxRecord

getExpiredInboxRecord(expiredId: string, options?: any): Promise<ExpiredInboxDto>

Defined in src/generated/api.ts:16298

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

summary Get an expired inbox record

throws {RequiredError}

memberof ExpiredControllerApi

Parameters:

NameTypeDescription
expiredIdstringID of the ExpiredInboxRecord you want to retrieve. This is different from the ID of the inbox you are interested in. See other methods for getting ExpiredInboxRecord for an inbox inboxId)
options?any-

Returns: Promise<ExpiredInboxDto>


getExpiredInboxes

getExpiredInboxes(page?: number, size?: number, sort?: “ASC” | “DESC”, options?: any): Promise<PageExpiredInboxRecordProjection>

Defined in src/generated/api.ts:16315

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

summary List records of expired inboxes

throws {RequiredError}

memberof ExpiredControllerApi

Parameters:

NameType
page?number
size?number
sort?“ASC”
options?any

Returns: Promise<PageExpiredInboxRecordProjection>