Class AliasControllerApi

Represents a collection of functions to interact with the API endpoints

Inheritance
object
AliasControllerApi
Implements
Inherited Members
Namespace: mailslurp.Api
Assembly: mailslurp.dll
Syntax
public class AliasControllerApi : IAliasControllerApi, IAliasControllerApiSync, IAliasControllerApiAsync, IApiAccessor

Constructors

View Source

AliasControllerApi()

Initializes a new instance of the AliasControllerApi class.

Declaration
public AliasControllerApi()
View Source

AliasControllerApi(string)

Initializes a new instance of the AliasControllerApi class.

Declaration
public AliasControllerApi(string basePath)
Parameters
Type Name Description
string basePath
View Source

AliasControllerApi(Configuration)

Initializes a new instance of the AliasControllerApi class using Configuration object

Declaration
public AliasControllerApi(Configuration configuration)
Parameters
Type Name Description
Configuration configuration

An instance of Configuration
View Source

AliasControllerApi(ISynchronousClient, IAsynchronousClient, IReadableConfiguration)

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

Declaration
public AliasControllerApi(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

CreateAlias(CreateAliasOptions, int)

Create an email alias. Must be verified by clicking link inside verification email that will be sent to the address. Once verified the alias will be active. Email aliases use a MailSlurp randomly generated email address (or a custom domain inbox that you provide) to mask or proxy a real email address. Emails sent to the alias address will be forwarded to the hidden email address it was created for. If you want to send a reply use the threadId attached

Declaration
public AliasDto CreateAlias(CreateAliasOptions createAliasOptions, int operationIndex = 0)
Parameters
Type Name Description
CreateAliasOptions createAliasOptions
int operationIndex

Index associated with the operation.
Returns
Type Description
AliasDto

AliasDto
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

CreateAliasAsync(CreateAliasOptions, int, CancellationToken)

Create an email alias. Must be verified by clicking link inside verification email that will be sent to the address. Once verified the alias will be active. Email aliases use a MailSlurp randomly generated email address (or a custom domain inbox that you provide) to mask or proxy a real email address. Emails sent to the alias address will be forwarded to the hidden email address it was created for. If you want to send a reply use the threadId attached

Declaration
public Task<AliasDto> CreateAliasAsync(CreateAliasOptions createAliasOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
CreateAliasOptions createAliasOptions
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

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

Task of AliasDto
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

CreateAliasWithHttpInfo(CreateAliasOptions, int)

Create an email alias. Must be verified by clicking link inside verification email that will be sent to the address. Once verified the alias will be active. Email aliases use a MailSlurp randomly generated email address (or a custom domain inbox that you provide) to mask or proxy a real email address. Emails sent to the alias address will be forwarded to the hidden email address it was created for. If you want to send a reply use the threadId attached

Declaration
public ApiResponse<AliasDto> CreateAliasWithHttpInfo(CreateAliasOptions createAliasOptions, int operationIndex = 0)
Parameters
Type Name Description
CreateAliasOptions createAliasOptions
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<AliasDto>

ApiResponse of AliasDto
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

CreateAliasWithHttpInfoAsync(CreateAliasOptions, int, CancellationToken)

Create an email alias. Must be verified by clicking link inside verification email that will be sent to the address. Once verified the alias will be active. Email aliases use a MailSlurp randomly generated email address (or a custom domain inbox that you provide) to mask or proxy a real email address. Emails sent to the alias address will be forwarded to the hidden email address it was created for. If you want to send a reply use the threadId attached

Declaration
public Task<ApiResponse<AliasDto>> CreateAliasWithHttpInfoAsync(CreateAliasOptions createAliasOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
CreateAliasOptions createAliasOptions
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

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

Task of ApiResponse (AliasDto)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

DeleteAlias(Guid, int)

Delete an email alias

Declaration
public void DeleteAlias(Guid aliasId, int operationIndex = 0)
Parameters
Type Name Description
Guid aliasId
int operationIndex

Index associated with the operation.
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

DeleteAliasAsync(Guid, int, CancellationToken)

Delete an email alias

Declaration
public Task DeleteAliasAsync(Guid aliasId, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Guid aliasId
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

DeleteAliasWithHttpInfo(Guid, int)

Delete an email alias

Declaration
public ApiResponse<object> DeleteAliasWithHttpInfo(Guid aliasId, int operationIndex = 0)
Parameters
Type Name Description
Guid aliasId
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

DeleteAliasWithHttpInfoAsync(Guid, int, CancellationToken)

Delete an email alias

Declaration
public Task<ApiResponse<object>> DeleteAliasWithHttpInfoAsync(Guid aliasId, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Guid aliasId
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

GetAlias(Guid, int)

Get an email alias Get an email alias by ID

Declaration
public AliasDto GetAlias(Guid aliasId, int operationIndex = 0)
Parameters
Type Name Description
Guid aliasId
int operationIndex

Index associated with the operation.
Returns
Type Description
AliasDto

AliasDto
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetAliasAsync(Guid, int, CancellationToken)

Get an email alias Get an email alias by ID

Declaration
public Task<AliasDto> GetAliasAsync(Guid aliasId, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Guid aliasId
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

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

Task of AliasDto
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

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

Get emails for an alias Get paginated emails for an alias by ID

Declaration
public PageEmailProjection GetAliasEmails(Guid aliasId, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)
Parameters
Type Name Description
Guid aliasId
int? page

Optional page index alias email list pagination (optional, default to 0)
int? size

Optional page size alias email list pagination (optional, default to 20)
string sort

Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime? since

Optional filter by sent after given date time (optional)
DateTime? before

Optional filter by sent before given date time (optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
PageEmailProjection

PageEmailProjection
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetAliasEmailsAsync(Guid, int?, int?, string, DateTime?, DateTime?, int, CancellationToken)

Get emails for an alias Get paginated emails for an alias by ID

Declaration
public Task<PageEmailProjection> GetAliasEmailsAsync(Guid aliasId, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Guid aliasId
int? page

Optional page index alias email list pagination (optional, default to 0)
int? size

Optional page size alias email list pagination (optional, default to 20)
string sort

Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime? since

Optional filter by sent after given date time (optional)
DateTime? before

Optional filter by sent before given date time (optional)
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

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

Task of PageEmailProjection
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

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

Get emails for an alias Get paginated emails for an alias by ID

Declaration
public ApiResponse<PageEmailProjection> GetAliasEmailsWithHttpInfo(Guid aliasId, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)
Parameters
Type Name Description
Guid aliasId
int? page

Optional page index alias email list pagination (optional, default to 0)
int? size

Optional page size alias email list pagination (optional, default to 20)
string sort

Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime? since

Optional filter by sent after given date time (optional)
DateTime? before

Optional filter by sent before given date time (optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<PageEmailProjection>

ApiResponse of PageEmailProjection
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetAliasEmailsWithHttpInfoAsync(Guid, int?, int?, string, DateTime?, DateTime?, int, CancellationToken)

Get emails for an alias Get paginated emails for an alias by ID

Declaration
public Task<ApiResponse<PageEmailProjection>> GetAliasEmailsWithHttpInfoAsync(Guid aliasId, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Guid aliasId
int? page

Optional page index alias email list pagination (optional, default to 0)
int? size

Optional page size alias email list pagination (optional, default to 20)
string sort

Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime? since

Optional filter by sent after given date time (optional)
DateTime? before

Optional filter by sent before given date time (optional)
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

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

Task of ApiResponse (PageEmailProjection)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

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

Get threads created for an alias Returns threads created for an email alias in paginated form

Declaration
public PageAliasThreadProjection GetAliasThreads(Guid aliasId, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)
Parameters
Type Name Description
Guid aliasId
int? page

Optional page index in thread list pagination (optional, default to 0)
int? size

Optional page size in thread list pagination (optional, default to 20)
string sort

Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime? since

Optional filter by sent after given date time (optional)
DateTime? before

Optional filter by sent before given date time (optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
PageAliasThreadProjection

PageAliasThreadProjection
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetAliasThreadsAsync(Guid, int?, int?, string, DateTime?, DateTime?, int, CancellationToken)

Get threads created for an alias Returns threads created for an email alias in paginated form

Declaration
public Task<PageAliasThreadProjection> GetAliasThreadsAsync(Guid aliasId, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Guid aliasId
int? page

Optional page index in thread list pagination (optional, default to 0)
int? size

Optional page size in thread list pagination (optional, default to 20)
string sort

Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime? since

Optional filter by sent after given date time (optional)
DateTime? before

Optional filter by sent before given date time (optional)
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

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

Task of PageAliasThreadProjection
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

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

Get threads created for an alias Returns threads created for an email alias in paginated form

Declaration
public ApiResponse<PageAliasThreadProjection> GetAliasThreadsWithHttpInfo(Guid aliasId, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)
Parameters
Type Name Description
Guid aliasId
int? page

Optional page index in thread list pagination (optional, default to 0)
int? size

Optional page size in thread list pagination (optional, default to 20)
string sort

Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime? since

Optional filter by sent after given date time (optional)
DateTime? before

Optional filter by sent before given date time (optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<PageAliasThreadProjection>

ApiResponse of PageAliasThreadProjection
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetAliasThreadsWithHttpInfoAsync(Guid, int?, int?, string, DateTime?, DateTime?, int, CancellationToken)

Get threads created for an alias Returns threads created for an email alias in paginated form

Declaration
public Task<ApiResponse<PageAliasThreadProjection>> GetAliasThreadsWithHttpInfoAsync(Guid aliasId, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Guid aliasId
int? page

Optional page index in thread list pagination (optional, default to 0)
int? size

Optional page size in thread list pagination (optional, default to 20)
string sort

Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime? since

Optional filter by sent after given date time (optional)
DateTime? before

Optional filter by sent before given date time (optional)
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

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

Task of ApiResponse (PageAliasThreadProjection)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetAliasWithHttpInfo(Guid, int)

Get an email alias Get an email alias by ID

Declaration
public ApiResponse<AliasDto> GetAliasWithHttpInfo(Guid aliasId, int operationIndex = 0)
Parameters
Type Name Description
Guid aliasId
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<AliasDto>

ApiResponse of AliasDto
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetAliasWithHttpInfoAsync(Guid, int, CancellationToken)

Get an email alias Get an email alias by ID

Declaration
public Task<ApiResponse<AliasDto>> GetAliasWithHttpInfoAsync(Guid aliasId, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Guid aliasId
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

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

Task of ApiResponse (AliasDto)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetAliases(string, int?, int?, string, DateTime?, DateTime?, int)

Get all email aliases you have created Get all email aliases in paginated form

Declaration
public PageAlias GetAliases(string search = null, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)
Parameters
Type Name Description
string search

Optional search term (optional)
int? page

Optional page index in alias list pagination (optional, default to 0)
int? size

Optional page size in alias list pagination (optional, default to 20)
string sort

Optional createdAt sort direction ASC or DESC (optional, default to ASC)
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
PageAlias

PageAlias
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetAliasesAsync(string, int?, int?, string, DateTime?, DateTime?, int, CancellationToken)

Get all email aliases you have created Get all email aliases in paginated form

Declaration
public Task<PageAlias> GetAliasesAsync(string search = null, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string search

Optional search term (optional)
int? page

Optional page index in alias list pagination (optional, default to 0)
int? size

Optional page size in alias list pagination (optional, default to 20)
string sort

Optional createdAt sort direction ASC or DESC (optional, default to ASC)
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.
CancellationToken cancellationToken

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

Task of PageAlias
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetAliasesWithHttpInfo(string, int?, int?, string, DateTime?, DateTime?, int)

Get all email aliases you have created Get all email aliases in paginated form

Declaration
public ApiResponse<PageAlias> GetAliasesWithHttpInfo(string search = null, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)
Parameters
Type Name Description
string search

Optional search term (optional)
int? page

Optional page index in alias list pagination (optional, default to 0)
int? size

Optional page size in alias list pagination (optional, default to 20)
string sort

Optional createdAt sort direction ASC or DESC (optional, default to ASC)
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<PageAlias>

ApiResponse of PageAlias
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetAliasesWithHttpInfoAsync(string, int?, int?, string, DateTime?, DateTime?, int, CancellationToken)

Get all email aliases you have created Get all email aliases in paginated form

Declaration
public Task<ApiResponse<PageAlias>> GetAliasesWithHttpInfoAsync(string search = null, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string search

Optional search term (optional)
int? page

Optional page index in alias list pagination (optional, default to 0)
int? size

Optional page size in alias list pagination (optional, default to 20)
string sort

Optional createdAt sort direction ASC or DESC (optional, default to ASC)
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.
CancellationToken cancellationToken

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

Task of ApiResponse (PageAlias)
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

GetThread(Guid, int)

Get a thread Return a thread associated with an alias

Declaration
public AliasThreadProjection GetThread(Guid threadId, int operationIndex = 0)
Parameters
Type Name Description
Guid threadId
int operationIndex

Index associated with the operation.
Returns
Type Description
AliasThreadProjection

AliasThreadProjection
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetThreadAsync(Guid, int, CancellationToken)

Get a thread Return a thread associated with an alias

Declaration
public Task<AliasThreadProjection> GetThreadAsync(Guid threadId, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Guid threadId
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

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

Task of AliasThreadProjection
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetThreadWithHttpInfo(Guid, int)

Get a thread Return a thread associated with an alias

Declaration
public ApiResponse<AliasThreadProjection> GetThreadWithHttpInfo(Guid threadId, int operationIndex = 0)
Parameters
Type Name Description
Guid threadId
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<AliasThreadProjection>

ApiResponse of AliasThreadProjection
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetThreadWithHttpInfoAsync(Guid, int, CancellationToken)

Get a thread Return a thread associated with an alias

Declaration
public Task<ApiResponse<AliasThreadProjection>> GetThreadWithHttpInfoAsync(Guid threadId, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Guid threadId
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

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

Task of ApiResponse (AliasThreadProjection)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetThreadsPaginated(int?, int?, string, DateTime?, DateTime?, int)

Get all threads Returns threads created for all aliases in paginated form

Declaration
public PageAliasThreadProjection GetThreadsPaginated(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)
Parameters
Type Name Description
int? page

Optional page index in thread list pagination (optional, default to 0)
int? size

Optional page size in thread list pagination (optional, default to 20)
string sort

Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime? since

Optional filter by sent after given date time (optional)
DateTime? before

Optional filter by sent before given date time (optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
PageAliasThreadProjection

PageAliasThreadProjection
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetThreadsPaginatedAsync(int?, int?, string, DateTime?, DateTime?, int, CancellationToken)

Get all threads Returns threads created for all aliases in paginated form

Declaration
public Task<PageAliasThreadProjection> GetThreadsPaginatedAsync(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int? page

Optional page index in thread list pagination (optional, default to 0)
int? size

Optional page size in thread list pagination (optional, default to 20)
string sort

Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime? since

Optional filter by sent after given date time (optional)
DateTime? before

Optional filter by sent before given date time (optional)
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

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

Task of PageAliasThreadProjection
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetThreadsPaginatedWithHttpInfo(int?, int?, string, DateTime?, DateTime?, int)

Get all threads Returns threads created for all aliases in paginated form

Declaration
public ApiResponse<PageAliasThreadProjection> GetThreadsPaginatedWithHttpInfo(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)
Parameters
Type Name Description
int? page

Optional page index in thread list pagination (optional, default to 0)
int? size

Optional page size in thread list pagination (optional, default to 20)
string sort

Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime? since

Optional filter by sent after given date time (optional)
DateTime? before

Optional filter by sent before given date time (optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<PageAliasThreadProjection>

ApiResponse of PageAliasThreadProjection
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetThreadsPaginatedWithHttpInfoAsync(int?, int?, string, DateTime?, DateTime?, int, CancellationToken)

Get all threads Returns threads created for all aliases in paginated form

Declaration
public Task<ApiResponse<PageAliasThreadProjection>> GetThreadsPaginatedWithHttpInfoAsync(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int? page

Optional page index in thread list pagination (optional, default to 0)
int? size

Optional page size in thread list pagination (optional, default to 20)
string sort

Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime? since

Optional filter by sent after given date time (optional)
DateTime? before

Optional filter by sent before given date time (optional)
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

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

Task of ApiResponse (PageAliasThreadProjection)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

ReplyToAliasEmail(Guid, Guid, ReplyToAliasEmailOptions, int)

Reply to an email Send the reply to the email sender or reply-to and include same subject cc bcc etc. Reply to an email and the contents will be sent with the existing subject to the emails to, cc, and bcc.

Declaration
public SentEmailDto ReplyToAliasEmail(Guid aliasId, Guid emailId, ReplyToAliasEmailOptions replyToAliasEmailOptions, int operationIndex = 0)
Parameters
Type Name Description
Guid aliasId

ID of the alias that email belongs to
Guid emailId

ID of the email that should be replied to
ReplyToAliasEmailOptions replyToAliasEmailOptions
int operationIndex

Index associated with the operation.
Returns
Type Description
SentEmailDto

SentEmailDto
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

ReplyToAliasEmailAsync(Guid, Guid, ReplyToAliasEmailOptions, int, CancellationToken)

Reply to an email Send the reply to the email sender or reply-to and include same subject cc bcc etc. Reply to an email and the contents will be sent with the existing subject to the emails to, cc, and bcc.

Declaration
public Task<SentEmailDto> ReplyToAliasEmailAsync(Guid aliasId, Guid emailId, ReplyToAliasEmailOptions replyToAliasEmailOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Guid aliasId

ID of the alias that email belongs to
Guid emailId

ID of the email that should be replied to
ReplyToAliasEmailOptions replyToAliasEmailOptions
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

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

Task of SentEmailDto
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

ReplyToAliasEmailWithHttpInfo(Guid, Guid, ReplyToAliasEmailOptions, int)

Reply to an email Send the reply to the email sender or reply-to and include same subject cc bcc etc. Reply to an email and the contents will be sent with the existing subject to the emails to, cc, and bcc.

Declaration
public ApiResponse<SentEmailDto> ReplyToAliasEmailWithHttpInfo(Guid aliasId, Guid emailId, ReplyToAliasEmailOptions replyToAliasEmailOptions, int operationIndex = 0)
Parameters
Type Name Description
Guid aliasId

ID of the alias that email belongs to
Guid emailId

ID of the email that should be replied to
ReplyToAliasEmailOptions replyToAliasEmailOptions
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<SentEmailDto>

ApiResponse of SentEmailDto
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

ReplyToAliasEmailWithHttpInfoAsync(Guid, Guid, ReplyToAliasEmailOptions, int, CancellationToken)

Reply to an email Send the reply to the email sender or reply-to and include same subject cc bcc etc. Reply to an email and the contents will be sent with the existing subject to the emails to, cc, and bcc.

Declaration
public Task<ApiResponse<SentEmailDto>> ReplyToAliasEmailWithHttpInfoAsync(Guid aliasId, Guid emailId, ReplyToAliasEmailOptions replyToAliasEmailOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Guid aliasId

ID of the alias that email belongs to
Guid emailId

ID of the email that should be replied to
ReplyToAliasEmailOptions replyToAliasEmailOptions
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

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

Task of ApiResponse (SentEmailDto)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

SendAliasEmail(Guid, SendEmailOptions, int)

Send an email from an alias inbox Send an email from an alias. Replies to the email will be forwarded to the alias masked email address

Declaration
public SentEmailDto SendAliasEmail(Guid aliasId, SendEmailOptions sendEmailOptions, int operationIndex = 0)
Parameters
Type Name Description
Guid aliasId
SendEmailOptions sendEmailOptions
int operationIndex

Index associated with the operation.
Returns
Type Description
SentEmailDto

SentEmailDto
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

SendAliasEmailAsync(Guid, SendEmailOptions, int, CancellationToken)

Send an email from an alias inbox Send an email from an alias. Replies to the email will be forwarded to the alias masked email address

Declaration
public Task<SentEmailDto> SendAliasEmailAsync(Guid aliasId, SendEmailOptions sendEmailOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Guid aliasId
SendEmailOptions sendEmailOptions
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

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

Task of SentEmailDto
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

SendAliasEmailWithHttpInfo(Guid, SendEmailOptions, int)

Send an email from an alias inbox Send an email from an alias. Replies to the email will be forwarded to the alias masked email address

Declaration
public ApiResponse<SentEmailDto> SendAliasEmailWithHttpInfo(Guid aliasId, SendEmailOptions sendEmailOptions, int operationIndex = 0)
Parameters
Type Name Description
Guid aliasId
SendEmailOptions sendEmailOptions
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<SentEmailDto>

ApiResponse of SentEmailDto
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

SendAliasEmailWithHttpInfoAsync(Guid, SendEmailOptions, int, CancellationToken)

Send an email from an alias inbox Send an email from an alias. Replies to the email will be forwarded to the alias masked email address

Declaration
public Task<ApiResponse<SentEmailDto>> SendAliasEmailWithHttpInfoAsync(Guid aliasId, SendEmailOptions sendEmailOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Guid aliasId
SendEmailOptions sendEmailOptions
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

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

Task of ApiResponse (SentEmailDto)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

UpdateAlias(Guid, UpdateAliasOptions, int)

Update an email alias

Declaration
public AliasDto UpdateAlias(Guid aliasId, UpdateAliasOptions updateAliasOptions, int operationIndex = 0)
Parameters
Type Name Description
Guid aliasId
UpdateAliasOptions updateAliasOptions
int operationIndex

Index associated with the operation.
Returns
Type Description
AliasDto

AliasDto
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

UpdateAliasAsync(Guid, UpdateAliasOptions, int, CancellationToken)

Update an email alias

Declaration
public Task<AliasDto> UpdateAliasAsync(Guid aliasId, UpdateAliasOptions updateAliasOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Guid aliasId
UpdateAliasOptions updateAliasOptions
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

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

Task of AliasDto
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

UpdateAliasWithHttpInfo(Guid, UpdateAliasOptions, int)

Update an email alias

Declaration
public ApiResponse<AliasDto> UpdateAliasWithHttpInfo(Guid aliasId, UpdateAliasOptions updateAliasOptions, int operationIndex = 0)
Parameters
Type Name Description
Guid aliasId
UpdateAliasOptions updateAliasOptions
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<AliasDto>

ApiResponse of AliasDto
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

UpdateAliasWithHttpInfoAsync(Guid, UpdateAliasOptions, int, CancellationToken)

Update an email alias

Declaration
public Task<ApiResponse<AliasDto>> UpdateAliasWithHttpInfoAsync(Guid aliasId, UpdateAliasOptions updateAliasOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Guid aliasId
UpdateAliasOptions updateAliasOptions
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

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

Task of ApiResponse (AliasDto)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call

Implements