MailSlurpAPI.Api.EmailController.get_emails_paginated
You're seeing just the function
get_emails_paginated
, go back to MailSlurpAPI.Api.EmailController module for more information.
Link to this function
get_emails_paginated(connection, opts \\ [])
Specs
get_emails_paginated(Tesla.Env.client(), keyword()) :: {:ok, MailSlurpAPI.Model.PageEmailProjection.t()} | {:error, Tesla.Env.t()}
Get all emails in all inboxes in paginated form. Email API list all. By default returns all emails across all inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages
Parameters
- connection (MailSlurpAPI.Connection): Connection to server
- opts (KeywordList): [optional] Optional parameters
- :inbox_id ([String.t]): Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account.
- :page (integer()): Optional page index in email list pagination
- :search_filter (String.t): Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body
- :size (integer()): Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results
- :sort (String.t): Optional createdAt sort direction ASC or DESC
- :unread_only (boolean()): Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly
Returns
} on success {:error, info} on failure