Class MissedEmailControllerApi

Represents a collection of functions to interact with the API endpoints

Inheritance
object
MissedEmailControllerApi
Implements
Inherited Members
Namespace: mailslurp.Api
Assembly: mailslurp.dll
Syntax
public class MissedEmailControllerApi : IMissedEmailControllerApi, IMissedEmailControllerApiSync, IMissedEmailControllerApiAsync, IApiAccessor

Constructors

View Source

MissedEmailControllerApi()

Initializes a new instance of the MissedEmailControllerApi class.

Declaration
public MissedEmailControllerApi()
View Source

MissedEmailControllerApi(string)

Initializes a new instance of the MissedEmailControllerApi class.

Declaration
public MissedEmailControllerApi(string basePath)
Parameters
Type Name Description
string basePath
View Source

MissedEmailControllerApi(Configuration)

Initializes a new instance of the MissedEmailControllerApi class using Configuration object

Declaration
public MissedEmailControllerApi(Configuration configuration)
Parameters
Type Name Description
Configuration configuration

An instance of Configuration
View Source

MissedEmailControllerApi(ISynchronousClient, IAsynchronousClient, IReadableConfiguration)

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

Declaration
public MissedEmailControllerApi(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.

Properties

View Source

AsynchronousClient

The client for accessing this underlying API asynchronously.

Declaration
public IAsynchronousClient AsynchronousClient { get; set; }
Property Value
Type Description
IAsynchronousClient
View Source

Client

The client for accessing this underlying API synchronously.

Declaration
public ISynchronousClient Client { get; set; }
Property Value
Type Description
ISynchronousClient
View Source

Configuration

Gets or sets the configuration object

Declaration
public IReadableConfiguration Configuration { get; set; }
Property Value
Type Description
IReadableConfiguration

An instance of the Configuration
View Source

ExceptionFactory

Provides a factory method hook for the creation of exceptions.

Declaration
public ExceptionFactory ExceptionFactory { get; set; }
Property Value
Type Description
ExceptionFactory

Methods

View Source

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

Get all MissedEmails in paginated format

Declaration
public PageMissedEmailProjection GetAllMissedEmails(int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, Guid? inboxId = null, int operationIndex = 0)
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)
Guid? inboxId

Optional inbox ID filter (optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
PageMissedEmailProjection

PageMissedEmailProjection
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

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

Get all MissedEmails in paginated format

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

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

Get all MissedEmails in paginated format

Declaration
public ApiResponse<PageMissedEmailProjection> GetAllMissedEmailsWithHttpInfo(int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, Guid? inboxId = null, int operationIndex = 0)
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)
Guid? inboxId

Optional inbox ID filter (optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<PageMissedEmailProjection>

ApiResponse 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
public 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)
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

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

Get all unknown missed emails in paginated format Unknown missed emails are emails that were sent to MailSlurp but could not be assigned to an existing inbox.

Declaration
public PageUnknownMissedEmailProjection GetAllUnknownMissedEmails(int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, Guid? inboxId = null, int operationIndex = 0)
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)
Guid? inboxId

Optional inbox ID filter (optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
PageUnknownMissedEmailProjection

PageUnknownMissedEmailProjection
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 Unknown missed emails are emails that were sent to MailSlurp but could not be assigned to an existing inbox.

Declaration
public 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)
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
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

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

Get all unknown missed emails in paginated format Unknown missed emails are emails that were sent to MailSlurp but could not be assigned to an existing inbox.

Declaration
public ApiResponse<PageUnknownMissedEmailProjection> GetAllUnknownMissedEmailsWithHttpInfo(int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, Guid? inboxId = null, int operationIndex = 0)
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)
Guid? inboxId

Optional inbox ID filter (optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<PageUnknownMissedEmailProjection>

ApiResponse of PageUnknownMissedEmailProjection
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 Unknown missed emails are emails that were sent to MailSlurp but could not be assigned to an existing inbox.

Declaration
public 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)
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)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetBasePath()

Gets the base path of the API client.

Declaration
public string GetBasePath()
Returns
Type Description
string

The base path
View Source

GetMissedEmail(Guid, int)

Get MissedEmail List emails that were missed due to plan limits.

Declaration
public MissedEmailDto GetMissedEmail(Guid missedEmailId, int operationIndex = 0)
Parameters
Type Name Description
Guid missedEmailId
int operationIndex

Index associated with the operation.
Returns
Type Description
MissedEmailDto

MissedEmailDto
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetMissedEmailAsync(Guid, int, CancellationToken)

Get MissedEmail List emails that were missed due to plan limits.

Declaration
public Task<MissedEmailDto> GetMissedEmailAsync(Guid missedEmailId, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
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
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetMissedEmailWithHttpInfo(Guid, int)

Get MissedEmail List emails that were missed due to plan limits.

Declaration
public ApiResponse<MissedEmailDto> GetMissedEmailWithHttpInfo(Guid missedEmailId, int operationIndex = 0)
Parameters
Type Name Description
Guid missedEmailId
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<MissedEmailDto>

ApiResponse of MissedEmailDto
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetMissedEmailWithHttpInfoAsync(Guid, int, CancellationToken)

Get MissedEmail List emails that were missed due to plan limits.

Declaration
public Task<ApiResponse<MissedEmailDto>> GetMissedEmailWithHttpInfoAsync(Guid missedEmailId, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
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)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

RestoreMissedEmails(int)

Restore missed emails 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.

Declaration
public void RestoreMissedEmails(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
View Source

RestoreMissedEmailsAsync(int, CancellationToken)

Restore missed emails 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.

Declaration
public 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
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

RestoreMissedEmailsWithHttpInfo(int)

Restore missed emails 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.

Declaration
public ApiResponse<object> RestoreMissedEmailsWithHttpInfo(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
View Source

RestoreMissedEmailsWithHttpInfoAsync(int, CancellationToken)

Restore missed emails 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.

Declaration
public 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
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

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

Wait for Nth missed email Wait for 0 based index missed email

Declaration
public MissedEmailDto WaitForNthMissedEmail(int index, Guid? inboxId = null, long? timeout = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)
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
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.
Returns
Type Description
MissedEmailDto

MissedEmailDto
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 Wait for 0 based index missed email

Declaration
public 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
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
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

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

Wait for Nth missed email Wait for 0 based index missed email

Declaration
public ApiResponse<MissedEmailDto> WaitForNthMissedEmailWithHttpInfo(int index, Guid? inboxId = null, long? timeout = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)
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
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.
Returns
Type Description
ApiResponse<MissedEmailDto>

ApiResponse of MissedEmailDto
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 Wait for 0 based index missed email

Declaration
public 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
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)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call

Implements