Interface IAliasControllerApiSync

Represents a collection of functions to interact with the API endpoints

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

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.

Declaration
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
Remarks

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

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.

Declaration
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
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

DeleteAlias(Guid, int)

Delete an email alias

Declaration
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
View Source

DeleteAliasWithHttpInfo(Guid, int)

Delete an email alias

Declaration
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
View Source

GetAlias(Guid, int)

Get an email alias

Declaration
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
Remarks

Get an email alias by ID

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

Declaration
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
Remarks

Get paginated emails for an alias by ID

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

Declaration
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
Remarks

Get paginated emails for an alias by ID

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

Declaration
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
Remarks

Get all email aliases in paginated form

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

Declaration
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
Remarks

Get all email aliases in paginated form

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

Declaration
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
Remarks

Returns threads created for an email alias in paginated form

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

Declaration
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
Remarks

Returns threads created for an email alias in paginated form

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetAliasWithHttpInfo(Guid, int)

Get an email alias

Declaration
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
Remarks

Get an email alias by ID

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetThread(Guid, int)

Get a thread

Declaration
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
Remarks

Return a thread associated with an alias

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

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

Get all threads

Declaration
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
Remarks

Returns threads created for all aliases in paginated form

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

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

Get all threads

Declaration
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
Remarks

Returns threads created for all aliases in paginated form

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetThreadWithHttpInfo(Guid, int)

Get a thread

Declaration
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
Remarks

Return a thread associated with an alias

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

ReplyToAliasEmail(Guid, Guid, ReplyToAliasEmailOptions, int)

Reply to an email

Declaration
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
Remarks

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.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

ReplyToAliasEmailWithHttpInfo(Guid, Guid, ReplyToAliasEmailOptions, int)

Reply to an email

Declaration
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
Remarks

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.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

SendAliasEmail(Guid, SendEmailOptions, int)

Send an email from an alias inbox

Declaration
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
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

SendAliasEmailWithHttpInfo(Guid, SendEmailOptions, int)

Send an email from an alias inbox

Declaration
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
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

UpdateAlias(Guid, UpdateAliasOptions, int)

Update an email alias

Declaration
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
View Source

UpdateAliasWithHttpInfo(Guid, UpdateAliasOptions, int)

Update an email alias

Declaration
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