awpop3.pbi

Included Files:
awnetwork.pbi, awopenssl.pbi, awsupport.pbi
Included in:

Overview


Description

awpop3.pbi
Version 0.3

POP3-Client für PureBasic 4.50+
Lizenz: LGPL V3

Systemanforderungen:
Windows[x] Linux[x] Mac[ ]
x86[x] x64[x] PPC[ ]
ASCII[x] Unicode[x]

Wichtig: Vor der Benutzung muss einmalig InitNetwork() aufgerufen werden!

Top, Back


Constants
#AWPB_POP3_Connect_APOP
APOP benutzen
#AWPB_POP3_Connect_AUTO
Verbindungsmethode automatisch bestimmen
#AWPB_POP3_Connect_USER
USER/PASS benutzen

Top, Back


Functions and Macros
AWPB_POP3_AllocatePOP3.i()
Fordert Speicher für ein POP3-Objekt an.
AWPB_POP3_Connect.b(*POP3Object, mode.i = #AWPB_POP3_Connect_AUTO)
Stellt eine Verbindung zum Server her.
AWPB_POP3_DELE.b(*POP3Object, Index.i)
Übermittelt dem Server den Befehl DELE.
AWPB_POP3_DisConnect.b(*POP3Object)
Trennt die Verbindung mit dem Server
AWPB_POP3_FreePOP3(*POP3Object)
Gibt ein POP3-Objekt frei.
AWPB_POP3_GetServerResult.s(*POP3Object)
Gibt den letzten vom Server erhaltenen String zurück, z.
AWPB_POP3_LIST.s(*POP3Object, Index.i = 0)
Übermittelt dem Server den Befehl LIST.
AWPB_POP3_NOOP.b(*POP3Object)
Übermittelt dem Server den Befehl NOOP.
AWPB_POP3_RETR.s(*POP3Object, Index.i)
Übermittelt dem Server den Befehl RETR.
AWPB_POP3_RSET.b(*POP3Object)
Übermittelt dem Server den Befehl RSET.
AWPB_POP3_SetCallback(*POP3Object, *CallbackFuncPointer = #Null)
Setzt eine Callback-Funktion, die an verschiedenen Stellen automatisch aufgerufen wird.
AWPB_POP3_SetLogin.b(*POP3Object, User.s, Pass.s)
Setzt die Logindaten des Objektes.
AWPB_POP3_SetServer.b(*POP3Object, HostName.s, Port.w)
Setzt die Serverdaten des Objektes.
AWPB_POP3_STAT.i(*POP3Object)
Übermittelt dem Server den Befehl STAT.
AWPB_POP3_TOP.s(*POP3Object, Index.i)
Übermittelt dem Server den Befehl TOP.

Top, Back


AWPB_POP3_AllocatePOP3.i()

Fordert Speicher für ein POP3-Objekt an.
Rückgabewert ist *POP3Object. Ist der Rückgabewert #Null, wurde kein Objekt angelegt.

Top, Back


AWPB_POP3_Connect.b(*POP3Object, mode.i = #AWPB_POP3_Connect_AUTO)

Stellt eine Verbindung zum Server her. Vorher müssen mit AWPB_POP3_SetServer() und AWPB_POP3_SetLogin() die Logindaten gesetzt werden.
Rückgabewert ist bei Erfolg #True, im Fehlerfall #False

Parameters:

*POP3Object
Zeiger auf ein POP3-Objekt
mode
Verbindungsmodus; einer dieser Werte:
  • #AWPB_POP3_Connect_AUTO
  • #AWPB_POP3_Connect_USER
  • #AWPB_POP3_Connect_APOP

Top, Back


AWPB_POP3_DELE.b(*POP3Object, Index.i)

Übermittelt dem Server den Befehl DELE. Die Mail mit dem übergebenen Index wird gelöscht.
Rückgabewert ist bei Erfolg #True, im Fehlerfall #False

Parameters:

*POP3Object
Zeiger auf ein POP3-Objekt
Index
Index der zu löschenden Nachricht

Top, Back


AWPB_POP3_DisConnect.b(*POP3Object)

Trennt die Verbindung mit dem Server
Rückgabewert ist bei Erfolg #True, im Fehlerfall #False

Parameters:

*POP3Object
Zeiger auf ein POP3-Objekt

Top, Back


AWPB_POP3_FreePOP3(*POP3Object)

Gibt ein POP3-Objekt frei.

Parameters:

*POP3Object
Zeiger auf ein POP3-Objekt

Top, Back


AWPB_POP3_GetServerResult.s(*POP3Object)

Gibt den letzten vom Server erhaltenen String zurück, z.B. zur Ausgabe einer Fehlermeldung durch das Programm.

Parameters:

*POP3Object
Zeiger auf ein SMTP-Objekt

Top, Back


AWPB_POP3_LIST.s(*POP3Object, Index.i = 0)

Übermittelt dem Server den Befehl LIST. Die abgerufene Liste wird als String zurückgegeben.; Wird ein Index > 0 übergeben, werden nur die Informationen dieser einen Nachricht abgerufen.
Im Fehlerfall wird ein leerer String zurückgegeben.

Parameters:

*POP3Object
Zeiger auf ein POP3-Objekt
Index
Index der Nachricht oder 0 für alle

Top, Back


AWPB_POP3_NOOP.b(*POP3Object)

Übermittelt dem Server den Befehl NOOP.
Rückgabewert ist bei Erfolg #True, im Fehlerfall #False

Parameters:

*POP3Object
Zeiger auf ein POP3-Objekt

Top, Back


AWPB_POP3_RETR.s(*POP3Object, Index.i)

Übermittelt dem Server den Befehl RETR. Hiermit wird die angegebene Nachricht abgerufen und zurückgegeben.
Im Fehlerfall wird ein leerer String zurückgegeben.

Parameters:

*POP3Object
Zeiger auf ein POP3-Objekt
Index
Index der abzurufenden Nachricht

Top, Back


AWPB_POP3_RSET.b(*POP3Object)

Übermittelt dem Server den Befehl RSET.
Rückgabewert ist bei Erfolg #True, im Fehlerfall #False

Parameters:

*POP3Object
Zeiger auf ein POP3-Objekt

Top, Back


AWPB_POP3_SetCallback(*POP3Object, *CallbackFuncPointer = #Null)

Setzt eine Callback-Funktion, die an verschiedenen Stellen automatisch aufgerufen wird.
Die Callback-Funktion muss folgendem Muster entsprechen: Procedure.b CallbackFunction(StatusText.s).
Der Prozedur wird ein String mit dem aktuellen Status übergeben. Ist der Rückgabewert der Funktion #False, wird die POP3-Operation abgebrochen.
Wird als Zeiger #Null übergeben, wird die gespeicherte Prozedur entfernt.

Parameters:

*CallbackFuncPointer
Zeiger auf eine Callbackfunktion oder #Null
*POP3Object
Zeiger auf ein POP3-Objekt

Top, Back


AWPB_POP3_SetLogin.b(*POP3Object, User.s, Pass.s)

Setzt die Logindaten des Objektes.

Parameters:

*POP3Object
Zeiger auf ein POP3-Objekt
Pass
Passwort
User
Benutzername

Top, Back


AWPB_POP3_SetServer.b(*POP3Object, HostName.s, Port.w)

Setzt die Serverdaten des Objektes.

Parameters:

*POP3Object
Zeiger auf ein POP3-Objekt
HostName
Name des Servers
Port
Portnummer

Top, Back


AWPB_POP3_STAT.i(*POP3Object)

Übermittelt dem Server den Befehl STAT.
Rückgabewert ist bei Erfolg die Anzahl der Mails auf dem Server, im Fehlerfalle -1.

Parameters:

*POP3Object
Zeiger auf ein POP3-Objekt

Top, Back


AWPB_POP3_TOP.s(*POP3Object, Index.i)

Übermittelt dem Server den Befehl TOP. Hiermit wird der Header der angegebenen Nachricht abgerufen und zurückgegeben.
Im Fehlerfall wird ein leerer String zurückgegeben.

Parameters:

*POP3Object
Zeiger auf ein POP3-Objekt
Index
Index der abzurufenden Nachricht

Top, Back