Search Results for

    Show / Hide Table of Contents

    Interface ISentEmailsControllerApiAsync

    Represents a collection of functions to interact with the API endpoints

    Inherited Members
    IApiAccessor.Configuration
    IApiAccessor.GetBasePath()
    IApiAccessor.ExceptionFactory
    Namespace: mailslurp.Api
    Assembly: mailslurp.dll
    Syntax
    public interface ISentEmailsControllerApiAsync : IApiAccessor

    Methods

    View Source

    DeleteAllSentEmailsAsync(int, CancellationToken)

    Delete all sent email receipts

    Declaration
    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

    View Source

    DeleteAllSentEmailsWithHttpInfoAsync(int, CancellationToken)

    Delete all sent email receipts

    Declaration
    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

    View Source

    DeleteSentEmailAsync(Guid, int, CancellationToken)

    Delete sent email receipt

    Declaration
    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

    View Source

    DeleteSentEmailWithHttpInfoAsync(Guid, int, CancellationToken)

    Delete sent email receipt

    Declaration
    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

    View Source

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

    Declaration
    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

    Remarks

    Get all sent email tracking pixels in paginated form

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

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

    Declaration
    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)

    Remarks

    Get all sent email tracking pixels in paginated form

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetRawSentEmailContentsAsync(Guid, int, CancellationToken)

    Get raw sent email string. Returns unparsed raw SMTP message with headers and body.

    Declaration
    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

    Remarks

    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

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetRawSentEmailContentsWithHttpInfoAsync(Guid, int, CancellationToken)

    Get raw sent email string. Returns unparsed raw SMTP message with headers and body.

    Declaration
    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

    Remarks

    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

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetRawSentEmailJsonAsync(Guid, int, CancellationToken)

    Get raw sent email in JSON. Unparsed SMTP message in JSON wrapper format.

    Declaration
    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

    Remarks

    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

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetRawSentEmailJsonWithHttpInfoAsync(Guid, int, CancellationToken)

    Get raw sent email in JSON. Unparsed SMTP message in JSON wrapper format.

    Declaration
    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)

    Remarks

    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

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetSentDeliveryStatusAsync(Guid, int, CancellationToken)

    Declaration
    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

    Remarks

    Get a sent email delivery status

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

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

    Declaration
    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

    Remarks

    Get all sent email delivery statuses

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

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

    Declaration
    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

    Remarks

    Get all sent email delivery statuses

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

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

    Declaration
    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)

    Remarks

    Get all sent email delivery statuses

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

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

    Declaration
    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)

    Remarks

    Get all sent email delivery statuses

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetSentDeliveryStatusWithHttpInfoAsync(Guid, int, CancellationToken)

    Declaration
    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)

    Remarks

    Get a sent email delivery status

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetSentEmailAsync(Guid, int, CancellationToken)

    Get sent email receipt

    Declaration
    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

    View Source

    GetSentEmailHTMLContentAsync(Guid, int, CancellationToken)

    Get sent email HTML content

    Declaration
    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

    View Source

    GetSentEmailHTMLContentWithHttpInfoAsync(Guid, int, CancellationToken)

    Get sent email HTML content

    Declaration
    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

    View Source

    GetSentEmailPreviewURLsAsync(Guid, int, CancellationToken)

    Get sent email URL for viewing in browser or downloading

    Declaration
    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

    Remarks

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

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetSentEmailPreviewURLsWithHttpInfoAsync(Guid, int, CancellationToken)

    Get sent email URL for viewing in browser or downloading

    Declaration
    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)

    Remarks

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

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

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

    Get all sent emails in paginated form

    Declaration
    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

    View Source

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

    Get all sent emails in paginated form

    Declaration
    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

    View Source

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

    Get results of email sent with queues in paginated form

    Declaration
    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

    View Source

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

    Get results of email sent with queues in paginated form

    Declaration
    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

    View Source

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

    Declaration
    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

    Remarks

    Get all tracking pixels for a sent email in paginated form

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

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

    Declaration
    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)

    Remarks

    Get all tracking pixels for a sent email in paginated form

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetSentEmailWithHttpInfoAsync(Guid, int, CancellationToken)

    Get sent email receipt

    Declaration
    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

    View Source

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

    Declaration
    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

    Remarks

    Get all sent organization emails in paginated form

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

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

    Declaration
    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)

    Remarks

    Get all sent organization emails in paginated form

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

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

    Declaration
    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

    Remarks

    Wait for delivery statuses

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

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

    Declaration
    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)

    Remarks

    Wait for delivery statuses

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    • View Source
    In This Article
    Back to top See MailSlurp website for more information.