Skip to content

MailSlurp\CommonActionsControllerApi

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

Method HTTP request Description
CreateNewEmailAddress Post /newEmailAddress Create new random inbox
CreateRandomInbox Post /createInbox Create new random inbox
DeleteEmailAddress Delete /deleteEmailAddress Delete inbox email address by inbox id
EmptyInbox Delete /emptyInbox Delete all emails in an inbox
SendEmailSimple Post /sendEmail Send an email

CreateNewEmailAddress

InboxDto CreateNewEmailAddress(ctx, optional)

Create new random inbox

Returns an Inbox with an id and an emailAddress

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *CreateNewEmailAddressOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a CreateNewEmailAddressOpts struct

Name Type Description Notes
allowTeamAccess optional.Bool
useDomainPool optional.Bool
expiresAt optional.Time
expiresIn optional.Int64
emailAddress optional.String
inboxType optional.String
description optional.String
name optional.String
tags optional.Interface of []string
favourite optional.Bool
virtualInbox optional.Bool

Return type

InboxDto

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

CreateRandomInbox

InboxDto CreateRandomInbox(ctx, optional)

Create new random inbox

Returns an Inbox with an id and an emailAddress

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *CreateRandomInboxOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a CreateRandomInboxOpts struct

Name Type Description Notes
allowTeamAccess optional.Bool
useDomainPool optional.Bool
expiresAt optional.Time
expiresIn optional.Int64
emailAddress optional.String
inboxType optional.String
description optional.String
name optional.String
tags optional.Interface of []string
favourite optional.Bool
virtualInbox optional.Bool

Return type

InboxDto

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

DeleteEmailAddress

DeleteEmailAddress(ctx, inboxId)

Delete inbox email address by inbox id

Deletes inbox email address

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
inboxId string

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 ]

EmptyInbox

EmptyInbox(ctx, inboxId)

Delete all emails in an inbox

Deletes all emails

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
inboxId string

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, simpleSendEmailOptions)

Send an email

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

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
simpleSendEmailOptions SimpleSendEmailOptions

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 ]