AliasControllerApi

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

MethodHTTP requestDescription
createAliasPOST /aliasesCreate 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.
deleteAliasDELETE /aliases/{aliasId}Delete an email alias
getAliasGET /aliases/{aliasId}Get an email alias
getAliasEmailsGET /aliases/{aliasId}/emailsGet emails for an alias
getAliasThreadsGET /aliases/{aliasId}/threadsGet threads created for an alias
getAliasesGET /aliasesGet all email aliases you have created
replyToAliasEmailPUT /aliases/{aliasId}/emails/{emailId}Reply to an email
sendAliasEmailPOST /aliases/{aliasId}/emailsSend an email from an alias inbox
updateAliasPUT /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

NameTypeDescriptionNotes
createAliasOptionsCreateAliasOptionscreateAliasOptions

Return type

AliasDto

Authorization

API_KEY

HTTP request headers

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

deleteAlias

deleteAlias(aliasId)

Delete an email alias

Parameters

NameTypeDescriptionNotes
aliasIdUUIDaliasId[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

NameTypeDescriptionNotes
aliasIdUUIDaliasId[default to null]

Return type

AliasDto

Authorization

API_KEY

HTTP request headers

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

getAliasEmails

PageEmailProjection getAliasEmails(aliasId, before, page, since, size, sort)

Get emails for an alias

Get paginated emails for an alias by ID

Parameters

NameTypeDescriptionNotes
aliasIdUUIDaliasId[default to null]
beforeDateOptional filter by sent before given date time[optional] [default to null]
pageIntegerOptional page alias email list pagination[optional] [default to 0]
sinceDateOptional filter by sent after given date time[optional] [default to null]
sizeIntegerOptional page size alias email list pagination[optional] [default to 20]
sortStringOptional 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, before, page, since, size, sort)

Get threads created for an alias

Returns threads created for an email alias in paginated form

Parameters

NameTypeDescriptionNotes
aliasIdUUIDaliasId[default to null]
beforeDateOptional filter by sent before given date time[optional] [default to null]
pageIntegerOptional page in thread list pagination[optional] [default to 0]
sinceDateOptional filter by sent after given date time[optional] [default to null]
sizeIntegerOptional page size in thread list pagination[optional] [default to 20]
sortStringOptional 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(before, page, since, size, sort)

Get all email aliases you have created

Get all email aliases in paginated form

Parameters

NameTypeDescriptionNotes
beforeDateFilter by created at before the given timestamp[optional] [default to null]
pageIntegerOptional page in alias list pagination[optional] [default to 0]
sinceDateFilter by created at after the given timestamp[optional] [default to null]
sizeIntegerOptional page size in alias list pagination[optional] [default to 20]
sortStringOptional 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

NameTypeDescriptionNotes
aliasIdUUIDID of the alias that email belongs to[default to null]
emailIdUUIDID of the email that should be replied to[default to null]
replyToAliasEmailOptionsReplyToAliasEmailOptionsreplyToAliasEmailOptions

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

NameTypeDescriptionNotes
aliasIdUUIDaliasId[default to null]
sendEmailOptionsSendEmailOptionsOptions 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

NameTypeDescriptionNotes
aliasIdUUIDaliasId[default to null]
updateAliasOptionsUpdateAliasOptionsupdateAliasOptions

Return type

null (empty response body)

Authorization

API_KEY

HTTP request headers

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