MailSlurpCommonActionsControllerApi

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

MethodHTTP requestDescription
CreateNewEmailAddressPost /createInboxCreate new random inbox
CreateNewEmailAddress1Post /newEmailAddressCreate new random inbox
EmptyInboxDelete /emptyInboxDelete all emails in an inbox
SendEmailSimplePost /sendEmailSend an email

CreateNewEmailAddress

Inbox CreateNewEmailAddress(ctx, optional)

Create new random inbox

Returns an Inbox with an id and an emailAddress

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a CreateNewEmailAddressOpts struct

NameTypeDescriptionNotes
allowTeamAccessoptional.BoolallowTeamAccess
descriptionoptional.Stringdescription
emailAddressoptional.StringemailAddress
expiresAtoptional.TimeexpiresAt
expiresInoptional.Int64expiresIn
favouriteoptional.Boolfavourite
inboxTypeoptional.StringinboxType
nameoptional.Stringname
tags**optional.Interface of []string**tags
useDomainPooloptional.BooluseDomainPool

Return type

Inbox

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 ]

CreateNewEmailAddress1

Inbox CreateNewEmailAddress1(ctx, optional)

Create new random inbox

Returns an Inbox with an id and an emailAddress

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a CreateNewEmailAddress1Opts struct

NameTypeDescriptionNotes
allowTeamAccessoptional.BoolallowTeamAccess
descriptionoptional.Stringdescription
emailAddressoptional.StringemailAddress
expiresAtoptional.TimeexpiresAt
expiresInoptional.Int64expiresIn
favouriteoptional.Boolfavourite
inboxTypeoptional.StringinboxType
nameoptional.Stringname
tags**optional.Interface of []string**tags
useDomainPooloptional.BooluseDomainPool

Return type

Inbox

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 ]

EmptyInbox

EmptyInbox(ctx, inboxId)

Delete all emails in an inbox

Deletes all emails

Required Parameters

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

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 ]

SendEmailSimple

SendEmailSimple(ctx, emailOptions)

Send an email

If no senderId or inboxId provided a random email address will be used to send from.

Required Parameters

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

Return type

(empty response body)

Authorization

API_KEY

HTTP request headers

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

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