Class EmailAuditControllerApi

Represents a collection of functions to interact with the API endpoints

Inheritance

object

EmailAuditControllerApi

Implements

IEmailAuditControllerApi

IEmailAuditControllerApiSync

IEmailAuditControllerApiAsync

IApiAccessor

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: mailslurp.Api

Assembly: mailslurp.dll

Syntax

public class EmailAuditControllerApi : IEmailAuditControllerApi, IEmailAuditControllerApiSync, IEmailAuditControllerApiAsync, IApiAccessor

Constructors

View Source

EmailAuditControllerApi()

Initializes a new instance of the EmailAuditControllerApi class.

Declaration

public EmailAuditControllerApi()

View Source

EmailAuditControllerApi(string)

Initializes a new instance of the EmailAuditControllerApi class.

Declaration

public EmailAuditControllerApi(string basePath)

Parameters

Type	Name	Description
string	basePath

View Source

EmailAuditControllerApi(Configuration)

Initializes a new instance of the EmailAuditControllerApi class using Configuration object

Declaration

public EmailAuditControllerApi(Configuration configuration)

Parameters

Type	Name	Description
Configuration	configuration	An instance of Configuration

View Source

EmailAuditControllerApi(ISynchronousClient, IAsynchronousClient, IReadableConfiguration)

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

Declaration

public EmailAuditControllerApi(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

CompareEmailAudits(Guid, Guid, int)

Compare two email audits

Declaration

public EmailAuditComparisonDto CompareEmailAudits(Guid auditId, Guid otherAuditId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	auditId
Guid	otherAuditId
int	operationIndex	Index associated with the operation.

Returns

Type	Description
EmailAuditComparisonDto	EmailAuditComparisonDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CompareEmailAuditsAsync(Guid, Guid, int, CancellationToken)

Compare two email audits

Declaration

public 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

CompareEmailAuditsWithHttpInfo(Guid, Guid, int)

Compare two email audits

Declaration

public ApiResponse<EmailAuditComparisonDto> CompareEmailAuditsWithHttpInfo(Guid auditId, Guid otherAuditId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	auditId
Guid	otherAuditId
int	operationIndex	Index associated with the operation.

Returns

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

public 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

CreateEmailAudit(CreateEmailAuditOptions, int)

Create email audit

Declaration

public EmailAuditDto CreateEmailAudit(CreateEmailAuditOptions createEmailAuditOptions, int operationIndex = 0)

Parameters

Type	Name	Description
CreateEmailAuditOptions	createEmailAuditOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
EmailAuditDto	EmailAuditDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateEmailAuditAsync(CreateEmailAuditOptions, int, CancellationToken)

Create email audit

Declaration

public 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

CreateEmailAuditWithHttpInfo(CreateEmailAuditOptions, int)

Create email audit

Declaration

public ApiResponse<EmailAuditDto> CreateEmailAuditWithHttpInfo(CreateEmailAuditOptions createEmailAuditOptions, int operationIndex = 0)

Parameters

Type	Name	Description
CreateEmailAuditOptions	createEmailAuditOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<EmailAuditDto>	ApiResponse of EmailAuditDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateEmailAuditWithHttpInfoAsync(CreateEmailAuditOptions, int, CancellationToken)

Create email audit

Declaration

public 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

DeleteEmailAudit(Guid, int)

Delete email audit

Declaration

public void DeleteEmailAudit(Guid auditId, int operationIndex = 0)

Parameters

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteEmailAuditAsync(Guid, int, CancellationToken)

Delete email audit

Declaration

public 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

DeleteEmailAuditWithHttpInfo(Guid, int)

Delete email audit

Declaration

public ApiResponse<object> DeleteEmailAuditWithHttpInfo(Guid auditId, int operationIndex = 0)

Parameters

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

DeleteEmailAuditWithHttpInfoAsync(Guid, int, CancellationToken)

Delete email audit

Declaration

public 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

GetBasePath()

Gets the base path of the API client.

Declaration

public string GetBasePath()

Returns

Type	Description
string	The base path

View Source

GetEmailAudit(Guid, int)

Get email audit

Declaration

public EmailAuditDto GetEmailAudit(Guid auditId, int operationIndex = 0)

Parameters

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

Returns

Type	Description
EmailAuditDto	EmailAuditDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetEmailAuditAsync(Guid, int, CancellationToken)

Get email audit

Declaration

public 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

GetEmailAuditWithHttpInfo(Guid, int)

Get email audit

Declaration

public ApiResponse<EmailAuditDto> GetEmailAuditWithHttpInfo(Guid auditId, int operationIndex = 0)

Parameters

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

Returns

Type	Description
ApiResponse<EmailAuditDto>	ApiResponse of EmailAuditDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetEmailAuditWithHttpInfoAsync(Guid, int, CancellationToken)

Get email audit

Declaration

public 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

GetEmailAudits(Guid?, DateTime?, DateTime?, int?, int)

List email audits

Declaration

public List<EmailAuditDto> GetEmailAudits(Guid? emailId = null, DateTime? since = null, DateTime? before = null, int? limit = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid?	emailId	(optional)
DateTime?	since	(optional)
DateTime?	before	(optional)
int?	limit	(optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
List<EmailAuditDto>	List<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

public 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

GetEmailAuditsWithHttpInfo(Guid?, DateTime?, DateTime?, int?, int)

List email audits

Declaration

public ApiResponse<List<EmailAuditDto>> GetEmailAuditsWithHttpInfo(Guid? emailId = null, DateTime? since = null, DateTime? before = null, int? limit = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid?	emailId	(optional)
DateTime?	since	(optional)
DateTime?	before	(optional)
int?	limit	(optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<List<EmailAuditDto>>	ApiResponse 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

public 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

Implements

IEmailAuditControllerApi

IEmailAuditControllerApiSync

IEmailAuditControllerApiAsync

IApiAccessor