Konfiguration von enaio® mail-archive-service

enaio® mail-archive-service 10.10 »

Die Konfiguation von enaio® mail-archive-service erfolgt über die Konfigurationsdatei mailjournaling-prod.yml aus dem Verzeichnis \config\ von enaio® service-manager.

Als Basis der Konfiguration steht eine Konfigurationsdatei zum Download bereit, die Sie anpassen können.

Parameter der Konfigurationsdatei:

Parameter

Typ

Beschreibung

Beispielwert

Standard

mail-journaling.duplicate‑mode

String

Legt das Verhalten des Services bei mehreren Journalberichten fest, die sich auf dieselbe ursprüngliche E-Mail beziehen, z. B. aufgrund der Verwendung von BCC oder einer Fehlkonfiguration.

Verfügbare Werte:

  • IGNORE
    Empfohlener Wert. Der Service prüft nicht, ob eine Nachricht bereits in enaio® gespeichert ist.

  • WARN
    Der Service fügt der Protokolldatei eine Warnung hinzu, wenn eine Nachricht bereits in enaio® gespeichert ist.
    Diese Option kann als Kontrolle im Falle eines komplexen Journalregelsatzes verwendet werden, hat aber negative Auswirkungen auf die Leistung.

    Das Log-Level WARN oder höher ist erforderlich.

WARN

IGNORE

mail-journaling.smtp

Konfigurationsabschnitt für den integrierten SMTP-Server zum Empfang von Journalberichten von Exchange Online.

 

port

Zahl

Port, an dem SMTP auf eingehende Nachrichten wartet. Er kann auf einen beliebigen Wert zwischen 1025 und 65535 eingestellt werden.

Wenn Sie den Standardwert für SMTP (Port 25) verwendenn, dann ist eine zusätzliche Portweiterleitung erforderlich.

25000

25000

 

username

String

Benutzername für die SMTP-Authentifizierung. Falls angegeben, ist 'password' ebenfalls erforderlich.

Wenn beides fehlt, wird die SMTP-Authentifizierung nicht validiert.

smtpUser

-

 

password

String

Passwort für die SMTP-Authentifizierung. Falls angegeben, ist ebenfalls 'username' erforderlich.

Wenn beide fehlen, wird die SMTP-Authentifizierung nicht validiert.

Das Passwort kann verschlüsselt angegeben werden.

smtpUserpassword

-

 

require-tls

Boolean

Gibt an, ob TLS-Verschlüsselung für den Empfang von SMTP-Nachrichten verwendet werden soll (true) oder nicht (false). Falls angegeben, sind 'key-store-file' und 'key-store-pass' erforderlich.

true

false

 

key-store-file

String

Erforderlich, wenn die Verschlüsselung aktiviert ist.

Gibt den Pfad zur SSL-Zertifikatsdatei an.

<absoluter Dateipfad>

-

 

key-store-pass

String

Erforderlich, wenn die Verschlüsselung aktiviert ist.

Gibt das Passwort für den Zugriff auf die Keystore-Datei (P12) an.

Das Passwort kann verschlüsselt angegeben werden.

passSample

-

 

allowed‑senders

String

Liste mit kommaseparierten Einträgen, die erlaubte Absender für eingehende SMTP-Nachrichten angeben.

Wenn der Parameter nicht angegeben wird, sind alle Absender erlaubt.

muster@muster.de, muster@muster.com

-

 

allowed‑recipients

String

Optional: Liste mit kommaseparierten Einträgen, die erlaubte Empfänger für eingehende SMTP-Nachrichten angeben.

Wildcards werden nicht unterstützt.

Wenn der Parameter nicht angegeben wird, sind alle Empfänger erlaubt.

Falls angegeben, dann muss die Liste die Empfänger für Journalberichte enthalten, die in den Journalregeln konfiguriert wurden.

muster@muster.de, muster@muster.com

-

 

message-mode

String

Legt fest, welche Art von Nachrichten über SMTP empfangen werden sollen.

Verfügbare Werte:

  • JOURNAL
    Der Service empfängt Journalberichte.
  • ALTERNATE
    Der Service empfängt Non-Delivery Reports.
  • NORMAL
    Der Service empfängt herkömmliche E-Mails.

JOURNAL

JOURNAL

mail-journaling.app-connector

Konfigurationsabschnitt für die Verbindung zu enaio® appconnector

  uri String Nur notwendig, falls enaio® appconnector nicht auf dem gleichen Host installiert ist.   http://127.0.0.1:8060

mail-journaling.enaio.dms

Konfiguration für die Ablage

 

folder-type.name

String

Interner Name des Ordnertyps in enaio®, der für die Ordnerobjekte verwendet wird.

EXCHANGESTORAGE

EXCHANGESTORAGE_FOLDER

 

folder-type.fields

Liste mit Zuordnungspaaren

Legt Zuordnungen zwischen dem Feldnamen (key) in enaio® mail-archive-service und dem Ordner-Feldnamen (interner Name) in enaio® fest.

Der Wert aus dem enaio® mail-archive-service-Feld wird als Wert für das entsprechende enaio®-Feld verwendet.

Standardmäßig ist nur ein FOLDER_USER-Feld aktiviert und zugewiesen. Dieses Feld ist ein Pflichtfeld.

fields:
  - key: FOLDER_USER
    internal-name: User
 
  register-type.name String

Optional: Interner Name des Registertyps in enaio®, der für die Registerobjekte verwendet wird.

StrukturRegister

StrukturRegister
  register-type.fields String

Legt Zuordnungen zwischen dem Feldnamen (key) in enaio® mail-archive-service und dem Register-Feldnamen (interner Name) in enaio® fest.

Der Wert aus dem enaio® mail-archive-service-Feld wird als Wert für das entsprechende enaio®-Register-Feld verwendet.

Dieses Feld ist ein Pflichtfeld.

fields:
  - key: NAME
    internal-name: name
fields:
  - key: NAME
    internal-name: Feld1
  link-folder-type.name String Optional: Interner Name eines Ordnertyps, in dem Verweisdokumente zu den Journal-Mails angelegt werden.    
  link-folder-type.fields String

Legt Zuordnungen zwischen dem Feldnamen (key) in enaio® mail-archive-service und dem Ordner-Feldnamen (interner Name) in enaio® fest.

Der Wert aus dem enaio® mail-archive-service-Feld wird als Wert für das entsprechende enaio®-Feld des Ordners für Verweisdokumente verwendet.

Standardmäßig ist nur ein FOLDER_USER-Feld aktiviert und zugewiesen. Dieses Feld ist ein Pflichtfeld.

fields:
  - key: FOLDER_USER
    internal-name: User
 
  link-register-type.name String

Optional: Interner Name des Registertyps in enaio®, der für die Registerobjekte im Ordner für Verweisdokumente verwendet wird.

   
  link-register-type.fields  

Legt Zuordnungen zwischen dem Feldnamen (key) in enaio® mail-archive-service und dem Register-Feldnamen (interner Name) in enaio® fest.

Der Wert aus dem enaio® mail-archive-service-Feld wird als Wert für das entsprechende enaio®-Register-Feld im Ordner für Verweisdokumente verwendet.

Dieses Feld ist ein Pflichtfeld.

fields:
  - key: NAME
    internal-name: name
 
  link-mail-type.name String

Interner Name des E-Mail-Dokumenttyps in enaio®, der für Verweisdokumente der E-Mail-Objekte verwendet wird, die von enaio® mail-archive-service erstellt werden.

   
  link-mail-type.fields  

Legt Zuordnungen zwischen dem Feldnamen (key) in enaio® mail-archive-service und dem E-Mail-Dokumenttyp-Feldnamen (interner Name) in enaio® fest.

Für jede einzelne empfangene Nachricht wird der Wert aus dem enaio® mail-archive-service-Feld als Wert für das entsprechende enaio®-Feld verwendet.

Pflichtfelder sind MAIL_FROM, MAIL_TO, MAIL_SUBJECT und MAIL_MESSAGE_ID.

fields:     
  - key: REPORT_INFO
    internal-name: RPRT_INFO
  - key: REPORT_RECIPIENTS
    internal-name: RPRT_RECIPIENTS
  - key: MAIL_FROM
    internal-name: MAIL_FROM
  - key: MAIL_TO
    internal-name: MAIL_TO
  - key: MAIL_CC
    internal-name: MAIL_CC
  - key: MAIL_SUBJECT
    internal-name: SUBJECT
  - key: MAIL_BODY
    internal-name: BODY
  - key: MAIL_MESSAGE_ID
    internal-name: MESSAGE_ID
  - key: MAIL_HAS_ATTACHMENT
    internal-name: MAIL_HAS_ATTACHMENT
  - key: MAIL_SUBMIT_TIME
    internal-name: SUBMIT_TIME
  - key: MAIL_TOS
    internal-name: MAIL_TOS
  - key: MAIL_SIZE
    internal-name: MAIL_SIZE
  - key: MAIL_PRIORITY
    internal-name: MAIL_PRIORIT
  - key: SMTP_HEADER
    internal-name: SMTP_HEADER
  - key: MAIL_RECEIVE_TIME
    internal-name: MAIL_RECEIVE_TIME
 
 

email-type.name

String

Interner Name des Dokumenttyps in enaio®, der für E-Mail-Objekte verwendet wird, die von enaio® mail-archive-service erstellt werden.

EMAIL_DOC

EMAIL_DOCUMENT

 

email-type.fields

Schlüssel-Wert-Zuordnung

Legt Zuordnungen zwischen dem Feldnamen (key) in enaio® mail-archive-service und dem Dokument-Feldnamen (interner Name) in enaio® fest.

Für jede einzelne empfangene Nachricht wird der Wert aus dem enaio® mail-archive-service-Feld als Wert für das entsprechende enaio®-Feld verwendet.

Pflichtfelder sind MAIL_FROM, MAIL_TO, MAIL_SUBJECT und MAIL_MESSAGE_ID.

fields:     
  - key: REPORT_INFO
    internal-name: RPRT_INFO
  - key: REPORT_RECIPIENTS
    internal-name: RPRT_RECIPIENTS
  - key: MAIL_FROM
    internal-name: MAIL_FROM
  - key: MAIL_TO
    internal-name: MAIL_TO
  - key: MAIL_CC
    internal-name: MAIL_CC
  - key: MAIL_SUBJECT
    internal-name: SUBJECT
  - key: MAIL_BODY
    internal-name: BODY
  - key: MAIL_MESSAGE_ID
    internal-name: MESSAGE_ID
  - key: MAIL_HAS_ATTACHMENT
    internal-name: MAIL_HAS_ATTACHMENT
  - key: MAIL_SUBMIT_TIME
    internal-name: SUBMIT_TIME
  - key: MAIL_TOS
    internal-name: MAIL_TOS
  - key: MAIL_SIZE
    internal-name: MAIL_SIZE
  - key: MAIL_PRIORITY
    internal-name: MAIL_PRIORIT
  - key: SMTP_HEADER
    internal-name: SMTP_HEADER
  - key: MAIL_RECEIVE_TIME
    internal-name: MAIL_RECEIVE_TIME
 
mail‑journaling.enaio.dms.structure Konfigurationsabschnitt für die Ordner-Register-Struktur
  journal-folder String Wert für das Feld des Ordnertyps für die Journal-Mails Store Journal
  use-register String

Im Ordner für die Journal-Mails werden im angegebenen Rhythmus neue Register für die Journal-Mails angelegt, die im Register-Feld mit dem Datum indexiert werden.

Werte:

  • PER_DAY

  • PER_WEEK

  • PER_MONTH

  • NONE

    Register werden nicht erstellt.

PER_DAY NONE
  user-folders  

Für angegebene E-Mail-Adressen können Ordner angelegt werden, die mit der zugeordneten Bezeichnung indexiert werden.

Dort werden E-Mails als Verweisdokumente angelegt. Die E-Mail-Adressen müssen im Feld 'FROM', 'TO' oder 'CC' enthalten sein.

Mehrere Zuordnungen werden zeilenweise angegeben.

"[invoice@domain.com]" : Invoices

"[orders@domain.com]" : Orders

-

mail-journaling.exchange

Konfigurationsabschnitt für den Abruf von E-Mails aus einem Postfach.

 

client-id

String

Anwendungs-(Client-)ID des Azure-Portals.

Die Anwendungs-ID kann verschlüsselt angegeben werden.

 

-

 

tenant-id

String

Verzeichnis-(Mandant-)ID des Azure-Portals.

Die Verzeichnis-ID kann verschlüsselt angegeben werden.

 

-

 

secret

String

Secret der Anwendung des Azure-Portals.

Das Secret kann verschlüsselt angegeben werden.

 

-

     mailboxes

user

String

Erforderlich für die Verwendung eines Postfachs.

Mehrere Postfächer können angegeben und mit den Parametern konfiguriert werden.

bckp_mail@domain.de

-

     mailboxes

read-folder

String

Erforderlich für die Verwendung eines Postfachs. Gibt den Postfachordner an, aus dem die Nachrichten abgerufen werden sollen.

Posteingang

-

     mailboxes

error-folder

String

Gibt einen Postfachordner an, in den Nachrichten verschoben werden, die nicht verarbeitet werden konnten.

JournalErrors

JournalErrors

     mailboxes

message-mode

String

Legt fest, welche Art von Nachrichten aus dem Postfach gelesen werden. Verfügbare Werte:

  • JOURNAL
    Wird verwendet, wenn das Postfach Journalberichte speichert.
  • ALTERNATE
    Wird verwendet, wenn das Postfach Non-Delivery Reports speichert.
  • NORMAL
    Wird verwendet, wenn das Postfach herkömmliche E-Mails speichert.

ALTERNATE

ALTERNATE

 

access-scope-uri

String

Graph API-Verbindung. Der Wert wird von Microsoft festgelegt und darf nicht geändert werden.

   
 

page-size

Zahl

Maximale Größe der Ergebnisse pro Graph API-Anfrage. Der Wert sollte nicht größer als 999 sein.

999

999

  use-exchange-service Boolean

aktiviert/deaktiviert eine Funktion, die für E-Mail-Adressen aus angegebenen Domains Verweisdokumente erzeugt und den Wert für die Ordnerindexierung ermittelt.

Basis dieser Funktion sind Daten des O365-Active Directories.

true false
  domains String

Gibt die Domains für die Funktion 'use-exchange-service' an.

Mehrere Domains werden kommasepariert angegeben.

company.de, company.com -
  folder-field String

Gibt an, welche Daten aus der Benutzerverwaltung eines O365-Active Directories als Wert für die Ordnerindexierung verwendet wird.

Werte:

  • USERNAME

  • FIRST_NAME

  • LAST_NAME

  • DISPLAY_NAME

  • SAM_ACCOUNT_NAME

DISPLAY_NAME USERNAME

Verschlüsselung von Informationen

Einige Informationen der Konfigurationsdatei mailjournaling-prod.yml aus dem Verzeichnis \config\ von enaio® service-manager können verschlüsselt werden:

  • Öffnen Sie die Eingabeaufforderung als Administrator und wechseln Sie in das Verzeichnis \service-manager\tools\.

  • Führen Sie folgenden Befehl aus: encode.bat information

    Der verschlüsselte Wert wird mit führendem 'ENC' und in runden Klammern angezeigt: ENC(encryptedinformation)

  • Kopieren Sie die verschlüsselte Information mit führendem 'ENC' und mit den runden Klammern und tragen Sie diese in die Konfigurationsdatei ein.

  • Speichern Sie die Konfigurationsdatei und starten Sie den Service gegebenenfalls neu.

Wenn der zu verschlüsselnde Wert Anführungszeichen enthält oder mit einem Backslash endet, dann müssen diese Zeichen durch einen Backslash maskiert werden.
Beispiel: encode.bat "passwordwith\"quotation\"marks"