MailSlurpAPI.Api.InboxController.get_all_inboxes

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

get_all_inboxes(connection, opts \\ [])

Specs

get_all_inboxes(Tesla.Env.client(), keyword()) ::
  {:ok, MailSlurpAPI.Model.PageInboxProjection.t()} | {:error, Tesla.Env.t()}

List All Inboxes Paginated List inboxes in paginated form. The results are available on the content property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative getInboxes method returns a full list of inboxes but is limited to 100 results. Results do not include team access inboxes by default. Use organization method to list team inboxes or set teamAccess to true.

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters
    • :favourite (boolean()): Optionally filter results for favourites only
    • :page (integer()): Optional page index in inbox list pagination
    • :search (String.t): Optionally filter by search words partial matching ID, tags, name, and email address
    • :size (integer()): Optional page size in inbox list pagination
    • :sort (String.t): Optional createdAt sort direction ASC or DESC
    • :tag (String.t): Optionally filter by tags. Will return inboxes that include given tags
    • :team_access (boolean()): Optionally filter by team access. Defaults to false so organization inboxes are not included

      Returns

} on success {:error, info} on failure