MailSlurpAPI.Api.CommonActionsController (mailslurp v11.7.502)
API calls for all endpoints tagged CommonActionsController
.
Link to this section Summary
Functions
Create new random inbox
Returns an Inbox with an id
and an emailAddress
Create new random inbox
Returns an Inbox with an id
and an emailAddress
Delete all emails in an inbox Deletes all emails
Send an email If no senderId or inboxId provided a random email address will be used to send from.
Link to this section Functions
create_new_email_address(connection, opts \\ [])
Specs
create_new_email_address(Tesla.Env.client(), keyword()) :: {:ok, MailSlurpAPI.Model.Inbox.t()} | {:error, Tesla.Env.t()}
Create new random inbox
Returns an Inbox with an id
and an emailAddress
Parameters
- connection (MailSlurpAPI.Connection): Connection to server
- opts (KeywordList): [optional] Optional parameters
} on success {:error, info} on failure
create_new_email_address1(connection, opts \\ [])
Specs
create_new_email_address1(Tesla.Env.client(), keyword()) :: {:ok, MailSlurpAPI.Model.Inbox.t()} | {:error, Tesla.Env.t()}
Create new random inbox
Returns an Inbox with an id
and an emailAddress
Parameters
- connection (MailSlurpAPI.Connection): Connection to server
- opts (KeywordList): [optional] Optional parameters
} on success {:error, info} on failure
empty_inbox(connection, inbox_id, opts \\ [])
Specs
empty_inbox(Tesla.Env.client(), String.t(), keyword()) :: {:ok, nil} | {:error, Tesla.Env.t()}
Delete all emails in an inbox Deletes all emails
Parameters
- connection (MailSlurpAPI.Connection): Connection to server
- inbox_id (String.t): inboxId
- opts (KeywordList): [optional] Optional parameters
Returns
} on success {:error, info} on failure
send_email_simple(connection, email_options, opts \\ [])
Specs
send_email_simple( Tesla.Env.client(), MailSlurpAPI.Model.SimpleSendEmailOptions.t(), keyword() ) :: {:ok, nil} | {:error, Tesla.Env.t()}
Send an email If no senderId or inboxId provided a random email address will be used to send from.
Parameters
- connection (MailSlurpAPI.Connection): Connection to server
- email_options (SimpleSendEmailOptions): emailOptions
- opts (KeywordList): [optional] Optional parameters
Returns
} on success {:error, info} on failure