Class AliasControllerApi

Represents a collection of functions to interact with the API endpoints

Inheritance

object

AliasControllerApi

Implements

IAliasControllerApi

IAliasControllerApiSync

IAliasControllerApiAsync

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 AliasControllerApi : IAliasControllerApi, IAliasControllerApiSync, IAliasControllerApiAsync, IApiAccessor

Constructors

AliasControllerApi()

Initializes a new instance of the AliasControllerApi class.

Declaration

public AliasControllerApi()

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

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.

AliasControllerApi(string)

Initializes a new instance of the AliasControllerApi class.

Declaration

public AliasControllerApi(string basePath)

Parameters

Type	Name	Description
string	basePath

Properties

AsynchronousClient

The client for accessing this underlying API asynchronously.

Declaration

public IAsynchronousClient AsynchronousClient { get; set; }

Property Value

Type	Description
IAsynchronousClient

Client

The client for accessing this underlying API synchronously.

Declaration

public ISynchronousClient Client { get; set; }

Property Value

Type	Description
ISynchronousClient

Configuration

Gets or sets the configuration object

Declaration

public IReadableConfiguration Configuration { get; set; }

Property Value

Type	Description
IReadableConfiguration	An instance of the Configuration

ExceptionFactory

Provides a factory method hook for the creation of exceptions.

Declaration

public ExceptionFactory ExceptionFactory { get; set; }

Property Value

Type	Description
ExceptionFactory

Methods

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

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

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

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

DeleteAlias(Guid, int)

Delete an email alias

Declaration

public void DeleteAlias(Guid aliasId, int operationIndex = 0)

Parameters

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteAliasAsync(Guid, int, CancellationToken)

Delete an email alias

Declaration

public Task DeleteAliasAsync(Guid aliasId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.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

DeleteAliasWithHttpInfo(Guid, int)

Delete an email alias

Declaration

public ApiResponse<object> DeleteAliasWithHttpInfo(Guid aliasId, int operationIndex = 0)

Parameters

Type	Name	Description
System.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

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
System.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

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
System.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

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
System.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

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
System.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

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
System.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

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
System.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

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
System.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

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

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

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

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

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 PageThreadProjection 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
System.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
PageThreadProjection	PageThreadProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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<PageThreadProjection> 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
System.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<PageThreadProjection>	Task of PageThreadProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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<PageThreadProjection> 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
System.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<PageThreadProjection>	ApiResponse of PageThreadProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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<PageThreadProjection>> 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
System.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<PageThreadProjection>>	Task of ApiResponse (PageThreadProjection)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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
System.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

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
System.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

GetBasePath()

Gets the base path of the API client.

Declaration

public string GetBasePath()

Returns

Type	Description
string	The base path

GetThread(Guid, int)

Get a thread Return a thread associated with an alias

Declaration

public ThreadProjection GetThread(Guid threadId, int operationIndex = 0)

Parameters

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

Returns

Type	Description
ThreadProjection	ThreadProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetThreadAsync(Guid, int, CancellationToken)

Get a thread Return a thread associated with an alias

Declaration

public Task<ThreadProjection> GetThreadAsync(Guid threadId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<ThreadProjection>	Task of ThreadProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

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

Declaration

public PageThreadProjection 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
PageThreadProjection	PageThreadProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

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

Declaration

public Task<PageThreadProjection> 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<PageThreadProjection>	Task of PageThreadProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

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

Declaration

public ApiResponse<PageThreadProjection> 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<PageThreadProjection>	ApiResponse of PageThreadProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

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

Declaration

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetThreadWithHttpInfo(Guid, int)

Get a thread Return a thread associated with an alias

Declaration

public ApiResponse<ThreadProjection> GetThreadWithHttpInfo(Guid threadId, int operationIndex = 0)

Parameters

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

Returns

Type	Description
ApiResponse<ThreadProjection>	ApiResponse of ThreadProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetThreadWithHttpInfoAsync(Guid, int, CancellationToken)

Get a thread Return a thread associated with an alias

Declaration

public Task<ApiResponse<ThreadProjection>> GetThreadWithHttpInfoAsync(Guid threadId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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
System.Guid	aliasId	ID of the alias that email belongs to
System.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

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
System.Guid	aliasId	ID of the alias that email belongs to
System.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

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
System.Guid	aliasId	ID of the alias that email belongs to
System.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

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
System.Guid	aliasId	ID of the alias that email belongs to
System.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

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
System.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

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
System.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

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
System.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

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
System.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

UpdateAlias(Guid, UpdateAliasOptions, int)

Update an email alias

Declaration

public AliasDto UpdateAlias(Guid aliasId, UpdateAliasOptions updateAliasOptions, int operationIndex = 0)

Parameters

Type	Name	Description
System.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

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
System.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

UpdateAliasWithHttpInfo(Guid, UpdateAliasOptions, int)

Update an email alias

Declaration

public ApiResponse<AliasDto> UpdateAliasWithHttpInfo(Guid aliasId, UpdateAliasOptions updateAliasOptions, int operationIndex = 0)

Parameters

Type	Name	Description
System.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

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
System.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

IAliasControllerApi

IAliasControllerApiSync

IAliasControllerApiAsync

IApiAccessor