# AliasControllerApi

All URIs are relative to https://api.mailslurp.com

Method HTTP request Description
createAlias POST /aliases 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.
deleteAlias DELETE /aliases/{aliasId} Delete an email alias
getAlias GET /aliases/{aliasId} Get an email alias
getAliasEmails GET /aliases/{aliasId}/emails Get emails for an alias
getAliasThreads GET /aliases/{aliasId}/threads Get threads created for an alias
getAliases GET /aliases Get all email aliases you have created
replyToAliasEmail PUT /aliases/{aliasId}/emails/{emailId} Reply to an email
sendAliasEmail POST /aliases/{aliasId}/emails Send an email from an alias inbox
updateAlias PUT /aliases/{aliasId} Update an email alias

# createAlias

AliasDto createAlias(createAliasOptions)

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

# Parameters

Name Type Description Notes
createAliasOptions CreateAliasOptions createAliasOptions

# Return type

AliasDto

# Authorization

API_KEY

# HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

# deleteAlias

deleteAlias(aliasId)

Delete an email alias

# Parameters

Name Type Description Notes
aliasId UUID aliasId [default to null]

# Return type

null (empty response body)

# Authorization

API_KEY

# HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

# getAlias

AliasDto getAlias(aliasId)

Get an email alias

Get an email alias by ID

# Parameters

Name Type Description Notes
aliasId UUID aliasId [default to null]

# Return type

AliasDto

# Authorization

API_KEY

# HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

# getAliasEmails

PageEmailProjection getAliasEmails(aliasId, page, size, sort)

Get emails for an alias

Get paginated emails for an alias by ID

# Parameters

Name Type Description Notes
aliasId UUID aliasId [default to null]
page Integer Optional page index alias email list pagination [optional] [default to 0]
size Integer Optional page size alias email list pagination [optional] [default to 20]
sort String Optional createdAt sort direction ASC or DESC [optional] [default to ASC] [enum: ASC, DESC]

# Return type

PageEmailProjection

# Authorization

API_KEY

# HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

# getAliasThreads

PageThreadProjection getAliasThreads(aliasId, page, size, sort)

Get threads created for an alias

Returns threads created for an email alias in paginated form

# Parameters

Name Type Description Notes
aliasId UUID aliasId [default to null]
page Integer Optional page index in thread list pagination [optional] [default to 0]
size Integer Optional page size in thread list pagination [optional] [default to 20]
sort String Optional createdAt sort direction ASC or DESC [optional] [default to ASC] [enum: ASC, DESC]

# Return type

PageThreadProjection

# Authorization

API_KEY

# HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

# getAliases

PageAlias getAliases(page, size, sort)

Get all email aliases you have created

Get all email aliases in paginated form

# Parameters

Name Type Description Notes
page Integer Optional page index in alias list pagination [optional] [default to 0]
size Integer Optional page size in alias list pagination [optional] [default to 20]
sort String Optional createdAt sort direction ASC or DESC [optional] [default to ASC] [enum: ASC, DESC]

# Return type

PageAlias

# Authorization

API_KEY

# HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

# replyToAliasEmail

SentEmailDto replyToAliasEmail(aliasId, emailId, replyToAliasEmailOptions)

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

# Parameters

Name Type Description Notes
aliasId UUID ID of the alias that email belongs to [default to null]
emailId UUID ID of the email that should be replied to [default to null]
replyToAliasEmailOptions ReplyToAliasEmailOptions replyToAliasEmailOptions

# Return type

SentEmailDto

# Authorization

API_KEY

# HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

# sendAliasEmail

SentEmailDto sendAliasEmail(aliasId, sendEmailOptions)

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

# Parameters

Name Type Description Notes
aliasId UUID aliasId [default to null]
sendEmailOptions SendEmailOptions Options for the email to be sent [optional]

# Return type

SentEmailDto

# Authorization

API_KEY

# HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

# updateAlias

updateAlias(aliasId, updateAliasOptions)

Update an email alias

# Parameters

Name Type Description Notes
aliasId UUID aliasId [default to null]
updateAliasOptions UpdateAliasOptions updateAliasOptions

# Return type

null (empty response body)

# Authorization

API_KEY

# HTTP request headers

  • Content-Type: application/json
  • Accept: application/json