Skip to content

\CommonActionsControllerApi

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

Method HTTP request Description
create_new_email_address post /newEmailAddress Create new random inbox
create_random_inbox post /createInbox Create new random inbox
delete_email_address delete /deleteEmailAddress Delete inbox email address by inbox id
empty_inbox delete /emptyInbox Delete all emails in an inbox
send_email_simple post /sendEmail Send an email

create_new_email_address

crate::models::InboxDto create_new_email_address(allow_team_access, use_domain_pool, expires_at, expires_in, email_address, inbox_type, description, name, tags, favourite, virtual_inbox) Create new random inbox

Returns an Inbox with an id and an emailAddress

Parameters

Name Type Description Required Notes
allow_team_access Option<bool>
use_domain_pool Option<bool>
expires_at Option<String>
expires_in Option<i64>
email_address Option<String>
inbox_type Option<String>
description Option<String>
name Option<String>
tags Option<Vec>
favourite Option<bool>
virtual_inbox Option<bool>

Return type

crate::models::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 ]

create_random_inbox

crate::models::InboxDto create_random_inbox(allow_team_access, use_domain_pool, expires_at, expires_in, email_address, inbox_type, description, name, tags, favourite, virtual_inbox) Create new random inbox

Returns an Inbox with an id and an emailAddress

Parameters

Name Type Description Required Notes
allow_team_access Option<bool>
use_domain_pool Option<bool>
expires_at Option<String>
expires_in Option<i64>
email_address Option<String>
inbox_type Option<String>
description Option<String>
name Option<String>
tags Option<Vec>
favourite Option<bool>
virtual_inbox Option<bool>

Return type

crate::models::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 ]

delete_email_address

delete_email_address(inbox_id) Delete inbox email address by inbox id

Deletes inbox email address

Parameters

Name Type Description Required Notes
inbox_id String [required]

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 ]

empty_inbox

empty_inbox(inbox_id) Delete all emails in an inbox

Deletes all emails

Parameters

Name Type Description Required Notes
inbox_id String [required]

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 ]

send_email_simple

send_email_simple(simple_send_email_options) Send an email

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

Parameters

Name Type Description Required Notes
simple_send_email_options SimpleSendEmailOptions [required]

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 ]