MailSlurpAPI.Api.InboxController.get_emails

You're seeing just the function get_emails, go back to MailSlurpAPI.Api.InboxController module for more information.
Link to this function

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

Specs

get_emails(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, [MailSlurpAPI.Model.EmailPreview.t()]} | {:error, Tesla.Env.t()}

Get emails in an Inbox. This method is not idempotent as it allows retries and waits if you want certain conditions to be met before returning. For simple listing and sorting of known emails use the email controller instead. List emails that an inbox has received. Only emails that are sent to the inbox's email address will appear in the inbox. It may take several seconds for any email you send to an inbox's email address to appear in the inbox. To make this endpoint wait for a minimum number of emails use the minCount parameter. The server will retry the inbox database until the minCount is satisfied or the retryTimeout is reached

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • inbox_id (String.t): Id of inbox that emails belongs to
  • opts (KeywordList): [optional] Optional parameters
    • :limit (integer()): Limit the result set, ordered by received date time sort direction. Maximum 100. For more listing options see the email controller
    • :min_count (integer()): Minimum acceptable email count. Will cause request to hang (and retry) until minCount is satisfied or retryTimeout is reached.
    • :retry_timeout (integer()): Maximum milliseconds to spend retrying inbox database until minCount emails are returned
    • :since (DateTime.t): Exclude emails received before this ISO 8601 date time
    • :size (integer()): Alias for limit. Assessed first before assessing any passed limit.
    • :sort (String.t): Sort the results by received date and direction ASC or DESC

      Returns

, ...]} on success {:error, info} on failure