Interface IMissedEmailControllerApiSync

Represents a collection of functions to interact with the API endpoints

Inherited Members

Namespace: mailslurp.Api

Assembly: mailslurp.dll

Syntax

public interface IMissedEmailControllerApiSync : IApiAccessor

Methods

View Source

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

Get all MissedEmails in paginated format

Declaration

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)
System.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

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

Get all MissedEmails in paginated format

Declaration

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)
System.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

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

Get all unknown missed emails in paginated format

Declaration

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)
System.Guid?	inboxId	Optional inbox ID filter (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
PageUnknownMissedEmailProjection	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

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

Get all unknown missed emails in paginated format

Declaration

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)
System.Guid?	inboxId	Optional inbox ID filter (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<PageUnknownMissedEmailProjection>	ApiResponse 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

GetMissedEmail(Guid, int)

Get MissedEmail

Declaration

MissedEmailDto GetMissedEmail(Guid missedEmailId, int operationIndex = 0)

Parameters

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

Returns

Type	Description
MissedEmailDto	MissedEmailDto

Remarks

List emails that were missed due to plan limits.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetMissedEmailWithHttpInfo(Guid, int)

Get MissedEmail

Declaration

ApiResponse<MissedEmailDto> GetMissedEmailWithHttpInfo(Guid missedEmailId, int operationIndex = 0)

Parameters

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

Returns

Type	Description
ApiResponse<MissedEmailDto>	ApiResponse 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

RestoreMissedEmails(int)

Restore missed emails

Declaration

void RestoreMissedEmails(int operationIndex = 0)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.

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

RestoreMissedEmailsWithHttpInfo(int)

Restore missed emails

Declaration

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)

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

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

Wait for Nth missed email

Declaration

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
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.

Returns

Type	Description
MissedEmailDto	MissedEmailDto

Remarks

Wait for 0 based index missed email

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

Declaration

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
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.

Returns

Type	Description
ApiResponse<MissedEmailDto>	ApiResponse of MissedEmailDto

Remarks

Wait for 0 based index missed email

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call