Search Results for

    Show / Hide Table of Contents

    Interface IMissedEmailControllerApiAsync

    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 IMissedEmailControllerApiAsync : IApiAccessor

    Methods

    View Source

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

    Get all MissedEmails in paginated format

    Declaration
    Task<PageMissedEmailProjection> GetAllMissedEmailsAsync(int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, Guid? inboxId = null, int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    int? page

    Optional page index in list pagination (optional, default to 0)

    int? size

    Optional page size in 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)

    System.Guid? inboxId

    Optional inbox ID filter (optional)

    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<PageMissedEmailProjection>

    Task of PageMissedEmailProjection

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

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

    Get all MissedEmails in paginated format

    Declaration
    Task<ApiResponse<PageMissedEmailProjection>> GetAllMissedEmailsWithHttpInfoAsync(int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, Guid? inboxId = null, int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    int? page

    Optional page index in list pagination (optional, default to 0)

    int? size

    Optional page size in 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)

    System.Guid? inboxId

    Optional inbox ID filter (optional)

    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<ApiResponse<PageMissedEmailProjection>>

    Task of ApiResponse (PageMissedEmailProjection)

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

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

    Get all unknown missed emails in paginated format

    Declaration
    Task<PageUnknownMissedEmailProjection> GetAllUnknownMissedEmailsAsync(int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, Guid? inboxId = null, int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    int? page

    Optional page index in list pagination (optional, default to 0)

    int? size

    Optional page size in 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)

    System.Guid? inboxId

    Optional inbox ID filter (optional)

    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<PageUnknownMissedEmailProjection>

    Task of PageUnknownMissedEmailProjection

    Remarks

    Unknown missed emails are emails that were sent to MailSlurp but could not be assigned to an existing inbox.

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

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

    Get all unknown missed emails in paginated format

    Declaration
    Task<ApiResponse<PageUnknownMissedEmailProjection>> GetAllUnknownMissedEmailsWithHttpInfoAsync(int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, Guid? inboxId = null, int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    int? page

    Optional page index in list pagination (optional, default to 0)

    int? size

    Optional page size in 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)

    System.Guid? inboxId

    Optional inbox ID filter (optional)

    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<ApiResponse<PageUnknownMissedEmailProjection>>

    Task of ApiResponse (PageUnknownMissedEmailProjection)

    Remarks

    Unknown missed emails are emails that were sent to MailSlurp but could not be assigned to an existing inbox.

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetMissedEmailAsync(Guid, int, CancellationToken)

    Get MissedEmail

    Declaration
    Task<MissedEmailDto> GetMissedEmailAsync(Guid missedEmailId, int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    System.Guid missedEmailId
    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<MissedEmailDto>

    Task of MissedEmailDto

    Remarks

    List emails that were missed due to plan limits.

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetMissedEmailWithHttpInfoAsync(Guid, int, CancellationToken)

    Get MissedEmail

    Declaration
    Task<ApiResponse<MissedEmailDto>> GetMissedEmailWithHttpInfoAsync(Guid missedEmailId, int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    System.Guid missedEmailId
    int operationIndex

    Index associated with the operation.

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    Task<ApiResponse<MissedEmailDto>>

    Task of ApiResponse (MissedEmailDto)

    Remarks

    List emails that were missed due to plan limits.

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    RestoreMissedEmailsAsync(int, CancellationToken)

    Restore missed emails

    Declaration
    Task RestoreMissedEmailsAsync(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

    Remarks

    If emails were missed due to a plan limit they are saved as missed emails. If support team enables the canRestore flag these emails can be reload into your account using this method.

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    RestoreMissedEmailsWithHttpInfoAsync(int, CancellationToken)

    Restore missed emails

    Declaration
    Task<ApiResponse<object>> RestoreMissedEmailsWithHttpInfoAsync(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

    Remarks

    If emails were missed due to a plan limit they are saved as missed emails. If support team enables the canRestore flag these emails can be reload into your account using this method.

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

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

    Wait for Nth missed email

    Declaration
    Task<MissedEmailDto> WaitForNthMissedEmailAsync(int index, Guid? inboxId = null, long? timeout = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    int index

    Zero based index of the email to wait for. If 1 missed email already and you want to wait for the 2nd email pass index=1

    System.Guid? inboxId

    Optional inbox ID filter (optional)

    long? timeout

    Optional timeout milliseconds (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<MissedEmailDto>

    Task of MissedEmailDto

    Remarks

    Wait for 0 based index missed email

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

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

    Wait for Nth missed email

    Declaration
    Task<ApiResponse<MissedEmailDto>> WaitForNthMissedEmailWithHttpInfoAsync(int index, Guid? inboxId = null, long? timeout = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    int index

    Zero based index of the email to wait for. If 1 missed email already and you want to wait for the 2nd email pass index=1

    System.Guid? inboxId

    Optional inbox ID filter (optional)

    long? timeout

    Optional timeout milliseconds (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<MissedEmailDto>>

    Task of ApiResponse (MissedEmailDto)

    Remarks

    Wait for 0 based index missed email

    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.