MailSlurp JS

Globals / ExpiredControllerApi

# Class: ExpiredControllerApi

ExpiredControllerApi - object-oriented interface

export

# Hierarchy

# Index

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new ExpiredControllerApi(configuration?: Configuration, basePath?: string, fetch?: FetchAPI): ExpiredControllerApi

Inherited from BaseAPI.constructor

Defined in src/generated/api.ts:57 (opens new window)

# Parameters:

Name Type Default value
configuration? Configuration -
basePath string BASE_PATH
fetch FetchAPI portableFetch

Returns: ExpiredControllerApi

# Properties

# basePath

Protected basePath: string

Inherited from BaseAPI.basePath

Defined in src/generated/api.ts:61 (opens new window)


# configuration

Protected configuration: Configuration

Inherited from BaseAPI.configuration

Defined in src/generated/api.ts:57 (opens new window)


# fetch

Protected fetch: FetchAPI

Inherited from BaseAPI.fetch

Defined in src/generated/api.ts:62 (opens new window)

# Methods

# getExpiredInboxByInboxId

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

Defined in src/generated/api.ts:10888 (opens new window)

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:

Name Type Description
inboxId string ID 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:10902 (opens new window)

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:

Name Type Description
expiredId string ID 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:10919 (opens new window)

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:

Name Type
page? number
size? number
sort? "ASC"
options? any

Returns: Promise<PageExpiredInboxRecordProjection>