CommonActionsControllerApi

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(allowTeamAccess, expiresAt, expiresIn, useDomainPool)

Create new random inbox

Returns an Inbox with an `id` and an `emailAddress`

Parameters

NameTypeDescriptionNotes
allowTeamAccessBooleanallowTeamAccess[optional] [default to null]
expiresAtDateexpiresAt[optional] [default to null]
expiresInLongexpiresIn[optional] [default to null]
useDomainPoolBooleanuseDomainPool[optional] [default to null]

Return type

Inbox

Authorization

API_KEY

HTTP request headers

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

createNewEmailAddress1

Inbox createNewEmailAddress1(allowTeamAccess, expiresAt, expiresIn, useDomainPool)

Create new random inbox

Returns an Inbox with an `id` and an `emailAddress`

Parameters

NameTypeDescriptionNotes
allowTeamAccessBooleanallowTeamAccess[optional] [default to null]
expiresAtDateexpiresAt[optional] [default to null]
expiresInLongexpiresIn[optional] [default to null]
useDomainPoolBooleanuseDomainPool[optional] [default to null]

Return type

Inbox

Authorization

API_KEY

HTTP request headers

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

emptyInbox

emptyInbox(inboxId)

Delete all emails in an inbox

Deletes all emails

Parameters

NameTypeDescriptionNotes
inboxIdUUIDinboxId[default to null]

Return type

null (empty response body)

Authorization

API_KEY

HTTP request headers

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

sendEmailSimple

sendEmailSimple(emailOptions)

Send an email

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

Parameters

NameTypeDescriptionNotes
emailOptionsSimpleSendEmailOptionsemailOptions

Return type

null (empty response body)

Authorization

API_KEY

HTTP request headers

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