Class SentEmailsControllerApi

Represents a collection of functions to interact with the API endpoints

Inheritance

object

SentEmailsControllerApi

Implements

ISentEmailsControllerApi

ISentEmailsControllerApiSync

ISentEmailsControllerApiAsync

IApiAccessor

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: mailslurp.Api

Assembly: mailslurp.dll

Syntax

public class SentEmailsControllerApi : ISentEmailsControllerApi, ISentEmailsControllerApiSync, ISentEmailsControllerApiAsync, IApiAccessor

Constructors

SentEmailsControllerApi()

Initializes a new instance of the SentEmailsControllerApi class.

Declaration

public SentEmailsControllerApi()

SentEmailsControllerApi(Configuration)

Initializes a new instance of the SentEmailsControllerApi class using Configuration object

Declaration

public SentEmailsControllerApi(Configuration configuration)

Parameters

Type	Name	Description
Configuration	configuration	An instance of Configuration

SentEmailsControllerApi(ISynchronousClient, IAsynchronousClient, IReadableConfiguration)

Initializes a new instance of the SentEmailsControllerApi class using a Configuration object and client instance.

Declaration

public SentEmailsControllerApi(ISynchronousClient client, IAsynchronousClient asyncClient, IReadableConfiguration configuration)

Parameters

Type	Name	Description
ISynchronousClient	client	The client interface for synchronous API access.
IAsynchronousClient	asyncClient	The client interface for asynchronous API access.
IReadableConfiguration	configuration	The configuration object.

SentEmailsControllerApi(string)

Initializes a new instance of the SentEmailsControllerApi class.

Declaration

public SentEmailsControllerApi(string basePath)

Parameters

Type	Name	Description
string	basePath

Properties

AsynchronousClient

The client for accessing this underlying API asynchronously.

Declaration

public IAsynchronousClient AsynchronousClient { get; set; }

Property Value

Type	Description
IAsynchronousClient

Client

The client for accessing this underlying API synchronously.

Declaration

public ISynchronousClient Client { get; set; }

Property Value

Type	Description
ISynchronousClient

Configuration

Gets or sets the configuration object

Declaration

public IReadableConfiguration Configuration { get; set; }

Property Value

Type	Description
IReadableConfiguration	An instance of the Configuration

ExceptionFactory

Provides a factory method hook for the creation of exceptions.

Declaration

public ExceptionFactory ExceptionFactory { get; set; }

Property Value

Type	Description
ExceptionFactory

Methods

DeleteAllSentEmails(int)

Delete all sent email receipts

Declaration

public void DeleteAllSentEmails(int operationIndex = 0)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteAllSentEmailsAsync(int, CancellationToken)

Delete all sent email receipts

Declaration

public Task DeleteAllSentEmailsAsync(int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task	Task of void

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteAllSentEmailsWithHttpInfo(int)

Delete all sent email receipts

Declaration

public ApiResponse<object> DeleteAllSentEmailsWithHttpInfo(int operationIndex = 0)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<object>	ApiResponse of Object(void)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteAllSentEmailsWithHttpInfoAsync(int, CancellationToken)

Delete all sent email receipts

Declaration

public Task<ApiResponse<object>> DeleteAllSentEmailsWithHttpInfoAsync(int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<object>>	Task of ApiResponse

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteSentEmail(Guid, int)

Delete sent email receipt

Declaration

public void DeleteSentEmail(Guid id, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	id
int	operationIndex	Index associated with the operation.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteSentEmailAsync(Guid, int, CancellationToken)

Delete sent email receipt

Declaration

public Task DeleteSentEmailAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	id
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task	Task of void

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteSentEmailWithHttpInfo(Guid, int)

Delete sent email receipt

Declaration

public ApiResponse<object> DeleteSentEmailWithHttpInfo(Guid id, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	id
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<object>	ApiResponse of Object(void)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteSentEmailWithHttpInfoAsync(Guid, int, CancellationToken)

Delete sent email receipt

Declaration

public Task<ApiResponse<object>> DeleteSentEmailWithHttpInfoAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	id
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<object>>	Task of ApiResponse

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetAllSentTrackingPixels(int?, int?, string, string, DateTime?, DateTime?, int)

Get all sent email tracking pixels in paginated form

Declaration

public PageTrackingPixelProjection GetAllSentTrackingPixels(int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)

Parameters

Type	Name	Description
int?	page	Optional page index in sent email tracking pixel list pagination (optional, default to 0)
int?	size	Optional page size in sent email tracking pixel list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
string	searchFilter	Optional search filter (optional)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
PageTrackingPixelProjection	PageTrackingPixelProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetAllSentTrackingPixelsAsync(int?, int?, string, string, DateTime?, DateTime?, int, CancellationToken)

Get all sent email tracking pixels in paginated form

Declaration

public Task<PageTrackingPixelProjection> GetAllSentTrackingPixelsAsync(int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int?	page	Optional page index in sent email tracking pixel list pagination (optional, default to 0)
int?	size	Optional page size in sent email tracking pixel list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
string	searchFilter	Optional search filter (optional)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PageTrackingPixelProjection>	Task of PageTrackingPixelProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetAllSentTrackingPixelsWithHttpInfo(int?, int?, string, string, DateTime?, DateTime?, int)

Get all sent email tracking pixels in paginated form

Declaration

public ApiResponse<PageTrackingPixelProjection> GetAllSentTrackingPixelsWithHttpInfo(int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)

Parameters

Type	Name	Description
int?	page	Optional page index in sent email tracking pixel list pagination (optional, default to 0)
int?	size	Optional page size in sent email tracking pixel list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
string	searchFilter	Optional search filter (optional)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<PageTrackingPixelProjection>	ApiResponse of PageTrackingPixelProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetAllSentTrackingPixelsWithHttpInfoAsync(int?, int?, string, string, DateTime?, DateTime?, int, CancellationToken)

Get all sent email tracking pixels in paginated form

Declaration

public Task<ApiResponse<PageTrackingPixelProjection>> GetAllSentTrackingPixelsWithHttpInfoAsync(int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int?	page	Optional page index in sent email tracking pixel list pagination (optional, default to 0)
int?	size	Optional page size in sent email tracking pixel list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
string	searchFilter	Optional search filter (optional)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<PageTrackingPixelProjection>>	Task of ApiResponse (PageTrackingPixelProjection)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetBasePath()

Gets the base path of the API client.

Declaration

public string GetBasePath()

Returns

Type	Description
string	The base path

GetRawSentEmailContents(Guid, int)

Get raw sent email string. Returns unparsed raw SMTP message with headers and body. 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

Declaration

public void GetRawSentEmailContents(Guid emailId, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	emailId	ID of email
int	operationIndex	Index associated with the operation.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetRawSentEmailContentsAsync(Guid, int, CancellationToken)

Get raw sent email string. Returns unparsed raw SMTP message with headers and body. 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

Declaration

public Task GetRawSentEmailContentsAsync(Guid emailId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	emailId	ID of email
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task	Task of void

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetRawSentEmailContentsWithHttpInfo(Guid, int)

Get raw sent email string. Returns unparsed raw SMTP message with headers and body. 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

Declaration

public ApiResponse<object> GetRawSentEmailContentsWithHttpInfo(Guid emailId, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	emailId	ID of email
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<object>	ApiResponse of Object(void)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetRawSentEmailContentsWithHttpInfoAsync(Guid, int, CancellationToken)

Get raw sent email string. Returns unparsed raw SMTP message with headers and body. 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

Declaration

public Task<ApiResponse<object>> GetRawSentEmailContentsWithHttpInfoAsync(Guid emailId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	emailId	ID of email
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<object>>	Task of ApiResponse

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetRawSentEmailJson(Guid, int)

Get raw sent email in JSON. Unparsed SMTP message in JSON wrapper format. 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

Declaration

public RawEmailJson GetRawSentEmailJson(Guid emailId, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	emailId	ID of email
int	operationIndex	Index associated with the operation.

Returns

Type	Description
RawEmailJson	RawEmailJson

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetRawSentEmailJsonAsync(Guid, int, CancellationToken)

Get raw sent email in JSON. Unparsed SMTP message in JSON wrapper format. 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

Declaration

public Task<RawEmailJson> GetRawSentEmailJsonAsync(Guid emailId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	emailId	ID of email
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<RawEmailJson>	Task of RawEmailJson

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetRawSentEmailJsonWithHttpInfo(Guid, int)

Get raw sent email in JSON. Unparsed SMTP message in JSON wrapper format. 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

Declaration

public ApiResponse<RawEmailJson> GetRawSentEmailJsonWithHttpInfo(Guid emailId, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	emailId	ID of email
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<RawEmailJson>	ApiResponse of RawEmailJson

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetRawSentEmailJsonWithHttpInfoAsync(Guid, int, CancellationToken)

Get raw sent email in JSON. Unparsed SMTP message in JSON wrapper format. 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

Declaration

public Task<ApiResponse<RawEmailJson>> GetRawSentEmailJsonWithHttpInfoAsync(Guid emailId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	emailId	ID of email
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<RawEmailJson>>	Task of ApiResponse (RawEmailJson)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetSentDeliveryStatus(Guid, int)

Get a sent email delivery status

Declaration

public DeliveryStatusDto GetSentDeliveryStatus(Guid deliveryId, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	deliveryId
int	operationIndex	Index associated with the operation.

Returns

Type	Description
DeliveryStatusDto	DeliveryStatusDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetSentDeliveryStatusAsync(Guid, int, CancellationToken)

Get a sent email delivery status

Declaration

public Task<DeliveryStatusDto> GetSentDeliveryStatusAsync(Guid deliveryId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	deliveryId
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<DeliveryStatusDto>	Task of DeliveryStatusDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetSentDeliveryStatuses(int?, int?, string, DateTime?, DateTime?, int)

Get all sent email delivery statuses

Declaration

public PageDeliveryStatus GetSentDeliveryStatuses(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)

Parameters

Type	Name	Description
int?	page	Optional page index in delivery status list pagination (optional, default to 0)
int?	size	Optional page size in delivery status list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
PageDeliveryStatus	PageDeliveryStatus

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetSentDeliveryStatusesAsync(int?, int?, string, DateTime?, DateTime?, int, CancellationToken)

Get all sent email delivery statuses

Declaration

public Task<PageDeliveryStatus> GetSentDeliveryStatusesAsync(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int?	page	Optional page index in delivery status list pagination (optional, default to 0)
int?	size	Optional page size in delivery status list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PageDeliveryStatus>	Task of PageDeliveryStatus

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetSentDeliveryStatusesBySentId(Guid, int?, int?, string, DateTime?, DateTime?, int)

Get all sent email delivery statuses

Declaration

public PageDeliveryStatus GetSentDeliveryStatusesBySentId(Guid sentId, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	sentId	ID of the sent email that you want to get the delivery status of. Sent email object is returned when sending an email
int?	page	Optional page index in delivery status list pagination (optional, default to 0)
int?	size	Optional page size in delivery status list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
PageDeliveryStatus	PageDeliveryStatus

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetSentDeliveryStatusesBySentIdAsync(Guid, int?, int?, string, DateTime?, DateTime?, int, CancellationToken)

Get all sent email delivery statuses

Declaration

public Task<PageDeliveryStatus> GetSentDeliveryStatusesBySentIdAsync(Guid sentId, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	sentId	ID of the sent email that you want to get the delivery status of. Sent email object is returned when sending an email
int?	page	Optional page index in delivery status list pagination (optional, default to 0)
int?	size	Optional page size in delivery status list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PageDeliveryStatus>	Task of PageDeliveryStatus

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetSentDeliveryStatusesBySentIdWithHttpInfo(Guid, int?, int?, string, DateTime?, DateTime?, int)

Get all sent email delivery statuses

Declaration

public ApiResponse<PageDeliveryStatus> GetSentDeliveryStatusesBySentIdWithHttpInfo(Guid sentId, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	sentId	ID of the sent email that you want to get the delivery status of. Sent email object is returned when sending an email
int?	page	Optional page index in delivery status list pagination (optional, default to 0)
int?	size	Optional page size in delivery status list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<PageDeliveryStatus>	ApiResponse of PageDeliveryStatus

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetSentDeliveryStatusesBySentIdWithHttpInfoAsync(Guid, int?, int?, string, DateTime?, DateTime?, int, CancellationToken)

Get all sent email delivery statuses

Declaration

public Task<ApiResponse<PageDeliveryStatus>> GetSentDeliveryStatusesBySentIdWithHttpInfoAsync(Guid sentId, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	sentId	ID of the sent email that you want to get the delivery status of. Sent email object is returned when sending an email
int?	page	Optional page index in delivery status list pagination (optional, default to 0)
int?	size	Optional page size in delivery status list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<PageDeliveryStatus>>	Task of ApiResponse (PageDeliveryStatus)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetSentDeliveryStatusesWithHttpInfo(int?, int?, string, DateTime?, DateTime?, int)

Get all sent email delivery statuses

Declaration

public ApiResponse<PageDeliveryStatus> GetSentDeliveryStatusesWithHttpInfo(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)

Parameters

Type	Name	Description
int?	page	Optional page index in delivery status list pagination (optional, default to 0)
int?	size	Optional page size in delivery status list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<PageDeliveryStatus>	ApiResponse of PageDeliveryStatus

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetSentDeliveryStatusesWithHttpInfoAsync(int?, int?, string, DateTime?, DateTime?, int, CancellationToken)

Get all sent email delivery statuses

Declaration

public Task<ApiResponse<PageDeliveryStatus>> GetSentDeliveryStatusesWithHttpInfoAsync(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int?	page	Optional page index in delivery status list pagination (optional, default to 0)
int?	size	Optional page size in delivery status list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<PageDeliveryStatus>>	Task of ApiResponse (PageDeliveryStatus)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetSentDeliveryStatusWithHttpInfo(Guid, int)

Get a sent email delivery status

Declaration

public ApiResponse<DeliveryStatusDto> GetSentDeliveryStatusWithHttpInfo(Guid deliveryId, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	deliveryId
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<DeliveryStatusDto>	ApiResponse of DeliveryStatusDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetSentDeliveryStatusWithHttpInfoAsync(Guid, int, CancellationToken)

Get a sent email delivery status

Declaration

public Task<ApiResponse<DeliveryStatusDto>> GetSentDeliveryStatusWithHttpInfoAsync(Guid deliveryId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	deliveryId
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<DeliveryStatusDto>>	Task of ApiResponse (DeliveryStatusDto)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetSentEmail(Guid, int)

Get sent email receipt

Declaration

public SentEmailDto GetSentEmail(Guid id, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	id
int	operationIndex	Index associated with the operation.

Returns

Type	Description
SentEmailDto	SentEmailDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetSentEmailAsync(Guid, int, CancellationToken)

Get sent email receipt

Declaration

public Task<SentEmailDto> GetSentEmailAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	id
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<SentEmailDto>	Task of SentEmailDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetSentEmailHTMLContent(Guid, int)

Get sent email HTML content

Declaration

public string GetSentEmailHTMLContent(Guid id, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	id
int	operationIndex	Index associated with the operation.

Returns

Type	Description
string	string

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetSentEmailHTMLContentAsync(Guid, int, CancellationToken)

Get sent email HTML content

Declaration

public Task<string> GetSentEmailHTMLContentAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	id
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<string>	Task of string

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetSentEmailHTMLContentWithHttpInfo(Guid, int)

Get sent email HTML content

Declaration

public ApiResponse<string> GetSentEmailHTMLContentWithHttpInfo(Guid id, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	id
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<string>	ApiResponse of string

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetSentEmailHTMLContentWithHttpInfoAsync(Guid, int, CancellationToken)

Get sent email HTML content

Declaration

public Task<ApiResponse<string>> GetSentEmailHTMLContentWithHttpInfoAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	id
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<string>>	Task of ApiResponse (string)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetSentEmailPreviewURLs(Guid, int)

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

Declaration

public EmailPreviewUrls GetSentEmailPreviewURLs(Guid id, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	id
int	operationIndex	Index associated with the operation.

Returns

Type	Description
EmailPreviewUrls	EmailPreviewUrls

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetSentEmailPreviewURLsAsync(Guid, int, CancellationToken)

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

Declaration

public Task<EmailPreviewUrls> GetSentEmailPreviewURLsAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	id
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<EmailPreviewUrls>	Task of EmailPreviewUrls

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetSentEmailPreviewURLsWithHttpInfo(Guid, int)

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

Declaration

public ApiResponse<EmailPreviewUrls> GetSentEmailPreviewURLsWithHttpInfo(Guid id, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	id
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<EmailPreviewUrls>	ApiResponse of EmailPreviewUrls

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetSentEmailPreviewURLsWithHttpInfoAsync(Guid, int, CancellationToken)

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

Declaration

public Task<ApiResponse<EmailPreviewUrls>> GetSentEmailPreviewURLsWithHttpInfoAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	id
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<EmailPreviewUrls>>	Task of ApiResponse (EmailPreviewUrls)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetSentEmails(Guid?, int?, int?, string, string, DateTime?, DateTime?, int)

Get all sent emails in paginated form

Declaration

public PageSentEmailProjection GetSentEmails(Guid? inboxId = null, int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid?	inboxId	Optional inboxId to filter sender of sent emails by (optional)
int?	page	Optional page index in inbox sent email list pagination (optional, default to 0)
int?	size	Optional page size in inbox sent email list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
string	searchFilter	Optional search filter (optional)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
PageSentEmailProjection	PageSentEmailProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetSentEmailsAsync(Guid?, int?, int?, string, string, DateTime?, DateTime?, int, CancellationToken)

Get all sent emails in paginated form

Declaration

public Task<PageSentEmailProjection> GetSentEmailsAsync(Guid? inboxId = null, int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid?	inboxId	Optional inboxId to filter sender of sent emails by (optional)
int?	page	Optional page index in inbox sent email list pagination (optional, default to 0)
int?	size	Optional page size in inbox sent email list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
string	searchFilter	Optional search filter (optional)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PageSentEmailProjection>	Task of PageSentEmailProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetSentEmailsWithHttpInfo(Guid?, int?, int?, string, string, DateTime?, DateTime?, int)

Get all sent emails in paginated form

Declaration

public ApiResponse<PageSentEmailProjection> GetSentEmailsWithHttpInfo(Guid? inboxId = null, int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid?	inboxId	Optional inboxId to filter sender of sent emails by (optional)
int?	page	Optional page index in inbox sent email list pagination (optional, default to 0)
int?	size	Optional page size in inbox sent email list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
string	searchFilter	Optional search filter (optional)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<PageSentEmailProjection>	ApiResponse of PageSentEmailProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetSentEmailsWithHttpInfoAsync(Guid?, int?, int?, string, string, DateTime?, DateTime?, int, CancellationToken)

Get all sent emails in paginated form

Declaration

public Task<ApiResponse<PageSentEmailProjection>> GetSentEmailsWithHttpInfoAsync(Guid? inboxId = null, int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid?	inboxId	Optional inboxId to filter sender of sent emails by (optional)
int?	page	Optional page index in inbox sent email list pagination (optional, default to 0)
int?	size	Optional page size in inbox sent email list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
string	searchFilter	Optional search filter (optional)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<PageSentEmailProjection>>	Task of ApiResponse (PageSentEmailProjection)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetSentEmailsWithQueueResults(int?, int?, string, DateTime?, DateTime?, int)

Get results of email sent with queues in paginated form

Declaration

public PageSentEmailWithQueueProjection GetSentEmailsWithQueueResults(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)

Parameters

Type	Name	Description
int?	page	Optional page index in inbox sent email list pagination (optional, default to 0)
int?	size	Optional page size in inbox sent email list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
PageSentEmailWithQueueProjection	PageSentEmailWithQueueProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetSentEmailsWithQueueResultsAsync(int?, int?, string, DateTime?, DateTime?, int, CancellationToken)

Get results of email sent with queues in paginated form

Declaration

public Task<PageSentEmailWithQueueProjection> GetSentEmailsWithQueueResultsAsync(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int?	page	Optional page index in inbox sent email list pagination (optional, default to 0)
int?	size	Optional page size in inbox sent email list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PageSentEmailWithQueueProjection>	Task of PageSentEmailWithQueueProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetSentEmailsWithQueueResultsWithHttpInfo(int?, int?, string, DateTime?, DateTime?, int)

Get results of email sent with queues in paginated form

Declaration

public ApiResponse<PageSentEmailWithQueueProjection> GetSentEmailsWithQueueResultsWithHttpInfo(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)

Parameters

Type	Name	Description
int?	page	Optional page index in inbox sent email list pagination (optional, default to 0)
int?	size	Optional page size in inbox sent email list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<PageSentEmailWithQueueProjection>	ApiResponse of PageSentEmailWithQueueProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetSentEmailsWithQueueResultsWithHttpInfoAsync(int?, int?, string, DateTime?, DateTime?, int, CancellationToken)

Get results of email sent with queues in paginated form

Declaration

public Task<ApiResponse<PageSentEmailWithQueueProjection>> GetSentEmailsWithQueueResultsWithHttpInfoAsync(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int?	page	Optional page index in inbox sent email list pagination (optional, default to 0)
int?	size	Optional page size in inbox sent email list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<PageSentEmailWithQueueProjection>>	Task of ApiResponse (PageSentEmailWithQueueProjection)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetSentEmailTrackingPixels(Guid, int?, int?, string, string, DateTime?, DateTime?, int)

Get all tracking pixels for a sent email in paginated form

Declaration

public PageTrackingPixelProjection GetSentEmailTrackingPixels(Guid id, int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	id
int?	page	Optional page index in sent email tracking pixel list pagination (optional, default to 0)
int?	size	Optional page size in sent email tracking pixel list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
string	searchFilter	Optional search filter (optional)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
PageTrackingPixelProjection	PageTrackingPixelProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetSentEmailTrackingPixelsAsync(Guid, int?, int?, string, string, DateTime?, DateTime?, int, CancellationToken)

Get all tracking pixels for a sent email in paginated form

Declaration

public Task<PageTrackingPixelProjection> GetSentEmailTrackingPixelsAsync(Guid id, int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	id
int?	page	Optional page index in sent email tracking pixel list pagination (optional, default to 0)
int?	size	Optional page size in sent email tracking pixel list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
string	searchFilter	Optional search filter (optional)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PageTrackingPixelProjection>	Task of PageTrackingPixelProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetSentEmailTrackingPixelsWithHttpInfo(Guid, int?, int?, string, string, DateTime?, DateTime?, int)

Get all tracking pixels for a sent email in paginated form

Declaration

public ApiResponse<PageTrackingPixelProjection> GetSentEmailTrackingPixelsWithHttpInfo(Guid id, int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	id
int?	page	Optional page index in sent email tracking pixel list pagination (optional, default to 0)
int?	size	Optional page size in sent email tracking pixel list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
string	searchFilter	Optional search filter (optional)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<PageTrackingPixelProjection>	ApiResponse of PageTrackingPixelProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetSentEmailTrackingPixelsWithHttpInfoAsync(Guid, int?, int?, string, string, DateTime?, DateTime?, int, CancellationToken)

Get all tracking pixels for a sent email in paginated form

Declaration

public Task<ApiResponse<PageTrackingPixelProjection>> GetSentEmailTrackingPixelsWithHttpInfoAsync(Guid id, int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	id
int?	page	Optional page index in sent email tracking pixel list pagination (optional, default to 0)
int?	size	Optional page size in sent email tracking pixel list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
string	searchFilter	Optional search filter (optional)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<PageTrackingPixelProjection>>	Task of ApiResponse (PageTrackingPixelProjection)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetSentEmailWithHttpInfo(Guid, int)

Get sent email receipt

Declaration

public ApiResponse<SentEmailDto> GetSentEmailWithHttpInfo(Guid id, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	id
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<SentEmailDto>	ApiResponse of SentEmailDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetSentEmailWithHttpInfoAsync(Guid, int, CancellationToken)

Get sent email receipt

Declaration

public Task<ApiResponse<SentEmailDto>> GetSentEmailWithHttpInfoAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	id
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<SentEmailDto>>	Task of ApiResponse (SentEmailDto)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetSentOrganizationEmails(Guid?, int?, int?, string, string, DateTime?, DateTime?, int)

Get all sent organization emails in paginated form

Declaration

public PageSentEmailProjection GetSentOrganizationEmails(Guid? inboxId = null, int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid?	inboxId	Optional inboxId to filter sender of sent emails by (optional)
int?	page	Optional page index in sent email list pagination (optional, default to 0)
int?	size	Optional page size in sent email list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
string	searchFilter	Optional search filter (optional)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
PageSentEmailProjection	PageSentEmailProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetSentOrganizationEmailsAsync(Guid?, int?, int?, string, string, DateTime?, DateTime?, int, CancellationToken)

Get all sent organization emails in paginated form

Declaration

public Task<PageSentEmailProjection> GetSentOrganizationEmailsAsync(Guid? inboxId = null, int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid?	inboxId	Optional inboxId to filter sender of sent emails by (optional)
int?	page	Optional page index in sent email list pagination (optional, default to 0)
int?	size	Optional page size in sent email list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
string	searchFilter	Optional search filter (optional)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PageSentEmailProjection>	Task of PageSentEmailProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetSentOrganizationEmailsWithHttpInfo(Guid?, int?, int?, string, string, DateTime?, DateTime?, int)

Get all sent organization emails in paginated form

Declaration

public ApiResponse<PageSentEmailProjection> GetSentOrganizationEmailsWithHttpInfo(Guid? inboxId = null, int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid?	inboxId	Optional inboxId to filter sender of sent emails by (optional)
int?	page	Optional page index in sent email list pagination (optional, default to 0)
int?	size	Optional page size in sent email list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
string	searchFilter	Optional search filter (optional)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<PageSentEmailProjection>	ApiResponse of PageSentEmailProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetSentOrganizationEmailsWithHttpInfoAsync(Guid?, int?, int?, string, string, DateTime?, DateTime?, int, CancellationToken)

Get all sent organization emails in paginated form

Declaration

public Task<ApiResponse<PageSentEmailProjection>> GetSentOrganizationEmailsWithHttpInfoAsync(Guid? inboxId = null, int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid?	inboxId	Optional inboxId to filter sender of sent emails by (optional)
int?	page	Optional page index in sent email list pagination (optional, default to 0)
int?	size	Optional page size in sent email list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
string	searchFilter	Optional search filter (optional)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<PageSentEmailProjection>>	Task of ApiResponse (PageSentEmailProjection)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

WaitForDeliveryStatuses(Guid?, Guid?, long?, int?, DateTime?, DateTime?, int)

Wait for delivery statuses

Declaration

public DeliveryStatusDto WaitForDeliveryStatuses(Guid? sentId = null, Guid? inboxId = null, long? timeout = null, int? index = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid?	sentId	Optional sent email ID filter (optional)
System.Guid?	inboxId	Optional inbox ID filter (optional)
long?	timeout	Optional timeout milliseconds (optional)
int?	index	Zero based index of the delivery status to wait for. If 1 delivery status already and you want to wait for the 2nd pass index=1 (optional)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
DeliveryStatusDto	DeliveryStatusDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

WaitForDeliveryStatusesAsync(Guid?, Guid?, long?, int?, DateTime?, DateTime?, int, CancellationToken)

Wait for delivery statuses

Declaration

public Task<DeliveryStatusDto> WaitForDeliveryStatusesAsync(Guid? sentId = null, Guid? inboxId = null, long? timeout = null, int? index = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid?	sentId	Optional sent email ID filter (optional)
System.Guid?	inboxId	Optional inbox ID filter (optional)
long?	timeout	Optional timeout milliseconds (optional)
int?	index	Zero based index of the delivery status to wait for. If 1 delivery status already and you want to wait for the 2nd pass index=1 (optional)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<DeliveryStatusDto>	Task of DeliveryStatusDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

WaitForDeliveryStatusesWithHttpInfo(Guid?, Guid?, long?, int?, DateTime?, DateTime?, int)

Wait for delivery statuses

Declaration

public ApiResponse<DeliveryStatusDto> WaitForDeliveryStatusesWithHttpInfo(Guid? sentId = null, Guid? inboxId = null, long? timeout = null, int? index = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid?	sentId	Optional sent email ID filter (optional)
System.Guid?	inboxId	Optional inbox ID filter (optional)
long?	timeout	Optional timeout milliseconds (optional)
int?	index	Zero based index of the delivery status to wait for. If 1 delivery status already and you want to wait for the 2nd pass index=1 (optional)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<DeliveryStatusDto>	ApiResponse of DeliveryStatusDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

WaitForDeliveryStatusesWithHttpInfoAsync(Guid?, Guid?, long?, int?, DateTime?, DateTime?, int, CancellationToken)

Wait for delivery statuses

Declaration

public Task<ApiResponse<DeliveryStatusDto>> WaitForDeliveryStatusesWithHttpInfoAsync(Guid? sentId = null, Guid? inboxId = null, long? timeout = null, int? index = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid?	sentId	Optional sent email ID filter (optional)
System.Guid?	inboxId	Optional inbox ID filter (optional)
long?	timeout	Optional timeout milliseconds (optional)
int?	index	Zero based index of the delivery status to wait for. If 1 delivery status already and you want to wait for the 2nd pass index=1 (optional)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<DeliveryStatusDto>>	Task of ApiResponse (DeliveryStatusDto)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

Implements

ISentEmailsControllerApi

ISentEmailsControllerApiSync

ISentEmailsControllerApiAsync

IApiAccessor