MailSlurpAPI.Api.CommonActionsController (mailslurp v15.14.0)

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 inbox email address by inbox id Deletes inbox email address

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

Link to this function

create_new_email_address(connection, opts \\ [])

@spec create_new_email_address(Tesla.Env.client(), keyword()) ::
  {:ok, MailSlurpAPI.Model.InboxDto.t()} | {:error, Tesla.Env.t()}

Create new random inbox Returns an Inbox with an id and an emailAddress

parameters

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters
    • :allow_team_access (boolean()):
    • :use_domain_pool (boolean()):
    • :expires_at (DateTime.t):
    • :expires_in (integer()):
    • :email_address (String.t):
    • :inbox_type (String.t):
    • :description (String.t):
    • :name (String.t):
    • :tags ([String.t]):
    • :favourite (boolean()):
    • :virtual_inbox (boolean()):

returns

Returns

} on success {:error, info} on failure

Link to this function

create_random_inbox(connection, opts \\ [])

@spec create_random_inbox(Tesla.Env.client(), keyword()) ::
  {:ok, MailSlurpAPI.Model.InboxDto.t()} | {:error, Tesla.Env.t()}

Create new random inbox Returns an Inbox with an id and an emailAddress

parameters

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters
    • :allow_team_access (boolean()):
    • :use_domain_pool (boolean()):
    • :expires_at (DateTime.t):
    • :expires_in (integer()):
    • :email_address (String.t):
    • :inbox_type (String.t):
    • :description (String.t):
    • :name (String.t):
    • :tags ([String.t]):
    • :favourite (boolean()):
    • :virtual_inbox (boolean()):

returns

Returns

} on success {:error, info} on failure

Link to this function

delete_email_address(connection, inbox_id, opts \\ [])

@spec delete_email_address(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Delete inbox email address by inbox id Deletes inbox email address

parameters

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • inbox_id (String.t):
  • opts (KeywordList): [optional] Optional parameters

returns

Returns

} on success {:error, info} on failure

Link to this function

empty_inbox(connection, inbox_id, opts \\ [])

@spec empty_inbox(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Delete all emails in an inbox Deletes all emails

parameters

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • inbox_id (String.t):
  • opts (KeywordList): [optional] Optional parameters

returns

Returns

} on success {:error, info} on failure

Link to this function

send_email_simple(connection, simple_send_email_options, opts \\ [])

@spec 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

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • simple_send_email_options (SimpleSendEmailOptions):
  • opts (KeywordList): [optional] Optional parameters

returns

Returns

} on success {:error, info} on failure