MailSlurpAliasControllerApi

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(ctx, 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

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
createAliasOptionsCreateAliasOptionscreateAliasOptions

Return type

AliasDto

Authorization

API_KEY

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to ]

DeleteAlias

DeleteAlias(ctx, aliasId)

Delete an email alias

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
aliasIdstringaliasId

Return type

(empty response body)

Authorization

API_KEY

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to ]

GetAlias

AliasDto GetAlias(ctx, aliasId)

Get an email alias

Get an email alias by ID

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
aliasIdstringaliasId

Return type

AliasDto

Authorization

API_KEY

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to ]

GetAliasEmails

PageEmailProjection GetAliasEmails(ctx, aliasId, optional)

Get emails for an alias

Get paginated emails for an alias by ID

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
aliasIdstringaliasId
optional*GetAliasEmailsOptsoptional parametersnil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetAliasEmailsOpts struct

NameTypeDescriptionNotes

before | optional.Time| Optional filter by sent before given date time | page | optional.Int32| Optional page alias email list pagination | [default to 0] since | optional.Time| Optional filter by sent after given date time | size | optional.Int32| Optional page size alias email list pagination | [default to 20] sort | optional.String| Optional createdAt sort direction ASC or DESC | [default to ASC]

Return type

PageEmailProjection

Authorization

API_KEY

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to ]

GetAliasThreads

PageThreadProjection GetAliasThreads(ctx, aliasId, optional)

Get threads created for an alias

Returns threads created for an email alias in paginated form

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
aliasIdstringaliasId
optional*GetAliasThreadsOptsoptional parametersnil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetAliasThreadsOpts struct

NameTypeDescriptionNotes

before | optional.Time| Optional filter by sent before given date time | page | optional.Int32| Optional page in thread list pagination | [default to 0] since | optional.Time| Optional filter by sent after given date time | size | optional.Int32| Optional page size in thread list pagination | [default to 20] sort | optional.String| Optional createdAt sort direction ASC or DESC | [default to ASC]

Return type

PageThreadProjection

Authorization

API_KEY

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to ]

GetAliases

PageAlias GetAliases(ctx, optional)

Get all email aliases you have created

Get all email aliases in paginated form

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
optional*GetAliasesOptsoptional parametersnil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetAliasesOpts struct

NameTypeDescriptionNotes
beforeoptional.TimeFilter by created at before the given timestamp
pageoptional.Int32Optional page in alias list pagination[default to 0]
sinceoptional.TimeFilter by created at after the given timestamp
sizeoptional.Int32Optional page size in alias list pagination[default to 20]
sortoptional.StringOptional createdAt sort direction ASC or DESC[default to ASC]

Return type

PageAlias

Authorization

API_KEY

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to ]

ReplyToAliasEmail

SentEmailDto ReplyToAliasEmail(ctx, 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.

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
aliasIdstringID of the alias that email belongs to
emailIdstringID of the email that should be replied to
replyToAliasEmailOptionsReplyToAliasEmailOptionsreplyToAliasEmailOptions

Return type

SentEmailDto

Authorization

API_KEY

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to ]

SendAliasEmail

SentEmailDto SendAliasEmail(ctx, aliasId, optional)

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

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
aliasIdstringaliasId
optional*SendAliasEmailOptsoptional parametersnil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a SendAliasEmailOpts struct

NameTypeDescriptionNotes

sendEmailOptions | optional.Interface of SendEmailOptions| Options for the email to be sent |

Return type

SentEmailDto

Authorization

API_KEY

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to ]

UpdateAlias

UpdateAlias(ctx, aliasId, updateAliasOptions)

Update an email alias

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
aliasIdstringaliasId
updateAliasOptionsUpdateAliasOptionsupdateAliasOptions

Return type

(empty response body)

Authorization

API_KEY

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to ]