GAMBAS-BUCH 3.19.5

Die Komponente POP3Client (gb.net.pop3) stellt Ihnen über ihre Eigenschaften und Methoden alles zur Verfügung, um im Online-Modus

• unter Berücksichtigung der geforderten Verbindungssicherheit und Authentifikationsmethode eine Verbindung zu einem POP3-Server aufzubauen und zu halten,
• sich Status-Meldungen zur Verbindung anzufordern,
• die Anzahl der im Postfach vorhandenen EMails abzurufen,
• eine Übersicht der im Postfach vorhandenen EMails abzurufen,
• EMails aus dem Postfach auf dem POP3-Server herunterzuladen,
• EMails im Postfach auf dem POP3-Server zu löschen oder
• eine bestehende TCP/IP-Verbindung zu einem POP3-Server zu trennen.

Beachten Sie:

Die Komponente stellt Ihnen keinen Parser für den Inhalt einer herunter geladenen EMail zur Verfügung, um den Inhalt einer EMail – eingeschlossen deren Anhänge – anzuzeigen!

Die Klasse POP3Client verfügt über diese Eigenschaften:

Tabelle 24.5.0.1.1 : Eigenschaften der Klasse Pop3Client

Ausschnitt der Ausgaben in der Konsole der Gambas-IDE für den Wert Pop3Client.Debug = True:

gb.net.pop3: Connecting to 195.004.092.211
gb.net.pop3: Authenticating...
gb.net.pop3: Sending: USER meinUsername ' Bei FREENET gilt: Username = komplette EMail-Adresse
gb.net.pop3: +OK user ok
gb.net.pop3: Sending: PASS *****************
gb.net.pop3: +OK 4 messages (23445 octets).
gb.net.pop3: OK

Die Klasse POP3Client besitzt diese Methoden:

Methode	Rückgabetyp	Beschreibung
Open( )	Boolean	Verbindet den PO3-Client mit dem POP3-Server und authentifiziert den Client. Die Funktion gibt True zurück, wenn die Verbindung erfolgreich hergestellt werden konnte und die Authentifizierung erfolgreich war.
Close( )	Boolean	Abmeldung vom POP3-Server und trennen der Verbindung zwischen Client und Server.
Abort( )	-	Abbruch der Verbindung und Trennung vom POP3-Server. Das Postfach wird unberührt gelassen. Bereits zum Löschen markierte EMails werden wiederhergestellt (Rollback).
List( )	String[ ]	Die Funktion gibt ein String-Array zurück, das mit List()[0]) die aktuelle Nummer und mit List()[1] die Größe jeder EMail im Postfach enthält.
ListUniqueID( )	String[ ]	Die Funktion gibt ein String-Array zurück, das die eindeutige Kennung (UID) jeder Nachricht auf dem Server enthält. Eine eindeutige UID identifiziert eine Nachricht eindeutig und bleibt über mehrere Sitzungen erhalten. Die UID ist eine server-definierte Zeichenfolge und der RFC (https://tools.ietf.org/html/rfc1939#page-12) gibt kein Format für sie an. Verlassen Sie sich nicht auf ein Muster für die UID, dem Sie auf einem bestimmten Server begegnen.
Ping( )	Boolean	Die Funktion sendet den Befehl NOOP (no operation) an den POP3-Server, um den Status der Verbindung zu prüfen und aufrecht zu halten. Sie sollten einen Zeitgeber verwenden, um eine plötzliche Unterbrechung zu vermeiden.
Remove ( Index As Integer )	-	Löscht die über das Argument 'Index' ausgewählte EMail im Postfach, wobei die EMail jedoch nur als zu löschende EMail markiert wird. Das Argument 'Index' ist der (fortlaufend nummerierte) Index einer EMail. Nach der Abmeldung vom POP3-Server und dem Trennen der Verbindung zwischen POP3-Client und POP3-Server werden die zum Löschen markierten EMails im Postfach endgültig gelöscht.
Reset( )	-	Setzt das Postfach in den originalen Zustand wie zu Beginn der Sitzung zurück. Bereits zum Löschen markierte EMails werden wiederhergestellt (Rollback).
Stat( )	Integer[ ]	Gibt ein Integer-Array zurück, das die Anzahl der Nachrichten im Postfach (Stat()[0]) und deren Gesamtgröße (Stat()[1]) (Einheit Byte) enthält.

Tabelle 24.5.0.2.1 : Methoden der Klasse POP3Client

Die Klasse können Sie erzeugen. Hier ein Beispiel:

Public hPop3Client As Pop3Client 
hPop3Client = New Pop3Client() 

Um die einzelnen EMails online zu verwalten, benötigen Sie eine sogenannte Nachrichten-Instanz:

Public hPop3Client As New Pop3Client 
Dim hPop3ClientMessage As _Pop3Client_Message 
hPop3ClientMessage = hPop3Client [ Index As Integer ] 

Mit den folgenden Anweisungen durchlaufen Sie online das Postfach. Es wird jeweils ein Message-Objekt für die einzelnen Nachrichten vom Typ MimeMessage zurückgegeben.

Public hPop3Client As New Pop3Client 
Dim hPop3ClientMessage As _Pop3Client_Message 

For Each hPop3ClientMessage In hPop3Client 
  ... 
Next

Wenn Sie sich zum POP3-Protokoll informieren wollen, dann sollten Sie mindestens diesen Links folgen:

• https://de.wikipedia.org/wiki/Post_Office_Protocol
• https://de.wikipedia.org/wiki/Authenticated_Post_Office_Protocol
• https://tools.ietf.org/html/rfc1939
• https://tools.ietf.org/html/rfc1939#page-15 → APOP (Authenticated Post Office Protocol)

Die Erfahrungen des Autors betätigen: Nur wenn Sie die Grundlagen hinreichend genau kennen, wie das POP3-Protokoll funktioniert, werden Sie die implementierten Eigenschaften und Methoden der Klasse POP3Client erfolgreich einsetzen können. Bevor Sie in Ihren POP3-Projekten mit der Klasse POP3Client → Kapitel 24.5.3 arbeiten, sollten Sie deshalb die folgenden zwei Kapitel zur praktischen Umsetzung des POP3-Protokolls lesen und die Beispiele auf der Konsole mit den Daten eines eigenen EMail-Kontos nachvollziehen.