Interface IConsentControllerApiAsync

Represents a collection of functions to interact with the API endpoints

Inherited Members
Namespace: mailslurp.Api
Assembly: mailslurp.dll
Syntax
public interface IConsentControllerApiAsync : IApiAccessor

Methods

View Source

CheckSendingConsentForEmailAddressAsync(string, int, CancellationToken)

Declaration
Task<OptInSendingConsentDto> CheckSendingConsentForEmailAddressAsync(string emailAddress, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string emailAddress

Email address to check consent for
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<OptInSendingConsentDto>

Task of OptInSendingConsentDto
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

CheckSendingConsentForEmailAddressWithHttpInfoAsync(string, int, CancellationToken)

Declaration
Task<ApiResponse<OptInSendingConsentDto>> CheckSendingConsentForEmailAddressWithHttpInfoAsync(string emailAddress, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string emailAddress

Email address to check consent for
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<ApiResponse<OptInSendingConsentDto>>

Task of ApiResponse (OptInSendingConsentDto)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetOptInIdentitiesAsync(int?, int?, string, int, CancellationToken)

Declaration
Task<PageOptInIdentityProjection> GetOptInIdentitiesAsync(int? page = null, int? size = null, string sort = 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)
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<PageOptInIdentityProjection>

Task of PageOptInIdentityProjection
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetOptInIdentitiesWithHttpInfoAsync(int?, int?, string, int, CancellationToken)

Declaration
Task<ApiResponse<PageOptInIdentityProjection>> GetOptInIdentitiesWithHttpInfoAsync(int? page = null, int? size = null, string sort = 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)
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<ApiResponse<PageOptInIdentityProjection>>

Task of ApiResponse (PageOptInIdentityProjection)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

RevokeOptInConsentForEmailAddressAsync(string, int, CancellationToken)

Declaration
Task<OptInSendingConsentDto> RevokeOptInConsentForEmailAddressAsync(string emailAddress, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string emailAddress

Email address to revoke consent for
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<OptInSendingConsentDto>

Task of OptInSendingConsentDto
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

RevokeOptInConsentForEmailAddressWithHttpInfoAsync(string, int, CancellationToken)

Declaration
Task<ApiResponse<OptInSendingConsentDto>> RevokeOptInConsentForEmailAddressWithHttpInfoAsync(string emailAddress, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string emailAddress

Email address to revoke consent for
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<ApiResponse<OptInSendingConsentDto>>

Task of ApiResponse (OptInSendingConsentDto)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

SendOptInConsentForEmailAddressAsync(OptInConsentOptions, int, CancellationToken)

Send a verification code to a user once they have explicitly submitted their email address

Declaration
Task<OptInConsentSendResult> SendOptInConsentForEmailAddressAsync(OptInConsentOptions optInConsentOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
OptInConsentOptions optInConsentOptions
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<OptInConsentSendResult>

Task of OptInConsentSendResult
Remarks

Send double-opt in consent for an email address

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

SendOptInConsentForEmailAddressWithHttpInfoAsync(OptInConsentOptions, int, CancellationToken)

Send a verification code to a user once they have explicitly submitted their email address

Declaration
Task<ApiResponse<OptInConsentSendResult>> SendOptInConsentForEmailAddressWithHttpInfoAsync(OptInConsentOptions optInConsentOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
OptInConsentOptions optInConsentOptions
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<ApiResponse<OptInConsentSendResult>>

Task of ApiResponse (OptInConsentSendResult)
Remarks

Send double-opt in consent for an email address

Exceptions
Type Condition
ApiException

Thrown when fails to make API call