Interface IEmailAuditControllerApiAsync

Represents a collection of functions to interact with the API endpoints

Inherited Members

Namespace: mailslurp.Api

Assembly: mailslurp.dll

Syntax

public interface IEmailAuditControllerApiAsync : IApiAccessor

Methods

View Source

CompareEmailAuditsAsync(Guid, Guid, int, CancellationToken)

Compare two email audits

Declaration

Task<EmailAuditComparisonDto> CompareEmailAuditsAsync(Guid auditId, Guid otherAuditId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<EmailAuditComparisonDto>	Task of EmailAuditComparisonDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CompareEmailAuditsWithHttpInfoAsync(Guid, Guid, int, CancellationToken)

Compare two email audits

Declaration

Task<ApiResponse<EmailAuditComparisonDto>> CompareEmailAuditsWithHttpInfoAsync(Guid auditId, Guid otherAuditId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateEmailAuditAsync(CreateEmailAuditOptions, int, CancellationToken)

Create email audit

Declaration

Task<EmailAuditDto> CreateEmailAuditAsync(CreateEmailAuditOptions createEmailAuditOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<EmailAuditDto>	Task of EmailAuditDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateEmailAuditWithHttpInfoAsync(CreateEmailAuditOptions, int, CancellationToken)

Create email audit

Declaration

Task<ApiResponse<EmailAuditDto>> CreateEmailAuditWithHttpInfoAsync(CreateEmailAuditOptions createEmailAuditOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteEmailAuditAsync(Guid, int, CancellationToken)

Delete email audit

Declaration

Task DeleteEmailAuditAsync(Guid auditId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	auditId
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

DeleteEmailAuditWithHttpInfoAsync(Guid, int, CancellationToken)

Delete email audit

Declaration

Task<ApiResponse<object>> DeleteEmailAuditWithHttpInfoAsync(Guid auditId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	auditId
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

GetEmailAuditAsync(Guid, int, CancellationToken)

Get email audit

Declaration

Task<EmailAuditDto> GetEmailAuditAsync(Guid auditId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<EmailAuditDto>	Task of EmailAuditDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetEmailAuditWithHttpInfoAsync(Guid, int, CancellationToken)

Get email audit

Declaration

Task<ApiResponse<EmailAuditDto>> GetEmailAuditWithHttpInfoAsync(Guid auditId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetEmailAuditsAsync(Guid?, DateTime?, DateTime?, int?, int, CancellationToken)

List email audits

Declaration

Task<List<EmailAuditDto>> GetEmailAuditsAsync(Guid? emailId = null, DateTime? since = null, DateTime? before = null, int? limit = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid?	emailId	(optional)
DateTime?	since	(optional)
DateTime?	before	(optional)
int?	limit	(optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<List<EmailAuditDto>>	Task of List<EmailAuditDto>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetEmailAuditsWithHttpInfoAsync(Guid?, DateTime?, DateTime?, int?, int, CancellationToken)

List email audits

Declaration

Task<ApiResponse<List<EmailAuditDto>>> GetEmailAuditsWithHttpInfoAsync(Guid? emailId = null, DateTime? since = null, DateTime? before = null, int? limit = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid?	emailId	(optional)
DateTime?	since	(optional)
DateTime?	before	(optional)
int?	limit	(optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<List<EmailAuditDto>>>	Task of ApiResponse (List<EmailAuditDto>)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call