Skip to main content

Übersicht

Die maildaemon-API bietet Funktionen zum Lesen von Überwachungsdatenbanken und zur Durchführung von Operationen im Zusammenhang mit Postfachkonfigurationen. Mit dieser API können Sie mit dem Maildaemon-System interagieren, um Mailbox-Konfigurationen zu verwalten.

API Version: 1.1
Terms of Service: https://one-unity.de/agb/
Contact: One Unity Consulting GmbH

Windows Installation​

Führen Sie die folgenden Schritte aus, um eine Installation unter Windows der maildaemon API durchzuführen:

  1. Stellen Sie sicher, dass Sie das Hosting-Bundle "ASP.NET Core Runtime 8.0.x" installiert haben, genau wie beim "Maildaemon-Service".
  2. Entpacken Sie die Dateien in den gewünschten Ordner (Standard: D:\otris\OUC-Tools\maildaemon-api).
  3. Installieren Sie die ausführbare API als Windows-Dienst. Eine schrittweise Anleitung zur Installation finden Sie in unserer Installationsdokumentation.
  4. Konfigurieren Sie die API-spezifischen Einstellungen. Detaillierte Anweisungen finden Sie in der API-Konfigurationsdokumentation.
  5. Starten Sie den installierten Dienst mit dem Skript __Start_maildaemon.cmd, das sich im Ordner maildaemon-tools befindet. Alternativ können Sie das Fenster "Dienste" öffnen, indem Sie die Tastenkombination Windows + R drücken, services.msc eingeben und die Eingabetaste drücken oder auf die Schaltfläche OK klicken.
  6. Vergewissern Sie sich, dass der maildaemon-service läuft, da die API von ihm abhängt, um richtig zu funktionieren.

Endpunkte​

Mailbox Konfiguration​

  • Path: /mailbox
  • Methods: POST, GET, PUT, DELETE
  • Summary: Allows creating, retrieving, updating, and deleting mailbox configurations
  • Parameters:
    • x-api-version (header): API version
    • uuid (query): Unique identifier for the mailbox
  • Responses:
    • 201: Created (for POST)
    • 200: Success (for GET, PUT, DELETE)
    • 400: Bad Request
    • 404: Not Found

Monitoring​

Get Failed Processed Emails​

  • Path: /monitoring/errors
  • Method: GET
  • Summary: Retrieves all entries for failed processed emails
  • Parameters:
    • x-api-version (header): API version
  • Responses:
    • 200: Success
    • 404: Not Found

Get Successful Processed Emails​

  • Path: /monitoring/success
  • Method: GET
  • Summary: Retrieves all entries for successfully processed emails
  • Parameters:
    • x-api-version (header): API version
  • Responses:
    • 200: Success
    • 404: Not Found

Delete Entity in Monitoring​

  • Path: /monitoring
  • Methods: DELETE
  • Summary: Allows deleting monitoring entities
  • Parameters:
    • x-api-version (header): API version
    • id (query): id for the monitoring entity (primary key)
  • Responses:
    • 200: Success (DELETE)
    • 404: Not Found

Get all entries from MailboxInfo​

  • Path: /monitoring/mailboxinfos
  • Method: GET
  • Summary: Retrieves all entries from MailboxInfo
  • Parameters:
    • x-api-version (header): API version
  • Responses:
    • 200: Success
    • 404: Not Found

Ausführliche Informationen zu den Nutzdaten von Anfragen und Antworten finden Sie in der API-Spezifikation.