Interface IEmailAuditControllerApiSync
Represents a collection of functions to interact with the API endpoints
Inherited Members
Namespace: mailslurp.Api
Assembly: mailslurp.dll
Syntax
public interface IEmailAuditControllerApiSync : IApiAccessor
Methods
View SourceCompareEmailAudits(Guid, Guid, int)
Compare two email audits
Declaration
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 |
CompareEmailAuditsWithHttpInfo(Guid, Guid, int)
Compare two email audits
Declaration
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 |
CreateEmailAudit(CreateEmailAuditOptions, int)
Create email audit
Declaration
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 |
CreateEmailAuditWithHttpInfo(CreateEmailAuditOptions, int)
Create email audit
Declaration
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 |
DeleteEmailAudit(Guid, int)
Delete email audit
Declaration
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 |
DeleteEmailAuditWithHttpInfo(Guid, int)
Delete email audit
Declaration
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 |
GetEmailAudit(Guid, int)
Get email audit
Declaration
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 |
GetEmailAuditWithHttpInfo(Guid, int)
Get email audit
Declaration
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 |
GetEmailAudits(Guid?, DateTime?, DateTime?, int?, int)
List email audits
Declaration
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 |
GetEmailAuditsWithHttpInfo(Guid?, DateTime?, DateTime?, int?, int)
List email audits
Declaration
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 |