IMAP New transporter

Home

4D v20 R7

Mail


IMAP New transporter ( server ) -> Funktionsergebnis

Parameter	Typ	Beschreibung
server	Objekt	Mail server information
Funktionsergebnis	Objekt	IMAP transporter object

Beschreibung

Der Befehl IMAP New transporter erstellt eine neue IMAP Verbindung nach den Angaben im Parameter server und gibt ein neues Objekt transporter zurück. Dieses zurückgegebene Objekt dient dann zum Empfangen von E-Mails.

Im Parameter server übergeben Sie ein Objekt mit folgenden Eigenschaften:

Eigenschaft

Typ

Beschreibung

host

Text

Name oder IP Adresse des Host Server für IMAP Transaktionen

port

Zahl

Port für IMAP Transaktionen. Standardwert = 993

connectionTimeOut

Zahl

Maximale Wartezeit (in Sekunden) zum Herstellen einer Verbindung zum Server. Standardwert=30

authenticationMode

Text

Authentifizierungsmodus zum Öffnen der Sitzung auf dem IMAP Server(*). Mögliche Werte:

Konstante	Wert	Kommentar
IMAP authentication CRAM MD5	CRAM-MD5	IMAP Authentifizierung mit CRAM-MD5 Protokoll
IMAP authentication login	LOGIN	IMAP Authentifizierung mit LOGIN Protokoll
IMAP authentication OAUTH2	OAUTH2	IMAP Authentifizierung mit OAuth 2 Protokoll
IMAP authentication plain	PLAIN	IMAP Authentifizierung mit PLAIN Protokoll

accessTokenOAuth2

Text

Textstring mit Eckdaten der OAuth 2 Authorisierung. Wird nur mit OAUTH2 authenticationMode verwendet. Wird accessTokenOAuth2 ohne authenticationMode eingesetzt, wird das OAuth 2 Protokoll verwendet (wenn vom Server zugelassen).

Hinweis: Ein Zugriffs-Token hat begrenzte Lebensdauer und läuft in der Regel nach einer Stunde ab. Nach Ablauf ist keine automatische erneute Verbindung möglich (z.B. bei Abmelden vom Server).

user

Text

Benutzername zur Authentifizierung auf dem Server

password

Text

Benutzerkennwort zur Authentifizierung auf dem Server

acceptUnsecureConnection

Boolean

Wahr, um für 4D eine unverschlüsselte Verbindung zu erlauben, wenn keine verschlüsselte Verbindung möglich ist (**). Bei Falsch wird ein Fehler zurückgegeben, wenn keine verschlüsselte Verbindung möglich ist. Standardwert=False

logFile

Text

Dateipfad für ein erweitertes Logbuch (***). Kann relativ (zum aktuellen Ordner Logs) oder absolut sein.

checkConnectionDelay

Zahl

Maximal zugelassene Zeit (in Sekunden) bis zur Überprüfung der Verbindung zum Server. Läuft die Zeit zwischen zwei Methodenaufrufen ab, wird die Verbindung zum Server geprüft. Standardwert: 300

(*) Ist authenticationMode Null oder undefiniert, wird der sicherste Authentifizierungsmodus verwendet, den der Server unterstützt.

(**) Es gibt folgende gesicherte IMAP Ports:

143: IMAP unverschlüsselter Port
993: IMAP mit STARTTLS Upgrade, falls vom Server unterstützt

(***) Erweiterte Logbücher speichern im Gegensatz zu gängigen Logbüchern (aktiviert über den Befehl SET DATABASE PARAMETER) MIME Inhalt aller gesendeten Mails und haben keine Beschränkung in der Größe. Weitere Informationen dazu finden Sie im Abschnitt 4DIMAPLog.txt.

Warnung: Achten Sie darauf, dass das definierte Timeout unter dem Server Timeout liegt, andernfalls ist das Client Timeout ohne Bedeutung.

Zurückgegebenes Objekt

Das zurückgegebene Objekt transporter enthält folgende Eigenschaften und Methoden im Nur-Lesen Modus:

Eigenschaft	Typ	Beschreibung
transporter.host	Text	Name oder IP Adresse des Host Server für Mail Transaktionen
transporter.port	Zahl	Port für Mail Transaktionen
transporter.connectionTimeOut	Zahl	Maximale Wartezeit (in Sekunden) zum Herstellen einer Verbindung zum Server
transporter.acceptUnsecureConnection	Boolean	Wahr, wenn 4D eine unverschlüsselte Verbindung herstellen kann, wenn keine verschlüsselte Verbindung möglich ist, sonst Falsch.
transporter.authenticationMode	Text	Derzeit verwendeter Authentifizierungsmodus zum Öffnen der Sitzung auf dem Mail Server
transporter.user	Text	Benutzername zur Authentifizierung auf dem Server
transporter.logFile	Text	Kompletter Pfad des Logbuchs (wenn vorhanden)
transporter.checkConnectionDelay	Zahl	Maximale Zeit (in Sekunden) bis zum Prüfen der Verbindung zum Server

Methode	Beschreibung
IMAP_transporter.addFlags()	Aktualisiert Flags an Mails
IMAP_transporter.append()	Hängt Mail an eine Mailbox an
IMAP_transporter.checkConnection()	Prüft Authentifizierung
IMAP_transporter.copy()	Kopiert Mails von einer Mailbox in eine andere
IMAP_transporter.delete()	Markiert Mails mit dem Flag "delete"
IMAP_transporter.expunge()	Entfernt Mails, die mit dem Flag "deleted" markiert sind
IMAP_transporter.selectBox()	Wählt die Mailbox
IMAP_transporter.getBoxList()	Gibt die Liste der Mailboxen zurück
IMAP_transporter.getDelimiter()	Gibt Hierarchie Begrenzer zurück
IMAP_transporter.getBoxInfo( )	Gibt Mailbox Information zurück
IMAP_transporter.getMail( )	Gibt eine spezifische E-Mail zurück
IMAP_transporter.getMails( )	Gibt eine Collection von E-Mails zurück
IMAP_transporter.getMIMEAsBlob( )	Gibt den MIME Inhalt einer spezifischen E-Mail in einem BLOB zurück
IMAP_transporter.move()	Verschiebt Mails von einer Mailbox in eine andere
IMAP_transporter.numToID()	Konvertiert fortlaufende Nummern der Mails in einmalige IDs
IMAP_transporter.removeFlags()	Entfernt Flags von Mails
IMAP_transporter.searchMails()	Sucht nach Mails, für die spezifische Suchkriterien passen

Hinweis: Die IMAP Verbindung wird automatisch geschlossen, wenn das Objekt transporter gelöscht wird.