Skip to content

Class: SentEmailsControllerApi

Hierarchy

  • BaseAPI

    SentEmailsControllerApi

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new SentEmailsControllerApi(configuration?)

Parameters

Name Type
configuration Configuration

Inherited from

BaseAPI.constructor

Properties

configuration

Protected configuration: Configuration

Inherited from

BaseAPI.configuration

Methods

deleteAllSentEmails

deleteAllSentEmails(initOverrides?): Promise<void>

Delete all sent email receipts

Parameters

Name Type
initOverrides? RequestInit

Returns

Promise<void>


deleteAllSentEmailsRaw

deleteAllSentEmailsRaw(initOverrides?): Promise<ApiResponse<void>>

Delete all sent email receipts

Parameters

Name Type
initOverrides? RequestInit

Returns

Promise<ApiResponse<void>>


deleteSentEmail

deleteSentEmail(requestParameters, initOverrides?): Promise<void>

Delete sent email receipt

Parameters

Name Type
requestParameters DeleteSentEmailRequest
initOverrides? RequestInit

Returns

Promise<void>


deleteSentEmailRaw

deleteSentEmailRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>

Delete sent email receipt

Parameters

Name Type
requestParameters DeleteSentEmailRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<void>>


getAllSentTrackingPixels

getAllSentTrackingPixels(requestParameters, initOverrides?): Promise<PageTrackingPixelProjection>

Get all sent email tracking pixels in paginated form

Parameters

Name Type
requestParameters GetAllSentTrackingPixelsRequest
initOverrides? RequestInit

Returns

Promise<PageTrackingPixelProjection>


getAllSentTrackingPixelsRaw

getAllSentTrackingPixelsRaw(requestParameters, initOverrides?): Promise<ApiResponse<PageTrackingPixelProjection>>

Get all sent email tracking pixels in paginated form

Parameters

Name Type
requestParameters GetAllSentTrackingPixelsRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<PageTrackingPixelProjection>>


getRawSentEmailContents

getRawSentEmailContents(requestParameters, initOverrides?): Promise<string>

Returns a raw, unparsed, and unprocessed sent email. If your client has issues processing the response it is likely due to the response content-type which is text/plain. If you need a JSON response content-type use the getRawSentEmailJson endpoint Get raw sent email string. Returns unparsed raw SMTP message with headers and body.

Parameters

Name Type
requestParameters GetRawSentEmailContentsRequest
initOverrides? RequestInit

Returns

Promise<string>


getRawSentEmailContentsRaw

getRawSentEmailContentsRaw(requestParameters, initOverrides?): Promise<ApiResponse<string>>

Returns a raw, unparsed, and unprocessed sent email. If your client has issues processing the response it is likely due to the response content-type which is text/plain. If you need a JSON response content-type use the getRawSentEmailJson endpoint Get raw sent email string. Returns unparsed raw SMTP message with headers and body.

Parameters

Name Type
requestParameters GetRawSentEmailContentsRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<string>>


getRawSentEmailJson

getRawSentEmailJson(requestParameters, initOverrides?): Promise<RawEmailJson>

Returns a raw, unparsed, and unprocessed sent email wrapped in a JSON response object for easier handling when compared with the getRawSentEmail text/plain response Get raw sent email in JSON. Unparsed SMTP message in JSON wrapper format.

Parameters

Name Type
requestParameters GetRawSentEmailJsonRequest
initOverrides? RequestInit

Returns

Promise<RawEmailJson>


getRawSentEmailJsonRaw

getRawSentEmailJsonRaw(requestParameters, initOverrides?): Promise<ApiResponse<RawEmailJson>>

Returns a raw, unparsed, and unprocessed sent email wrapped in a JSON response object for easier handling when compared with the getRawSentEmail text/plain response Get raw sent email in JSON. Unparsed SMTP message in JSON wrapper format.

Parameters

Name Type
requestParameters GetRawSentEmailJsonRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<RawEmailJson>>


getSentDeliveryStatus

getSentDeliveryStatus(requestParameters, initOverrides?): Promise<DeliveryStatusDto>

Get a sent email delivery status

Parameters

Name Type
requestParameters GetSentDeliveryStatusRequest
initOverrides? RequestInit

Returns

Promise<DeliveryStatusDto>


getSentDeliveryStatusRaw

getSentDeliveryStatusRaw(requestParameters, initOverrides?): Promise<ApiResponse<DeliveryStatusDto>>

Get a sent email delivery status

Parameters

Name Type
requestParameters GetSentDeliveryStatusRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<DeliveryStatusDto>>


getSentDeliveryStatuses

getSentDeliveryStatuses(requestParameters, initOverrides?): Promise<PageDeliveryStatus>

Get all sent email delivery statuses

Parameters

Name Type
requestParameters GetSentDeliveryStatusesRequest
initOverrides? RequestInit

Returns

Promise<PageDeliveryStatus>


getSentDeliveryStatusesBySentId

getSentDeliveryStatusesBySentId(requestParameters, initOverrides?): Promise<PageDeliveryStatus>

Get all sent email delivery statuses

Parameters

Name Type
requestParameters GetSentDeliveryStatusesBySentIdRequest
initOverrides? RequestInit

Returns

Promise<PageDeliveryStatus>


getSentDeliveryStatusesBySentIdRaw

getSentDeliveryStatusesBySentIdRaw(requestParameters, initOverrides?): Promise<ApiResponse<PageDeliveryStatus>>

Get all sent email delivery statuses

Parameters

Name Type
requestParameters GetSentDeliveryStatusesBySentIdRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<PageDeliveryStatus>>


getSentDeliveryStatusesRaw

getSentDeliveryStatusesRaw(requestParameters, initOverrides?): Promise<ApiResponse<PageDeliveryStatus>>

Get all sent email delivery statuses

Parameters

Name Type
requestParameters GetSentDeliveryStatusesRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<PageDeliveryStatus>>


getSentEmail

getSentEmail(requestParameters, initOverrides?): Promise<SentEmailDto>

Get sent email receipt

Parameters

Name Type
requestParameters GetSentEmailRequest
initOverrides? RequestInit

Returns

Promise<SentEmailDto>


getSentEmailHTMLContent

getSentEmailHTMLContent(requestParameters, initOverrides?): Promise<string>

Get sent email HTML content

Parameters

Name Type
requestParameters GetSentEmailHTMLContentRequest
initOverrides? RequestInit

Returns

Promise<string>


getSentEmailHTMLContentRaw

getSentEmailHTMLContentRaw(requestParameters, initOverrides?): Promise<ApiResponse<string>>

Get sent email HTML content

Parameters

Name Type
requestParameters GetSentEmailHTMLContentRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<string>>


getSentEmailPreviewURLs

getSentEmailPreviewURLs(requestParameters, initOverrides?): Promise<EmailPreviewUrls>

Get a list of URLs for sent email content as text/html or raw SMTP message for viewing the message in a browser. Get sent email URL for viewing in browser or downloading

Parameters

Name Type
requestParameters GetSentEmailPreviewURLsRequest
initOverrides? RequestInit

Returns

Promise<EmailPreviewUrls>


getSentEmailPreviewURLsRaw

getSentEmailPreviewURLsRaw(requestParameters, initOverrides?): Promise<ApiResponse<EmailPreviewUrls>>

Get a list of URLs for sent email content as text/html or raw SMTP message for viewing the message in a browser. Get sent email URL for viewing in browser or downloading

Parameters

Name Type
requestParameters GetSentEmailPreviewURLsRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<EmailPreviewUrls>>


getSentEmailRaw

getSentEmailRaw(requestParameters, initOverrides?): Promise<ApiResponse<SentEmailDto>>

Get sent email receipt

Parameters

Name Type
requestParameters GetSentEmailRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<SentEmailDto>>


getSentEmailTrackingPixels

getSentEmailTrackingPixels(requestParameters, initOverrides?): Promise<PageTrackingPixelProjection>

Get all tracking pixels for a sent email in paginated form

Parameters

Name Type
requestParameters GetSentEmailTrackingPixelsRequest
initOverrides? RequestInit

Returns

Promise<PageTrackingPixelProjection>


getSentEmailTrackingPixelsRaw

getSentEmailTrackingPixelsRaw(requestParameters, initOverrides?): Promise<ApiResponse<PageTrackingPixelProjection>>

Get all tracking pixels for a sent email in paginated form

Parameters

Name Type
requestParameters GetSentEmailTrackingPixelsRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<PageTrackingPixelProjection>>


getSentEmails

getSentEmails(requestParameters, initOverrides?): Promise<PageSentEmailProjection>

Get all sent emails in paginated form

Parameters

Name Type
requestParameters GetSentEmailsRequest
initOverrides? RequestInit

Returns

Promise<PageSentEmailProjection>


getSentEmailsRaw

getSentEmailsRaw(requestParameters, initOverrides?): Promise<ApiResponse<PageSentEmailProjection>>

Get all sent emails in paginated form

Parameters

Name Type
requestParameters GetSentEmailsRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<PageSentEmailProjection>>


getSentEmailsWithQueueResults

getSentEmailsWithQueueResults(requestParameters, initOverrides?): Promise<PageSentEmailWithQueueProjection>

Get results of email sent with queues in paginated form

Parameters

Name Type
requestParameters GetSentEmailsWithQueueResultsRequest
initOverrides? RequestInit

Returns

Promise<PageSentEmailWithQueueProjection>


getSentEmailsWithQueueResultsRaw

getSentEmailsWithQueueResultsRaw(requestParameters, initOverrides?): Promise<ApiResponse<PageSentEmailWithQueueProjection>>

Get results of email sent with queues in paginated form

Parameters

Name Type
requestParameters GetSentEmailsWithQueueResultsRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<PageSentEmailWithQueueProjection>>


getSentOrganizationEmails

getSentOrganizationEmails(requestParameters, initOverrides?): Promise<PageSentEmailProjection>

Get all sent organization emails in paginated form

Parameters

Name Type
requestParameters GetSentOrganizationEmailsRequest
initOverrides? RequestInit

Returns

Promise<PageSentEmailProjection>


getSentOrganizationEmailsRaw

getSentOrganizationEmailsRaw(requestParameters, initOverrides?): Promise<ApiResponse<PageSentEmailProjection>>

Get all sent organization emails in paginated form

Parameters

Name Type
requestParameters GetSentOrganizationEmailsRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<PageSentEmailProjection>>


request

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

Parameters

Name Type
context RequestOpts
initOverrides? RequestInit

Returns

Promise<Response>

Inherited from

BaseAPI.request


waitForDeliveryStatuses

waitForDeliveryStatuses(requestParameters, initOverrides?): Promise<DeliveryStatusDto>

Wait for delivery statuses

Parameters

Name Type
requestParameters WaitForDeliveryStatusesRequest
initOverrides? RequestInit

Returns

Promise<DeliveryStatusDto>


waitForDeliveryStatusesRaw

waitForDeliveryStatusesRaw(requestParameters, initOverrides?): Promise<ApiResponse<DeliveryStatusDto>>

Wait for delivery statuses

Parameters

Name Type
requestParameters WaitForDeliveryStatusesRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<DeliveryStatusDto>>


withMiddleware

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

Type parameters

Name Type
T extends BaseAPI<T>

Parameters

Name Type
this T
...middlewares Middleware[]

Returns

T

Inherited from

BaseAPI.withMiddleware


withPostMiddleware

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

Type parameters

Name Type
T extends BaseAPI<T>

Parameters

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

Returns

T

Inherited from

BaseAPI.withPostMiddleware


withPreMiddleware

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

Type parameters

Name Type
T extends BaseAPI<T>

Parameters

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

Returns

T

Inherited from

BaseAPI.withPreMiddleware