AliasController

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

post/aliases

Request

  • Base URL: https://api.mailslurp.com
  • URL: https://api.mailslurp.com/aliases
  • Auth: API key in header x-api-key

Request body

emailAddressstring required

Email address to be hidden behind alias. Emails sent to the alias email address will be forwarded to this address. If you want to enable replies set useThreads true and the reply-to for the email will allow outbound communication via a thread. Some email addresses may require verification if they are not added as a contact first.

inboxIdstring uuid nullable

Optional inbox ID to attach to alias. Null by default means an a new inbox will be created for the alias. Use a custom inbox to control what email address the alias uses. To use custom email addresses create a domain and an inbox, the use the inbox ID with this call. Emails received by this inbox will be forwarded to the alias email address

namestring nullable

Optional name for alias

useThreadsboolean required

Enable threads options. If true emails will be sent with a unique reply-to thread address. This means you can reply to the forwarded email and it will be sent to the recipients via your alias address. That way a thread conversation is preserved.

domainIdstring uuid nullable

Custom domain ID to use when generating alias email addresses

verifyEmailAddressboolean nullable

Whether to verify the masked email address exists before sending an email to it

Response

Created

Changes

No recorded changes to this operation across all 1 revision of this API.