.SearchFilter

optionale Filterzeichenfolge zur Auswahl der gewünschten E-Mails

Die Filter werden direkt auf dem Mailserver angewendet.

Diese Eigenschaft ist nur relevant für die Schnittstellen/Protokolle Graph, EWS, IMAP und Gmail. Für den Filter ist jeweils die spezifische Syntax der Schnittstelle oder des Protokolls zu verwenden:

Bei den Schnittstellen Graph und EWS nutzt das Programm die E-Mail-Eigenschaft "Kategorie", um den aktuellen Verarbeitungsstatus zu setzen und neue E-Mails, die noch keinen Statuswert haben, auszuwählen. Dieser feste interne Filter wird implizit mit dem Wert kombiniert, der über .SearchFilter konfiguriert ist. Dadurch wird das Abfrageergebnis bei Bedarf weiter eingeschränkt.

.SubjectFilter

.BodyFilter

.HasAttachFilter

optionale Filter, um weiterzuverarbeitende E-Mails anhand des Betreffs, des Nachrichtentextes oder anhand der Existenz einer Dateianlage mit einem bestimmten Namen auszuwählen

Diese Filter werden nachträglich auf die Liste vorhandener E-Mails angewendet, die vom Mailserver zurückgeliefert wird.

Abhängig vom konkreten Filterkriterium und von der Mail-Schnittstelle muss das vollständige Mail-Objekt vom Server abgerufen werden, um die relevanten Filterwerte zu ermitteln. Die Nutzung dieser clientseitigen Filter ist in der Regel inperformanter und erzeugt mehr Datenverkehr als die serverseitigen Filter.

Syntax: siehe Syntax von Namensfiltern

.FileFilter

.IgnoreInlineAttach

optionaler Dateinamensfilter zur Beschränkung der Dateianlagen, die aus den gefundenen E-Mails extrahiert werden

Über den Wahrheitswert .IgnoreInlineAttach kann zudem definiert werden, ob Inline-Anlagen generell ignoriert werden (Standardwert: false). Inline-Anlagen sind z. B. Grafiken, die in einen HTML-Nachrichtentext eingebettet sind, z. B. Logos in E-Mail-Signaturen.

.AttachMailBody

.AttachMailItem

Wahrheitswerte, ob der Nachrichtentext und das Mail-Objekt als Ganzes als zusätzliche Dateianlagen an das xSuite-Interface-Dokument angefügt werden (Standardwert: false)

Die erste Anlage erhält den Basisnamen body mit der formatabhängigen Endung .txt oder .html. Die zweite Anlage erhält den Namen mail.eml.

.PoBox[].Id

.PoBox[].User(*)

.PoBox[].Password(*§)

.PoBox[].UserMailForAutoUrl

.PoBox[].InputFolder(*)

.PoBox[].BackupFolder(%)

.PoBox[].ErrorFolder(%)

Definition der Eigenschaften für den Zugriff auf einen einzelnen Mail-Ordner eines spezifischen Benutzers

Die Eigenschaft .Id stellt eine programminterne, eindeutige und frei wählbare Kennung zur Identifikation des Ordners dar, aus dem eine E-Mail gelesen wurde. Bei Weglassung wird eine Standardkennung mit fortlaufender Nummer vergeben.

Die Eigenschaften .User und .Password werden für die Authentifizierung gegenüber dem Mailserver benötigt. Das benutzerspezifische Passwort ist abhängig von der genutzten Schnittstelle und dem Authentifizierungsverfahren nicht in jedem Fall relevant.

Unter .UserMailForAutoUrl kann bei der EWS-Schnittstelle optional die E-Mail-Adresse des Benutzers zur automatischen Ermittlung des .Url-Wertes mit der Serveradresse angegeben werden.

.InputFolder, .BackupFolder und .ErrorFolder sind die Namen der E-Mail-Ordner, aus denen neue E-Mails ausgelesen werden und der Ordner, in die diese E-Mails nach der Verarbeitung oder nach einem Verarbeitungsfehler verschoben werden. Diese Ordner sind nicht relevant für das POP3-Protokoll, das dieses keine Ordnerstrukturen unterstützt.

Bei den Exchange-Schnittstellen bleiben die E-Mails während der laufenden Weiterverarbeitung durch xSuite Interface im Eingangsordner. Die Eigenschaft Kategorie dieser E-Mails hat den Statuswert "Working". Nach Abschluss der Verarbeitung werden die E-Mails in den Backup-Ordner verschoben. Wenn schon beim Einlesen der E-Mails ein Fehler auftritt, bleiben die Mails mit dem Status "Error" im Eingangsordner. Wenn erst im weiteren Verlauf ein Verarbeitungsfehler auftritt, werden die E-Mails in den Ordner "Error" verschoben.

Beim IMAP-Protokoll können keine Statuswerte an die E-Mail-Objekte geschrieben werden. Abweichend vom Standardverhalten des Programms werden die E-Mails daher direkt nach dem Einlesen in den Backup-Ordner verschoben, um nicht wiederholt aus dem Eingangsordner gelesen zu werden. Wenn kein Backup-Ordner definiert ist, werden die E-Mail nach dem erfolgreichen Einlesen direkt gelöscht. Bei POP3 werden die E-Mails grundsätzlich direkt gelöscht, da POP3 keine Ordnerstrukturen bietet. Die Definition eines Error-Ordners ist in dieser Konstellation nicht sinnvoll, da eine bereits gelöschte E-Mail nicht weiter verschoben werden kann. Bei Gmail ist die Verarbeitungslogik analog zum IMAP-Protokoll, allerdings werden die E-Mails nicht in Ordnern abgelegt, sondern mit den konfigurierten Ordnernamen als Labels versehen.

Bei den beiden Exchange-Schnittstellen ist der Anzeigename eines Ordners anzugeben, z. B. Posteingang auf Deutsch. Durch umgekehrte Schrägstriche (\) können eine oder mehrere Unterordner angefügt werden. Bei IMAP und Gmail lautet der Eingangsordner immer Inbox und als Trennzeichen wird ein / genutzt.

Neben dem standardmäßigen Auslesen der persönlichen Nachrichten eines Benutzers erlauben die Exchange-Schnittstellen auch den Zugriff auf freigegebene Ordner anderer Benutzer. Dafür ist dem Ordnernamen \Shared\Mail-Adresse\ voranzustellen. Als E-Mail-Adresse ist die des freigebenden Benutzers anzugeben. Die EWS-Schnittstelle erlaubt zudem die Abfrage öffentlicher Ordner, was durch das Präfix \Public\ kenntlich zu machen ist.

Bei Nutzung der Graph-API in Verbindung mit einer "Nur-App-Authentifizierung" (siehe Eigenschaft .OAuthClientSecret) erfolgt der Zugriff auf freigegebene Ordner direkt im Kontext des freigebenden Benutzers. Die Eigenschaft .User ist in diesem Fall nicht relevant.