INinfomaniak
Service Mail > Mailboxes > Email Snippets

List all email snippets

Changed on

List all email snippets for the given mailbox

get/1/mail_hostings/{service_mail}/mailboxes/{mailbox}/email-snippets

Request

  • Base URL
    https://api.infomaniak.com
  • URL
    https://api.infomaniak.com/1/mail_hostings/{service_mail}/mailboxes/{mailbox}/email-snippets
  • Auth
    HTTP bearer

Path parameters

service_mailstring required
mailboxstring required

Query parameters

withstring

Optional : Allows loading additional data about a resource, which may include related resources.

order'asc' | 'desc'
order_bystring[]
created_at'asc' | 'desc'

Timestamp {name} has been created

id'asc' | 'desc'

Unique identifier of the resource {name}

last_used_at'asc' | 'desc'
title'asc' | 'desc'
{
  "id": "123456"
}
pageinteger
per_pageinteger
return'total'

Optional : If you pass this parameter with the value total, then the response will be the number of items in the collection, instead of the items themselves.<br /> Part of the total capacity

pageinteger

Optional parameter that define the page number<br /> Part of the pagination capacity

per_pageinteger

Optional parameter that define the number of items per page<br /> Part of the pagination capacity

Response

OK

result'success' | 'error' | 'asynchronous' required

Result of the HTTP request

totalinteger

Total number of items Added when using query parameter page

pageinteger

Number of the current page Added when using query parameter page

pagesinteger

Total number of pages Added when using query parameter page

items_per_pageinteger

Number of items per page Added when using query parameter page

Example response

{
  "result": "success",
  "data": [
    {
      "id": "123456",
      "preview": "<h3>Compagny name</h3><p>John Doe<br/>john.doe@ik.me</p>"
    }
  ],
  "total": 221,
  "page": 2,
  "pages": 15,
  "items_per_page": 15
}

Changes

  • 96ca7c8a0545Revision changes
    • warning

      deleted the query request parameter page

    • warning

      deleted the query request parameter per_page

    • info

      added the new optional query request parameter page

    • info

      added the new optional query request parameter per_page

  • 0cd8a60951f5Revision changes
    • warning

      deleted the query request parameter page

    • warning

      deleted the query request parameter per_page

    • info

      added the new optional query request parameter page

    • info

      added the new optional query request parameter per_page