Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

Inhaltsverzeichnis

Mails abrufen

Endpunkt: GET- /api/v2/mail/query/{baseFilter}?filter={filter}&skip={skip}&take={take}&fields={fields}
Version: 2.22.127
Beschreibung: Ruft Mails mithilfe eines Base Filters ab

Beispiel Request:

/api/v2/mail/query/{basefilter}?filter=direction=0&skip=0&take=100&fields=id,registerUri

Mögliche Werte für den {baseFilter}:

  • all

  • allundone

  • sent

  • outgoing

  • trash

  • draft

  • resubmission

Mögliche Felder für den {filter}:

  • fromDate

  • toDate

  • searchText

  • mailBoxId

  • status

  • isDeleted

  • linkedToRegisterUri

  • direction (Enum)

    • 0 = Eingehende E-Mails

    • 1 = Ausgehende E-Mails

  • orderField

    • Möglichkeiten:

      • id

      • to

      • from

      • subject

      • text

      • registeruri

      • html

  • orderDirection (Enum)

    • 0 = Aufsteigend

    • 1 = Absteigend

Wird beim orderField ein Feld angegeben welches nicht oben aufgelistet ist greift die standard Sortierung nach der id!

Beispiel Response:

200 Statuscode

[
  {
    "id": 1,
    "registerUri": "",
    "subject": "",
    "to": "",
    "cC": "",
    "bCC": "",
    "from": "",
    "mailHeader": "",
    "receivedDate": DateTime.Now,
    "html": "",
    "text": "",
    "isLinked": true,
    "mimeHeaders": "",
    .
    .
    .
    .
  }
]

401 Statuscode:

Kein Body

500 Statuscode:

Interner Server Error

Tritt auf wenn ein oder mehrere Services nicht aufgerufen werden können


  • No labels