MailSlurpAPI.Api.CommonActionsController (mailslurp v15.17.22)
API calls for all endpoints tagged CommonActionsController.
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.
Functions
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
- 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()):
- :use_short_address (boolean()):
- :domain_name (String.t):
- :domain_id (String.t):
Returns
} on success {:error, info} on failure
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
- 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()):
- :use_short_address (boolean()):
- :domain_name (String.t):
- :domain_id (String.t):
Returns
} on success {:error, info} on failure
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
- connection (MailSlurpAPI.Connection): Connection to server
- inbox_id (String.t):
- opts (KeywordList): [optional] Optional parameters
Returns
} on success {:error, info} on failure
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
- connection (MailSlurpAPI.Connection): Connection to server
- inbox_id (String.t):
- opts (KeywordList): [optional] Optional parameters
Returns
} on success {:error, info} on failure
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
- connection (MailSlurpAPI.Connection): Connection to server
- simple_send_email_options (SimpleSendEmailOptions):
- opts (KeywordList): [optional] Optional parameters
Returns
} on success {:error, info} on failure