Outils utilisateur
API REST
Différences
Les différences entre les deux versions sont indiquées ici.
| Les deux côtés de la révision précédenteRévision précédenteProchaine révision | Révision précédente | ||
| rest_api [2018/09/21 07:31] – [Suche in einem Zeitraum] lwsystems | rest_api [2025/10/09 10:52] (actuel) – [Suche nach Header Message-ID] lwsystems | ||
|---|---|---|---|
| Zeile 1: | Zeile 1: | ||
| - | |||
| - | |||
| ====== REST API ====== | ====== REST API ====== | ||
| - | Das REST API bietet ausschließlich eine generelle Authentisierung ohne Zugriffssteuerung für einzelne Benutzer. | + | Das REST API bietet ausschließlich eine generelle Authentisierung ohne Zugriffssteuerung für einzelne Benutzer. Auf das API kann über das [[Rest Interface]] zugegriffen werden. |
| Es dient ausschließlich dazu, Requests der [[rest_interface# | Es dient ausschließlich dazu, Requests der [[rest_interface# | ||
| ===== Durchführung einer Suchanfrage | ===== Durchführung einer Suchanfrage | ||
| Zeile 121: | Zeile 119: | ||
| ==== Suche in einem Zeitraum | ==== Suche in einem Zeitraum | ||
| - | < | + | < |
| Cette recherche concerne les courriels datant de la période comprise entre le 23/08/2013 à 10h20 et le 27/08/2013 à 16h05. | Cette recherche concerne les courriels datant de la période comprise entre le 23/08/2013 à 10h20 et le 27/08/2013 à 16h05. | ||
| - | // | ||
| - | * '' | ||
| - | * '' | ||
| ==== Suchanfrage mit Filterung | ==== Suchanfrage mit Filterung | ||
| Zeile 142: | Zeile 137: | ||
| Cette requête de recherche recherche tous les courriels dans le conteneur standard qui proviennent d'adresses d'expéditeur contenant littéralement « hansen-und-meyer » OU dont les adresses de destinataire contiennent littéralement « vertrieb@ ». | Cette requête de recherche recherche tous les courriels dans le conteneur standard qui proviennent d'adresses d'expéditeur contenant littéralement « hansen-und-meyer » OU dont les adresses de destinataire contiennent littéralement « vertrieb@ ». | ||
| + | |||
| + | ==== Suche nach Header Message-ID | ||
| + | |||
| + | < | ||
| + | |||
| + | In dieser Suchanfrage wird nach der E-Mail mit dem Header // | ||
| ===== Suchkriterien | ===== Suchkriterien | ||
| Zeile 155: | Zeile 156: | ||
| Der API-Call zum Zugriff auf eine archivierte E-Mail dient dazu, eine E-Mail (incl. etwaiger Attachements) aus dem Archiv zu holen. Da jede E-Mail im Archiv eindeutig identifiziert ist, erfolgt der Zugriff über diesen eindeutigen Identifyer. | Der API-Call zum Zugriff auf eine archivierte E-Mail dient dazu, eine E-Mail (incl. etwaiger Attachements) aus dem Archiv zu holen. Da jede E-Mail im Archiv eindeutig identifiziert ist, erfolgt der Zugriff über diesen eindeutigen Identifyer. | ||
| - | ===== Syntaxbeispiel für den Abruf einer E-Mail aus dem Archiv | + | ===== Abruf einer E-Mail aus dem Archiv |
| Remarque : Pour des raisons d’impression, certaines URL s’affichent sur plusieurs lignes. Elles doivent cependant être saisies sur une seule ligne, sans espaces, etc | Remarque : Pour des raisons d’impression, certaines URL s’affichent sur plusieurs lignes. Elles doivent cependant être saisies sur une seule ligne, sans espaces, etc | ||
| Zeile 176: | Zeile 177: | ||
| Die aus dem Archiv gelesene E-Mail wird standardmäßig als JSON Objekt an das aufrufende Programm zurückgegeben. Mittels der Option format kann die Rückgabe der E-Mail im „raw“ Format, also RFC 822 bzw. RFC 2822 (Plaintext) erzwungen werden. | Die aus dem Archiv gelesene E-Mail wird standardmäßig als JSON Objekt an das aufrufende Programm zurückgegeben. Mittels der Option format kann die Rückgabe der E-Mail im „raw“ Format, also RFC 822 bzw. RFC 2822 (Plaintext) erzwungen werden. | ||
| - | *format: „raw“, wenn die Mail im RFC-822 Format | + | * format=raw - E-Mail im RFC-822 Format |
| + | * skipUTF8Recode=true - E-Mail im Orginal zurück geben | ||
| + | * header=true - Secret Header zurück geben | ||
| + | **Achtung!** Um eine E-Mail aus dem Repo zum Re-Indexieren ist es erforderlich, | ||
| ===== Rückgabewerte eines Abrufs einer E-Mail aus dem Archiv | ===== Rückgabewerte eines Abrufs einer E-Mail aus dem Archiv | ||
| ==== Resultatwerte (HTTP-Fehlercodes der Suchoperation): | ==== Resultatwerte (HTTP-Fehlercodes der Suchoperation): | ||
| Zeile 188: | Zeile 192: | ||
| - | ===== Syntaxbeispiel für den Abruf eines Attachments einer E-Mail im Archiv | + | ===== Abruf eines Attachments einer E-Mail im Archiv |
| Une pièce jointe peut être référencée par son nom de fichier ou par son identifiant. | Une pièce jointe peut être référencée par son nom de fichier ou par son identifiant. | ||
| Zeile 271: | Zeile 275: | ||
| " | " | ||
| } | } | ||
| - | </ | + | </ |
| + | ===== Aufbau der Ergebnisliste ===== | ||
| + | |||
| + | La recherche est effectuée exclusivement sur l'index Benno MailArchiv. Toutes les valeurs affichées ici correspondent directement au contenu de l'index, tandis que l'e-mail est lu depuis le dépôt et analysé séparément pour l'affichage. | ||
| + | |||
| + | ==== Zeitstempel (Date) ==== | ||
| + | |||
| + | Lors de l'indexation, l'horodatage de l'en-tête de date est converti au format UTC et enregistré dans le champ d'index correspondant. À l'affichage d'un courriel, cette valeur est convertie au format horaire local. | ||
| + | |||
| + | Beim direkten Zugriff auf das REST-API muss daher darauf geachtet werden, den Inhalt von //" | ||
| + | |||
| + | |||
| + | ====== Repräsentation als Array ====== | ||
| La représentation de ce résultat de recherche dans un langage de programmation tel que PHP ou Perl pourrait ressembler à ceci : | La représentation de ce résultat de recherche dans un langage de programmation tel que PHP ou Perl pourrait ressembler à ceci : | ||
| Zeile 382: | Zeile 398: | ||
| ], | ], | ||
| ' | ' | ||
| - | ' | + | ' |
| ' | ' | ||
| }, | }, | ||
rest_api.1537515071.txt.gz · Zuletzt geändert: 2018/09/21 07:31 von lwsystems
Outils de page
