Skip to main content
Skip table of contents

IMAP

Der Adapter empfängt, kopiert/verschiebt oder löscht eine E-Mail-Nachricht in einem IMAP-Postfach (Internet Message Access Protocol), setzt ein Flag oder listet Nachrichten-Header in einem Ordner eines IMAP-Postfachs.

Der Adapter unterstützt mit S/MIME verschlüsselte/signierte Nachrichten sowie die SSL-Verschlüsselung der Verbindung zum IMAP-Server (IMAPS). Aus einer Properties-Datei können beliebige Java Mail Properties verarbeitet werden.

Hinweis:

Die Standard-Blockgröße (16 KB) bei der Nachrichtenübertragung kann über die JavaMail-System-Eigenschaft mail.imap.fetchsize in der Laufzeitumgebung des X4 Servers (i.d.R. Java-VM mit Applikations-Server) gesetzt werden, um das Herunterladen der E-Mails via IMAP optimiert.

Beispiel für das Startskript von JBoss, die Blockgröße wird auf 5 MB gesetzt:

CODE
@set JAVA_OPTS=%JAVA_OPTS% -Dmail.imap.fetchsize=5242880

Eigenschaften (Properties)

Operation

Bestimmt, welche Operation der Funktions-Adapter durchführt

Mögliche Werte:

  • Receive Message: Nachricht mit der in Parameter messageID angegeben ID als UTF-8-kodiertes XML-Dokument empfangen

  • Receive EML Message : Nachricht mit der in Parameter messageID angegeben ID empfangen und als .eml-Datei (MS Outlook) speichern.

Hinweis:

Eine Weiterleitung der empfangenen Nachricht ist mit direkter Anbindung des IMAP-Adapters an den POP/SMTP-Adapter möglich.

  • List Messages: Nachrichten-Header eines IMAP-Ordners, der in Parameter folder angegeben wird, in einem UTF-8-kodierten XML-Dokument auflisten

  • Copy Message: Nachricht, deren Nachrichten-ID in Parameter messageID angegeben wird, in den IMAP-Ordner kopieren, der in Parameter folder angegeben wird

  • Move Message: Nachricht, deren Nachrichten-ID in Parameter messageID angegeben wird, in den IMAP-Ordner verschieben, der in Parameter folder angegeben wird

  • Delete Message: Nachricht, deren Nachrichten-ID in Parameter messageID angegeben wird, vom IMAP-Server löschen

  • Set Flag : Nachricht, deren Nachrichten-ID in Parameter messageID angegeben wird, mit einem oder mehreren Flags kennzeichnen, die in Parameter flags angegeben werden

Parameter

Adapter

Hauptklasse des Adapters (nicht verändern!)

Mögliche Werte: de.softproject.integration.adapter.imap.Adapter: Hauptklasse (Standard)

imapServer

IP-Adresse oder Host-Name des IMAP-Servers

Mögliche Werte: Beliebige gültige Zeichenkette (z. B. imap.1und1.de)

login

Benutzername für das verwendete E-Mail-Konto

Mögliche Werte: Beliebige Zeichenkette

password

Passwort für das verwendete E-Mail-Konto

Mögliche Werte: Beliebige Zeichenkette

oAuth2

Legt fest, ob das OAuth 2.0-Protokoll zum Log-In verwendet werden soll.

Mögliche Werte:

  • ja: oAuth2 wird zum Log-in verwendet

  • nein: oAuth2 wird nicht zum Log-in verwendet

Wenn OAuth 2.0 verwendet werden soll,

  • muss die SSL-Verschlüsselung für die Verbindung zum IMAP-Server durch setzen des Parameters ssl aktiviert sein.

  • muss beim Parameter password der Access Token eingetragen werden. 

folder

Zielordner auf dem IMAP-Server (wenn die Eigenschaft Operation auf Copy Message oder Move Message gesetzt ist) oder Ordner, dessen Nachrichten aufgelistet werden soll (wenn die Eigenschaft Operation auf List Messages gesetzt ist)

Mögliche Werte: Vorhandener Ordnername (Groß-/Kleinschreibung beachten)

Häufig verwendet: 

  • INBOX

  • Drafts

  • Sent Messages

  • Junk

  • Deleted Messages

  • Archive

  • Notes

srcFolder

Quellordner für die Aktionen Copy MessageMove Message, Receive Message, Set Flag und Delete Message.

Mögliche Werte: Vorhandener Ordnername (Groß-/Kleinschreibung beachten)

Häufig verwendet: 

  • INBOX

  • Drafts

  • Sent Messages

  • Junk

  • Deleted Messages

  • Archive

  • Notes

flags

IMAP-Flag(s) zur Kennzeichnung einer E-Mail-Nachricht; Mehrere Flags werden durch Semikolon (;) getrennt (wenn die Eigenschaft Operation auf Set Flag gesetzt ist)

Mögliche Werte: Beliebiges Flag (z. B. \Answered)

messageID

(MessageID)

Nachrichten-ID der E-Mail inklusive Ordnerangabe

Mögliche Werte: Ordnername und Nachrichten-ID (mit spitzen Klammern) (z. B. INBOX/<831921101.31255094008434.Java Mail.javamailuser@localhost>)

uid

Nachrichten-ID auf dem IMAP-Server

Mögliche Werte: Beliebige ganze Zahl

maxMessages

Anzahl der aufzulistenden Nachrichten begrenzen, wenn die Eigenschaft Operation auf List Messages gesetzt ist. Die Auflistung beginnt mit den ältesten Nachrichten im Ordner.

Mögliche Werte: Beliebige ganze Zahl

base64

Anhänge von Nachrichten (Multipart-Teile) immer Base64-kodieren (wenn die Eigenschaft Operation auf Receive Message gesetzt ist)

Mögliche Werte:

  • ja: Alle Multipart-Teile Base64-kodieren

  • nein: Nicht Base64-kodieren (Standard)

encrypt

Nachrichten sind mit S/MIME verschlüsselt (Multipart/Encrypted)

Mögliche Werte:

  • ja: S/MIME-Verschlüsselung aktivieren (erfordert die Angabe zur Schlüssel-/Zertifikatsdatei in Parameter Pkcs12 und der Passphrase in Parameter passphrase)

  • nein: Keine Verschlüsselung (Standard)

sign

Nachrichten sind mit S/MIME signiert (Multipart/Signed)

Mögliche Werte:

  • ja: S/MIME-Signatur verarbeiten (erfordert die Angabe zur Schlüssel-/Zertifikatsdatei in Parameter Pkcs12 und der Passphrase in Parameter passphrase)

  • nein: Keine Signatur (Standard)

Pkcs12

Pfad zur einer gültigen Schlüssel-/Zertifikatsdatei im PKCS#12-Format

Mögliche Werte: Beliebige gültige Pfadangabe im lokalen Dateisystem des X4 Servers (z. B. %USER_COLLECTION\Project\Folder\Key.p12)

passphrase

Passwort/Passphrase zur Schlüssel-/Zertifikatsdatei im PKCS#12-Format, die Sie in Parameter Pkcs12 angegeben haben

Mögliche Werte: Beliebige gültige Zeichenkette

port

Port des IMAP-Servers

Mögliche Werte:

  • Beliebige ganze Zahl (z. B. 993)

  • (kein Wert): Standard-Port 143 verwenden

ssl

SSL-Verschlüsselung für die Verbindung zum IMAP-Server aktivieren

Mögliche Werte:

  • Ja: IMAP über SSL (IMAPS) verwenden

  • Nein: Verbindung nicht verschlüsseln (Standard)

propertiesURL

URL zu einer Properties-Datei (XML oder Text), die beliebige Java Mail Properties enthalten kann

Mögliche Werte:

  • Beliebige gültige URL zu einer Properties-Datei (z. B. xstore://Project/Folder/ mail.properties)

  • (leer): Keine Java Mail Properties verarbeiten

propertiesType

Format der Properties-Datei, die in Parameter propertiesURL angegeben wurde

Mögliche Werte:

  • TEXT: Als Text-Properties interpretieren (Standard)

  • XML: Als XML-Properties interpretieren

Statuswerte

1

Die Operation wurde erfolgreich ausgeführt.

0

Die Operation wurde durchgeführt, es wurde aber kein Ergebnis gefunden oder keine Daten geändert.

-1

Die Operation konnte nicht ausgeführt werden.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.