Globals / SentEmailsControllerApi
# Class: SentEmailsControllerApi
SentEmailsControllerApi - object-oriented interface
export
# Hierarchy
-
↳ SentEmailsControllerApi
# Index
# Constructors
# Properties
# Methods
# Constructors
# constructor
+ new SentEmailsControllerApi(configuration?: Configuration, basePath?: string, fetch?: FetchAPI): SentEmailsControllerApi
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: SentEmailsControllerApi
# 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
Defined in src/generated/api.ts:62 (opens new window)
# Methods
# getSentEmail
▸ getSentEmail(id: string, options?: any): Promise<SentEmailDto>
Defined in src/generated/api.ts:12518 (opens new window)
summary Get sent email receipt
throws {RequiredError}
memberof SentEmailsControllerApi
# Parameters:
| Name | Type | Description |
|---|---|---|
id | string | id |
options? | any | - |
Returns: Promise<SentEmailDto>
# getSentEmails
▸ getSentEmails(inboxId?: string, page?: number, size?: number, sort?: "ASC" | "DESC", options?: any): Promise<PageSentEmailProjection>
Defined in src/generated/api.ts:12536 (opens new window)
summary Get all sent emails in paginated form
throws {RequiredError}
memberof SentEmailsControllerApi
# Parameters:
| Name | Type |
|---|---|
inboxId? | string |
page? | number |
size? | number |
sort? | "ASC" |
options? | any |
Returns: Promise<PageSentEmailProjection>
