Mail Query Api
- Pascal Kordas
Analytics
Inhaltsverzeichnis
Mails abrufen mit Basefilter
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
Auswahl an möglichen Werten für die Fields (Komma-separierte Liste)
id
registerUri,
subject
to.displayName / to.address
from.displayName, from.address
cC.displayName / cC.address
bCC.displayName / bCC.address
my.resubmissionSortDate
mailType [Incoming=0, Outgoing=1, Draft=2]
receivedDate
html
text
isLinked,
tlStatus.userId / tlStatus.state
access.userId / access.accessLevel
my.state
my.isRead
my.resubmissionSortDate Verfügbar ab 2.22.140
my.isResubmissionActive
calc.hasAttachments
my.resubmissionSortDate Verfügbar ab 2.22.160
Mögliche Felder für den {filter}:
Mit den Filter kann das Ergebnis zusätzlich zum Basefilter gefiltert werden. Dies kann verglichen werden mit der Autofilter-Zeile aus dem antonyClient. Es muss hier ein Ausdruck angegeben werden, nach welchen gefiltert wird. Die zu verwendene Variable lautet dabei mail.
Felder:
fromDate
toDate
searchText
mailBoxId
status
isDeleted
linkedToRegisterUri
direction (Enum)
0 = Eingehende E-Mails
1 = Ausgehende E-Mails
orderField
Möglichkeiten:
id
to
from
subject
date (Das ist das MailDate)
resubmissionSortDate
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
Verlinkte Mails eines Objekts abrufen
Endpunkt: GET- /api/v1/mail/query/getLinkedTo?registerUri={registerUri}&skip={skip}&take={take}&fields={fields}
Version: 2.22.127
Beschreibung: Gibt alle Mails zurück die mit dem angegebenen Objekt verknüpft sind
Beispiel Request:
/api/v1/mail/query/getLinkedTo?registerUri=antony://contact/1182&skip=0&take=10&fields="id"Beispiel Response:
200 Statuscode
401 Statuscode:
Kein Body
500 Statuscode:
Interner Server Error
Tritt auf wenn ein oder mehrere Services nicht aufgerufen werden können
Mails abrufen ohne Basefilter
Endpunkt: GET- /api/v1/mail/query/?filter={filter}&skip={skip}&take={take}&fields={fields}
Version: 2.22.127
Beschreibung: Ruft Mails mithilfe eines filters ab
Beispiel Request:
Beispiel Response:
200 Statuscode
401 Statuscode:
Kein Body
500 Statuscode:
Interner Server Error