awsmtp.pbi

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

Overview


Description

awsmtp.pbi
Version 0.3

SMTP-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_SMTP_Connect_AUTO
Verbindungsmethode automatisch bestimmen
#AWPB_SMTP_Connect_LOGIN
AUTH LOGIN benutzen
#AWPB_SMTP_Connect_PLAIN
AUTH PLAIN benutzen

Top, Back


Functions and Macros
AWPB_SMTP_AllocateSMTP.i()
Fordert Speicher für ein SMTP-Objekt an.
AWPB_SMTP_Connect.b(*SMTPObject, mode.i = #AWPB_SMTP_Connect_AUTO)
Stellt eine Verbindung zum Server her.
AWPB_SMTP_DisConnect.b(*SMTPObject)
Trennt die Verbindung mit dem Server
AWPB_SMTP_FreeSMTP(*SMTPObject)
Gibt ein SMTP-Objekt frei.
AWPB_SMTP_GetServerResult.s(*SMTPObject)
Gibt den letzten vom Server erhaltenen String zurück, z.
AWPB_SMTP_GetServerResultCode.i(*SMTPObject)
Gibt den letzten vom Server erhaltenen Fehlercode zurück, z.
AWPB_SMTP_NOOP.b(*SMTPObject)
Übermittelt dem Server den Befehl NOOP.
AWPB_SMTP_RSET.b(*SMTPObject)
Übermittelt dem Server den Befehl RSET.
AWPB_SMTP_SendMessage.b(*SMTPObject, *MessageObject)
Sendet das übergebene MessageObjekt.
AWPB_SMTP_SetCallback(*SMTPObject, *CallbackFuncPointer = #Null)
Setzt eine Callback-Funktion, die an verschiedenen Stellen automatisch aufgerufen wird.
AWPB_SMTP_SetLogin.b(*SMTPObject, User.s, Pass.s)
Setzt die Logindaten des Objektes.
AWPB_SMTP_SetServer.b(*SMTPObject, HostName.s, Port.w)
Setzt die Serverdaten des Objektes.

Top, Back


AWPB_SMTP_AllocateSMTP.i()

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

Top, Back


AWPB_SMTP_Connect.b(*SMTPObject, mode.i = #AWPB_SMTP_Connect_AUTO)

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

Parameters:

*SMTPObject
Zeiger auf ein SMTP-Objekt
mode
Verbindungsmodus; einer dieser Werte:
  • #AWPB_SMTP_Connect_AUTO
  • #AWPB_SMTP_Connect_LOGIN
  • #AWPB_SMTP_Connect_PLAIN

Top, Back


AWPB_SMTP_DisConnect.b(*SMTPObject)

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

Parameters:

*SMTPObject
Zeiger auf ein SMTP-Objekt

Top, Back


AWPB_SMTP_FreeSMTP(*SMTPObject)

Gibt ein SMTP-Objekt frei.

Parameters:

*SMTPObject
Zeiger auf ein SMTP-Objekt

Top, Back


AWPB_SMTP_GetServerResult.s(*SMTPObject)

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

Parameters:

*SMTPObject
Zeiger auf ein SMTP-Objekt

Top, Back


AWPB_SMTP_GetServerResultCode.i(*SMTPObject)

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

Parameters:

*SMTPObject
Zeiger auf ein SMTP-Objekt

Top, Back


AWPB_SMTP_NOOP.b(*SMTPObject)

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

Parameters:

*SMTPObject
Zeiger auf ein SMTP-Objekt

Top, Back


AWPB_SMTP_RSET.b(*SMTPObject)

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

Parameters:

*SMTPObject
Zeiger auf ein SMTP-Objekt

Top, Back


AWPB_SMTP_SendMessage.b(*SMTPObject, *MessageObject)

Sendet das übergebene MessageObjekt. Alle relevanten Daten werden daraus entnommen. Rückgabewert ist bei Erfolg #True, im Fehlerfall #False

Parameters:

*MessageObject
Zeiger auf ein Message-Objekt
*SMTPObject
Zeiger auf ein SMTP-Objekt

Top, Back


AWPB_SMTP_SetCallback(*SMTPObject, *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 SMTP-Operation abgebrochen.
Wird als Zeiger #Null übergeben, wird die gespeicherte Prozedur entfernt.

Parameters:

*CallbackFuncPointer
Zeiger auf eine Callbackfunktion oder #Null
*SMTPObject
Zeiger auf ein SMTP-Objekt

Top, Back


AWPB_SMTP_SetLogin.b(*SMTPObject, User.s, Pass.s)

Setzt die Logindaten des Objektes.

Parameters:

*SMTPObject
Zeiger auf ein SMTP-Objekt
Pass
Passwort
User
Benutzername

Top, Back


AWPB_SMTP_SetServer.b(*SMTPObject, HostName.s, Port.w)

Setzt die Serverdaten des Objektes.

Parameters:

*SMTPObject
Zeiger auf ein SMTP-Objekt
HostName
Name des Servers
Port
Portnummer

Top, Back