Skip to content

Class: AliasControllerApi

Hierarchy

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new AliasControllerApi(configuration?)

Parameters

Name Type
configuration Configuration

Inherited from

BaseAPI.constructor

Properties

configuration

Protected configuration: Configuration

Inherited from

BaseAPI.configuration

Methods

createAlias

createAlias(requestParameters, initOverrides?): Promise<AliasDto>

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

Parameters

Name Type
requestParameters CreateAliasRequest
initOverrides? RequestInit

Returns

Promise<AliasDto>


createAliasRaw

createAliasRaw(requestParameters, initOverrides?): Promise<ApiResponse<AliasDto>>

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

Parameters

Name Type
requestParameters CreateAliasRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<AliasDto>>


deleteAlias

deleteAlias(requestParameters, initOverrides?): Promise<void>

Delete an email alias

Parameters

Name Type
requestParameters DeleteAliasRequest
initOverrides? RequestInit

Returns

Promise<void>


deleteAliasRaw

deleteAliasRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>

Delete an email alias

Parameters

Name Type
requestParameters DeleteAliasRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<void>>


getAlias

getAlias(requestParameters, initOverrides?): Promise<AliasDto>

Get an email alias by ID Get an email alias

Parameters

Name Type
requestParameters GetAliasRequest
initOverrides? RequestInit

Returns

Promise<AliasDto>


getAliasEmails

getAliasEmails(requestParameters, initOverrides?): Promise<PageEmailProjection>

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

Parameters

Name Type
requestParameters GetAliasEmailsRequest
initOverrides? RequestInit

Returns

Promise<PageEmailProjection>


getAliasEmailsRaw

getAliasEmailsRaw(requestParameters, initOverrides?): Promise<ApiResponse<PageEmailProjection>>

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

Parameters

Name Type
requestParameters GetAliasEmailsRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<PageEmailProjection>>


getAliasRaw

getAliasRaw(requestParameters, initOverrides?): Promise<ApiResponse<AliasDto>>

Get an email alias by ID Get an email alias

Parameters

Name Type
requestParameters GetAliasRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<AliasDto>>


getAliasThreads

getAliasThreads(requestParameters, initOverrides?): Promise<PageThreadProjection>

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

Parameters

Name Type
requestParameters GetAliasThreadsRequest
initOverrides? RequestInit

Returns

Promise<PageThreadProjection>


getAliasThreadsRaw

getAliasThreadsRaw(requestParameters, initOverrides?): Promise<ApiResponse<PageThreadProjection>>

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

Parameters

Name Type
requestParameters GetAliasThreadsRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<PageThreadProjection>>


getAliases

getAliases(requestParameters, initOverrides?): Promise<PageAlias>

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

Parameters

Name Type
requestParameters GetAliasesRequest
initOverrides? RequestInit

Returns

Promise<PageAlias>


getAliasesRaw

getAliasesRaw(requestParameters, initOverrides?): Promise<ApiResponse<PageAlias>>

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

Parameters

Name Type
requestParameters GetAliasesRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<PageAlias>>


replyToAliasEmail

replyToAliasEmail(requestParameters, initOverrides?): Promise<SentEmailDto>

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. Reply to an email

Parameters

Name Type
requestParameters ReplyToAliasEmailRequest
initOverrides? RequestInit

Returns

Promise<SentEmailDto>


replyToAliasEmailRaw

replyToAliasEmailRaw(requestParameters, initOverrides?): Promise<ApiResponse<SentEmailDto>>

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. Reply to an email

Parameters

Name Type
requestParameters ReplyToAliasEmailRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<SentEmailDto>>


request

Protected request(context, initOverrides?): Promise<Response>

Parameters

Name Type
context RequestOpts
initOverrides? RequestInit

Returns

Promise<Response>

Inherited from

BaseAPI.request


sendAliasEmail

sendAliasEmail(requestParameters, initOverrides?): Promise<SentEmailDto>

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

Parameters

Name Type
requestParameters SendAliasEmailRequest
initOverrides? RequestInit

Returns

Promise<SentEmailDto>


sendAliasEmailRaw

sendAliasEmailRaw(requestParameters, initOverrides?): Promise<ApiResponse<SentEmailDto>>

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

Parameters

Name Type
requestParameters SendAliasEmailRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<SentEmailDto>>


updateAlias

updateAlias(requestParameters, initOverrides?): Promise<AliasDto>

Update an email alias

Parameters

Name Type
requestParameters UpdateAliasRequest
initOverrides? RequestInit

Returns

Promise<AliasDto>


updateAliasRaw

updateAliasRaw(requestParameters, initOverrides?): Promise<ApiResponse<AliasDto>>

Update an email alias

Parameters

Name Type
requestParameters UpdateAliasRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<AliasDto>>


withMiddleware

withMiddleware<T>(this, ...middlewares): T

Type parameters

Name Type
T extends BaseAPI<T>

Parameters

Name Type
this T
...middlewares Middleware[]

Returns

T

Inherited from

BaseAPI.withMiddleware


withPostMiddleware

withPostMiddleware<T>(this, ...postMiddlewares): T

Type parameters

Name Type
T extends BaseAPI<T>

Parameters

Name Type
this T
...postMiddlewares (context: ResponseContext) => Promise<void

Returns

T

Inherited from

BaseAPI.withPostMiddleware


withPreMiddleware

withPreMiddleware<T>(this, ...preMiddlewares): T

Type parameters

Name Type
T extends BaseAPI<T>

Parameters

Name Type
this T
...preMiddlewares (context: RequestContext) => Promise<void

Returns

T

Inherited from

BaseAPI.withPreMiddleware