awmessage.pbi

Included Files:
awdate.pbi, awfile.pbi, awsupport.pbi
Included in:
awsmtp.pbi

Overview


Description

awmessage.pbi
Version 0.3

eMail En-/Decoder für PureBasic 4.50+
Lizenz: LGPL V3

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

Top, Back


Constants
#AWPB_MSG_COMP_0
keine Kompression
#AWPB_MSG_COMP_1
Kompressionsstufe 1
#AWPB_MSG_COMP_2
Kompressionsstufe 2
#AWPB_MSG_COMP_3
Kompressionsstufe 3
#AWPB_MSG_COMP_4
Kompressionsstufe 4
#AWPB_MSG_COMP_5
Kompressionsstufe 5
#AWPB_MSG_COMP_6
Kompressionsstufe 6
#AWPB_MSG_COMP_7
Kompressionsstufe 7
#AWPB_MSG_COMP_8
Kompressionsstufe 8
#AWPB_MSG_COMP_9
Kompressionsstufe 9
#AWPB_MSG_COMP_FAST
schnellste Kompression, entspricht #AWPB_MSG_COMP_1
#AWPB_MSG_COMP_MAX
höchste Kompression, entspricht #AWPB_MSG_COMP_9
#AWPB_MSG_COMP_NONE
keine Kompression, entspricht #AWPB_MSG_COMP_0
#AWPB_MSG_COMP_NORMAL
normale Kompression, entspricht #AWPB_MSG_COMP_5
#AWPB_MSG_COMP_STORE
keine Kompression, entspricht #AWPB_MSG_COMP_0
#AWPB_MSG_CS_ISO_8859_15
Charset ISO-8859-15
#AWPB_MSG_CS_UNKNOWN
unbekanntes Charset, nur zur Ergebnisauswertung
#AWPB_MSG_MP_ALTERNATIVE
multipart/alternative als Content-Type
#AWPB_MSG_MP_MIXED
multipart/mixed als Content-Type
#AWPB_MSG_MP_RELATED
multipart/related als Content-Type
#AWPB_MSG_PRIO_HIGH
hohe Priorität
#AWPB_MSG_PRIO_HIGHEST
höchste Priorität
#AWPB_MSG_PRIO_LOW
niedrige Priorität
#AWPB_MSG_PRIO_LOWEST
niedrigste Priorität
#AWPB_MSG_PRIO_NORMAL
normale Priorität

Top, Back


Functions and Macros
AWPB_MSG_AddMultipart.i(*MessagePart, Type.i)
Fügt dem übergebenen MessagePart-Objekt einen SubPart hinzu, der selber ein MultiPart ist.
AWPB_MSG_AddPartBinary.i(*MessagePart, *buffer, buflen.i, FileName.s, Name.s, ContentID.s)
Fügt dem übergebenen MessagePart (Multipart) einen Anhang mit den übergebenen Binärdaten hinzu.
AWPB_MSG_AddPartBinaryFile.i(*MessagePart, FileName.s, Name.s, ContentID.s)
Fügt dem übergebenen MessagePart (Multipart) einen Anhang mit den übergebenen Binärdaten hinzu.
AWPB_MSG_AddPartHTML.i(*MessagePart, HTMLCode.s, CustomCharset.s = "")
Fügt dem übergebenen MessagePart (Multipart) einen HTML-Part an mit dem übergebenen HTML-Code.
AWPB_MSG_AddPartPlainText.i(*MessagePart, PlainText.s, CustomCharset.s = "")
Fügt dem übergebenen MessagePart (Multipart) einen Text-Part an mit dem übergebenen Text.
AWPB_MSG_AllocateMessage.i()
Fordert Speicher für ein Message-Objekt an.
AWPB_MSG_ClearMessage(*Message)
Löscht den Inhalt des Messageobjektes, da Objekt selber wird nicht freigegeben.
AWPB_MSG_DecodeMessage.b(*Message)
Zerlegt den Mailsource des Messageobjektes.
AWPB_MSG_EncodeMessage.b(*Message)
Erzeugt aus den Daten des MessageObjektes einen neuen Mailsource, der gespeichert oder per SMTP versendet werden kann.
AWPB_MSG_FindPartCID.i(*MessagePart, ContentID.s, CaseSensitive.b = #True)
Findet den Messagepart, dessen Content-ID gegeben ist.
AWPB_MSG_FindPartFileName.i(*MessagePart, FileName.s, CaseSensitive.b = #True)
Findet den Messagepart, dessen Dateiname gegeben ist.
AWPB_MSG_FindPartName.i(*MessagePart, Name.s, CaseSensitive.b = #True)
Findet den Messagepart, dessen Name gegeben ist.
AWPB_MSG_FreeMessage(*Message)
Gibt ein Message-Objekt frei.
AWPB_MSG_FreePartMemory(*BinaryPart)
Gibt den von AWPB_MSG_GetPartAsBin() belegten Speicher wieder frei.
AWPB_MSG_GetAttachmentList.i(*MessagePart, ListAttachments.i())
Erzeugt eine Liste aller Attachments des MessageParts.
AWPB_MSG_GetBCC.s(*Message)
Gibt die versteckten Empfänger der Mail zurück.
AWPB_MSG_GetBCCMails.s(*Message)
Gibt die versteckten Empfänger der Mail zurück.
AWPB_MSG_GetCC.s(*Message)
Gibt die Kopie-Empfänger der Mail zurück.
AWPB_MSG_GetCCMails.s(*Message)
Gibt die Kopie-Empfänger der Mail zurück.
AWPB_MSG_GetCharset.s(*MessagePart)
Gibt das Charset des Messageparts zurück.
AWPB_MSG_GetCharsetCode.i(CharsetName.s)
Gibt den Code des als String übergebenen Charsets zurück.
AWPB_MSG_GetCharsetName.s(CharsetCode.i)
Gibt den Namen des als Code übergebenen Charsets zurück.
AWPB_MSG_GetContentDisposition.s(*MessagePart)
Gibt das ContentDisposition-Feld des Messageparts zurück.
AWPB_MSG_GetContentFilename.s(*MessagePart)
Gibt den Content Dateinamen des Messageparts zurück.
AWPB_MSG_GetContentID.s(*MessagePart)
Gibt die ContentID des Messageparts zurück.
AWPB_MSG_GetContentName.s(*MessagePart)
Gibt den ContentNamen des Messageparts zurück.
AWPB_MSG_GetDate.i(*Message)
Gibt das Datum der Mail zurück.
AWPB_MSG_GetDispositionNotificationTo.s(*Message)
Gibt das DispositionNotificationTo Feld aus dem Mailheader zurück.
AWPB_MSG_GetFrom.s(*Message)
Gibt den Absender der Mail zurück.
AWPB_MSG_GetHTMLBody.s(*Message)
Gibt den text/html-Part der Mail zurück.
AWPB_MSG_GetHTMLCharsetCode.i(HTMLCode.s)
Gibt den Code des im HTML-Code verwendeten Charsets zurück.
AWPB_MSG_GetHTMLCharsetName.s(HTMLCode.s)
Gibt den Namen des im HTML-Code verwendeten Charsets zurück.
AWPB_MSG_GetMailSource.s(*Message)
Gibt den Mailsource des MessageObjektes als String zurück.
AWPB_MSG_GetPartAsBin.i(*MessagePart, *Length)
Gibt die Daten des Messageparts als Binärdaten zurück.
AWPB_MSG_GetPlainBody.s(*Message)
Gibt den text/plain-Part der Mail zurück.
AWPB_MSG_GetPlainBodyAsHTML.s(*Message)
Gibt den text/plain-Part der Mail HTML-Formatiert zurück.
AWPB_MSG_GetPriority.i(*Message)
Gibt die Priorität der Mail zurück.
AWPB_MSG_GetReplyTo.s(*Message)
Gibt das Reply-To Feld aus dem Mailheader zurück.
AWPB_MSG_GetSubject.s(*Message)
Gibt den Betreff der Mail zurück.
AWPB_MSG_GetSysCharsetCode.i()
Gibt den Code des aktuell verwendeten Charsets des Betriebssystems zurück.
AWPB_MSG_GetSysCharsetName.s()
Gibt den Namen des aktuell verwendeten Charsets des Betriebssystems zurück.
AWPB_MSG_GetTo.s(*Message)
Gibt den Empfänger der Mail zurück.
AWPB_MSG_GetToMails.s(*Message)
Gibt die Empfänger der Mail zurück.
AWPB_MSG_LoadMail.i(*Message, FileName.s)
Lädt den Mailsource für ein MessageObjekt aus einer Datei.
AWPB_MSG_LoadMailEML.i(*Message, FileName.s)
Lädt den Mailsource für ein MessageObjekt aus einer Datei.
AWPB_MSG_SaveAttachmentsToFolder.b(ListAttachments.i(), FolderName.s)
Speichert alle Attachments der Liste in einen Ordner.
AWPB_MSG_SaveAttachmentToFile.b(*MessagePart, FileName.s)
Speichert das Attachment in eine Datei.
AWPB_MSG_SaveAttachmentToFolder.b(*MessagePart, FolderName.s)
Speichert das Attachment in einen Ordner.
AWPB_MSG_SaveMail.b(*Message, FileName.s, CompressionLevel.i)
Speichert den Mailsource des MessageObjektes in eine Datei.
AWPB_MSG_SaveMailEML.b(*Message, FileName.s)
Speichert den Mailsource des MessageObjektes in eine Datei.
AWPB_MSG_SetBCC(*Message, BCCList.s)
Setzt die versteckten Empfänger (BCC) der Message.
AWPB_MSG_SetBodyBinary.i(*MessagePart, *buffer, buflen.i, FileName.s, Name.s, ContentID.s)
Setzt den Body des übergebenen MessageParts als den übergebenen HTML-Code.
AWPB_MSG_SetBodyHTML.i(*MessagePart, HTMLCode.s, CustomCharset.s = "")
Setzt den Body des übergebenen MessageParts als den übergebenen HTML-Code.
AWPB_MSG_SetBodyPlainText.i(*MessagePart, PlainText.s, CustomCharset.s = "")
Setzt den Body des übergebenen MessageParts als den übergebenen Text.
AWPB_MSG_SetCC(*Message, CCList.s)
Setzt die Kopie-Empfänger (CC) der Message.
AWPB_MSG_SetCharsetCode(*MessagePart, CharsetCode.i)
Setzt das Charset-Feld des MessageParts.
AWPB_MSG_SetCharsetName(*MessagePart, CharsetName.s)
Setzt das Charset-Feld des MessageParts.
AWPB_MSG_SetContentID(*MessagePart, ContentID.s)
Setzt das Content-ID-Feld des MessageParts.
AWPB_MSG_SetDate(*Message, DateValue.i)
Setzt das Datum der Message.
AWPB_MSG_SetDispositionNotificationTo(*Message, Adr.s)
Setzt das Disposition-Notification-To-Feld der Message.
AWPB_MSG_SetFrom(*Message, From.s)
Setzt den Absender der Message.
AWPB_MSG_SetMailSource.i(*Message, Source.s)
Setzt den Mailsource für ein MessageObjekt.
AWPB_MSG_SetMultipart.i(*Message, Type.i)
Markiert das übergebenen MessageObjekt als MultiPart-Message.
AWPB_MSG_SetPriority(*Message, Priority.i)
Setzt die Priorität (X_Priority) der Message.
AWPB_MSG_SetReplyTo(*Message, ReplyTo.s)
Setzt das Reply-To-Feld der Message.
AWPB_MSG_SetSubject(*Message, Subject.s)
Setzt den Betreff der Message.
AWPB_MSG_SetTo(*Message, ToList.s)
Setzt die Empfänger (To) der Message.

Top, Back


AWPB_MSG_AddMultipart.i(*MessagePart, Type.i)

Fügt dem übergebenen MessagePart-Objekt einen SubPart hinzu, der selber ein MultiPart ist.
Zurückgegeben wird das neue MessagePart-Objekt oder #Null im Fehlerfall.

Parameters:

*MessagePart
Zeiger auf ein Message-Objekt
Type
Typ des Multiparts, einer der folgenden Werte:
  • #AWPB_MSG_MP_RELATED
  • #AWPB_MSG_MP_MIXED
  • #AWPB_MSG_MP_ALTERNATIVE

Top, Back


AWPB_MSG_AddPartBinary.i(*MessagePart, *buffer, buflen.i, FileName.s, Name.s, ContentID.s)

Fügt dem übergebenen MessagePart (Multipart) einen Anhang mit den übergebenen Binärdaten hinzu.
Die Binärdaten werden automatisch in Base64 codiert.
Zurückgegeben wird das neue MessageObjekt oder #Null im Fehlerfall.

Parameters:

*buffer
Zeiger auf die Binärdaten
*MessagePart
Zeiger auf ein Message-Objekt
buflen
Länge der Binärdaten
ContentID
ContentID, die in den Header eingetragen wird
FileName
DateiName, der in den Header eingetragen wird
Name
ContentName, der in den Header eingetragen wird

Top, Back


AWPB_MSG_AddPartBinaryFile.i(*MessagePart, FileName.s, Name.s, ContentID.s)

Fügt dem übergebenen MessagePart (Multipart) einen Anhang mit den übergebenen Binärdaten hinzu.
Die Binärdaten werden aus der angegebenen Datei eingelesen und automatisch in Base64 codiert.
Zurückgegeben wird das neue MessageObjekt oder #Null im Fehlerfall.

Parameters:

*MessagePart
Zeiger auf ein Message-Objekt
ContentID
ContentID, die in den Header eingetragen wird
FileName
DateiName mit kompletten Pfad
Der DateiName ohne Pfad wird automatisch in den Header eingetragen.
Name
ContentName, der in den Header eingetragen wird

Top, Back


AWPB_MSG_AddPartHTML.i(*MessagePart, HTMLCode.s, CustomCharset.s = "")

Fügt dem übergebenen MessagePart (Multipart) einen HTML-Part an mit dem übergebenen HTML-Code. Ein eigenes Charset kann angegeben werden, wird ein leerer String "" angegeben, wird das StandardCharset vom System genommen.
Der Text wird automatisch codiert (QuotedPrintable bzw Base64) sofern erforderlich.
Zurückgegeben wird das neue MessageObjekt oder #Null im Fehlerfall.

Parameters:

*MessagePart
Zeiger auf ein Message-Objekt
CustomCharset
Name des Charsets oder leerer String
HTMLCode
HTML-Code

Top, Back


AWPB_MSG_AddPartPlainText.i(*MessagePart, PlainText.s, CustomCharset.s = "")

Fügt dem übergebenen MessagePart (Multipart) einen Text-Part an mit dem übergebenen Text. Ein eigenes Charset kann angegeben werden, wird ein leerer String "" angegeben, wird das StandardCharset vom System genommen.
Der Text wird automatisch codiert (QuotedPrintable bzw Base64) sofern erforderlich.
Zurückgegeben wird das neue MessageObjekt oder #Null im Fehlerfall.

Parameters:

*MessagePart
Zeiger auf ein Message-Objekt
CustomCharset
Name des Charsets oder leerer String
PlainText
Text

Top, Back


AWPB_MSG_AllocateMessage.i()

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

Top, Back


AWPB_MSG_ClearMessage(*Message)

Löscht den Inhalt des Messageobjektes, da Objekt selber wird nicht freigegeben.

Parameters:

*Message
Zeiger auf ein Message-Objekt

Top, Back


AWPB_MSG_DecodeMessage.b(*Message)

Zerlegt den Mailsource des Messageobjektes. Die einzelnen Headerfelder und Anhänge können mit den
AWPB_MSG_Get*()-Funktionen ausgelesen werden.
Der Rückgabewert ist bei Erfolg #True, sonst #False.

Parameters:

*Message
Zeiger auf ein Message-Objekt

Top, Back


AWPB_MSG_EncodeMessage.b(*Message)

Erzeugt aus den Daten des MessageObjektes einen neuen Mailsource, der gespeichert oder per SMTP versendet werden kann.
Die einzelnen Headerfelder und Attachments werden mittels der AWPB_MSG_Set*() bzw AWPB_MSG_AddPart*()-Funktionen gesetzt.
Der Rückgabewert ist bei Erfolg #True, sonst #False.

Parameters:

*Message
Zeiger auf ein Message-Objekt

Top, Back


AWPB_MSG_FindPartCID.i(*MessagePart, ContentID.s, CaseSensitive.b = #True)

Findet den Messagepart, dessen Content-ID gegeben ist.
Zurückgegeben wird ein MessagePart-Objekt. Wird kein passender Part gefunden, wird #Null zurückgegeben.

Parameters:

*MessagePart
Zeiger auf ein Message- oder MessagePart-Objekt
CaseSensitive
Groß/Kleinschreibung berücksichtigen. Wenn #True, dann ist A <> a, wenn #False ist A = a
ContentID
Content-ID nach der gesucht wird

Top, Back


AWPB_MSG_FindPartFileName.i(*MessagePart, FileName.s, CaseSensitive.b = #True)

Findet den Messagepart, dessen Dateiname gegeben ist.
Zurückgegeben wird ein MessagePart-Objekt. Wird kein passender Part gefunden, wird #Null zurückgegeben.

Parameters:

*MessagePart
Zeiger auf ein Message- oder MessagePart-Objekt
CaseSensitive
Groß/Kleinschreibung berücksichtigen. Wenn #True, dann ist A <> a, wenn #False ist A = a
FileName
FileName nach dem gesucht wird

Top, Back


AWPB_MSG_FindPartName.i(*MessagePart, Name.s, CaseSensitive.b = #True)

Findet den Messagepart, dessen Name gegeben ist.
Zurückgegeben wird ein MessagePart-Objekt. Wird kein passender Part gefunden, wird #Null zurückgegeben.

Parameters:

*MessagePart
Zeiger auf ein Message- oder MessagePart-Objekt
CaseSensitive
Groß/Kleinschreibung berücksichtigen. Wenn #True, dann ist A <> a, wenn #False ist A = a
Name
Name nach dem gesucht wird

Top, Back


AWPB_MSG_FreeMessage(*Message)

Gibt ein Message-Objekt frei.

Parameters:

*Message
Zeiger auf ein Message-Objekt

Top, Back


AWPB_MSG_FreePartMemory(*BinaryPart)

Gibt den von AWPB_MSG_GetPartAsBin() belegten Speicher wieder frei.

Parameters:

*BinaryPart
Zeiger auf Binärdaten, der von AWPB_MSG_GetPartAsBin() zurückgegeben wurde

Top, Back


AWPB_MSG_GetAttachmentList.i(*MessagePart, ListAttachments.i())

Erzeugt eine Liste aller Attachments des MessageParts. Werden die Attachments der gesamten Mail gebraucht, muss stattdessen das MessageObjekt übergeben werden.
Die Funktion gibt die Anzahl der gefundenen Attachments zurück.
Falls keine Daten vorhanden sind wird die Liste geleert und 0 zurückgegeben.

Parameters:

*MessagePart
Zeiger auf ein MessagePart- oder ein Message-Objekt
List

Top, Back


AWPB_MSG_GetBCC.s(*Message)

Gibt die versteckten Empfänger der Mail zurück.
Dabei werden Base64 bzw QuotedPrintable kodierte Texte automatisch dekodiert.
Es wird der komplette Inhalt des BCC-Feldes zurückgegeben. Wichtig: diese Daten existieren nur, wenn sie vom Benutzer hinzugefügt wurden. Im Mailsource sind sie nicht vorhanden. Falls keine Daten vorhanden sind, wird ein leerer String zurückgegeben.

Parameters:

*Message
Zeiger auf ein Message-Objekt

Top, Back


AWPB_MSG_GetBCCMails.s(*Message)

Gibt die versteckten Empfänger der Mail zurück.
Dabei werden Base64 bzw QuotedPrintable kodierte Texte automatisch dekodiert.
Es werden nur die eMail-Adressen des BCC-Feldes zurückgegeben. Wichtig: diese Daten existieren nur, wenn sie vom Benutzer hinzugefügt wurden. Im Mailsource sind sie nicht vorhanden.
Falls keine Daten vorhanden sind, wird ein leerer String zurückgegeben.

Parameters:

*Message
Zeiger auf ein Message-Objekt

Top, Back


AWPB_MSG_GetCC.s(*Message)

Gibt die Kopie-Empfänger der Mail zurück.
Dabei werden Base64 bzw QuotedPrintable kodierte Texte automatisch dekodiert.
Es wird der komplette Inhalt des CC-Headers zurückgegeben.
Falls keine Daten vorhanden sind, wird ein leerer String zurückgegeben.

Parameters:

*Message
Zeiger auf ein Message-Objekt

Top, Back


AWPB_MSG_GetCCMails.s(*Message)

Gibt die Kopie-Empfänger der Mail zurück.
Dabei werden Base64 bzw QuotedPrintable kodierte Texte automatisch dekodiert.
Es werden nur die eMail-Adressen des CC-Headers zurückgegeben.
Falls keine Daten vorhanden sind, wird ein leerer String zurückgegeben.

Parameters:

*Message
Zeiger auf ein Message-Objekt

Top, Back


AWPB_MSG_GetCharset.s(*MessagePart)

Gibt das Charset des Messageparts zurück.
Falls keine Daten vorhanden sind wird ein leerer String zurückgegeben..

Parameters:

*MessagePart
Zeiger auf ein MessagePart- oder ein Message-Objekt

Top, Back


AWPB_MSG_GetCharsetCode.i(CharsetName.s)

Gibt den Code des als String übergebenen Charsets zurück.
Falls das Charset unbekannt ist, wird #AWPB_MSG_CS_UNKNOWN zurückgegeben.

Parameters:

CharsetName
Name des Charsets

Top, Back


AWPB_MSG_GetCharsetName.s(CharsetCode.i)

Gibt den Namen des als Code übergebenen Charsets zurück.
Falls das Charset unbekannt ist, wird "unknown" zurückgegeben.

Parameters:

CharsetCode
Code des Charsets

Top, Back


AWPB_MSG_GetContentDisposition.s(*MessagePart)

Gibt das ContentDisposition-Feld des Messageparts zurück.
Falls keine Daten vorhanden sind wird ein leerer String zurückgegeben.

Parameters:

*MessagePart
Zeiger auf ein MessagePart- oder ein Message-Objekt

Top, Back


AWPB_MSG_GetContentFilename.s(*MessagePart)

Gibt den Content Dateinamen des Messageparts zurück.
Falls keine Daten vorhanden sind wird ein leerer String zurückgegeben.

Parameters:

*MessagePart
Zeiger auf ein MessagePart- oder ein Message-Objekt

Top, Back


AWPB_MSG_GetContentID.s(*MessagePart)

Gibt die ContentID des Messageparts zurück.
Falls keine Daten vorhanden sind wird ein leerer String zurückgegeben.

Parameters:

*MessagePart
Zeiger auf ein MessagePart- oder ein Message-Objekt

Top, Back


AWPB_MSG_GetContentName.s(*MessagePart)

Gibt den ContentNamen des Messageparts zurück.
Falls keine Daten vorhanden sind wird ein leerer String zurückgegeben.

Parameters:

*MessagePart
Zeiger auf ein MessagePart- oder ein Message-Objekt

Top, Back


AWPB_MSG_GetDate.i(*Message)

Gibt das Datum der Mail zurück. Die Rückgabe erfolgt im PB-Date-Format; kann also mit den Datumsfunktionen weiterverarbeitet werden.
Falls keine Daten vorhanden sind wird 0 zurückgegeben.

Parameters:

*Message
Zeiger auf ein Message-Objekt

Top, Back


AWPB_MSG_GetDispositionNotificationTo.s(*Message)

Gibt das DispositionNotificationTo Feld aus dem Mailheader zurück.
Falls keine Daten vorhanden sind wird ein leerer String zurückgegeben.

Parameters:

*Message
Zeiger auf ein Message-Objekt

Top, Back


AWPB_MSG_GetFrom.s(*Message)

Gibt den Absender der Mail zurück.
Dabei werden Base64 bzw QuotedPrintable kodierte Texte automatisch dekodiert.
Falls keine Daten vorhanden sind, wird ein leerer String zurückgegeben.

Parameters:

*Message
Zeiger auf ein Message-Objekt

Top, Back


AWPB_MSG_GetHTMLBody.s(*Message)

Gibt den text/html-Part der Mail zurück.
Dabei werden Base64 bzw QuotedPrintable kodierte Texte automatisch dekodiert.
Falls keine Daten vorhanden sind, wird ein leerer String zurückgegeben.

Parameters:

*Message
Zeiger auf ein Message-Objekt

Top, Back


AWPB_MSG_GetHTMLCharsetCode.i(HTMLCode.s)

Gibt den Code des im HTML-Code verwendeten Charsets zurück.
Falls das Charset nicht zu ermitteln ist oder unbekannt ist, wird #AWPB_MSG_CS_UNKNOWN zurückgegeben.

Parameters:

HTMLCode
HTML Code

Top, Back


AWPB_MSG_GetHTMLCharsetName.s(HTMLCode.s)

Gibt den Namen des im HTML-Code verwendeten Charsets zurück.
Falls das Charset nicht zu ermitteln ist, wird ein leerer String zurückgegeben.

Parameters:

HTMLCode
HTML Code

Top, Back


AWPB_MSG_GetMailSource.s(*Message)

Gibt den Mailsource des MessageObjektes als String zurück.

Parameters:

*Message
Zeiger auf ein Message-Objekt

Top, Back


AWPB_MSG_GetPartAsBin.i(*MessagePart, *Length)

Gibt die Daten des Messageparts als Binärdaten zurück.
Sofern diese Quoted-Printable oder Base64 kodiert sind, werden sie zuvor dekodiert.
Handelt es sich um Textdaten, können sie mir PeekS(,Length ,#PB_ASCII) ausgelesen werden.
Zurückgegeben wird ein Zeiger auf die Binärdaten, der mit AWPB_MSG_FreePartMemory() freigegeben werden muss.

Parameters:

*Length
Zeiger auf eine Integervariable, in der die Länge der Daten zurückgegeben wird. Length muss vom Typ .i sein.
*MessagePart
Zeiger auf ein Message- oder MessagePart-Objekt

Top, Back


AWPB_MSG_GetPlainBody.s(*Message)

Gibt den text/plain-Part der Mail zurück.
Dabei werden Base64 bzw QuotedPrintable kodierte Texte automatisch dekodiert.
Falls keine Daten vorhanden sind, wird ein leerer String zurückgegeben.

Parameters:

*Message
Zeiger auf ein Message-Objekt

Top, Back


AWPB_MSG_GetPlainBodyAsHTML.s(*Message)

Gibt den text/plain-Part der Mail HTML-Formatiert zurück.
Dabei werden Base64 bzw QuotedPrintable kodierte Texte automatisch dekodiert.
Falls keine Daten vorhanden sind, wird ein leerer String zurückgegeben.

Parameters:

*Message
Zeiger auf ein Message-Objekt

Top, Back


AWPB_MSG_GetPriority.i(*Message)

Gibt die Priorität der Mail zurück. (X-Priority) Mögliche Rückgabewerte sind

Falls keine Daten vorhanden sind wird #AWPB_MSG_PRIO_NORMAL zurückgegeben.

Parameters:

*Message
Zeiger auf ein Message-Objekt

Top, Back


AWPB_MSG_GetReplyTo.s(*Message)

Gibt das Reply-To Feld aus dem Mailheader zurück. Falls keine Daten vorhanden sind wird ein leerer String zurückgegeben.

Parameters:

*Message
Zeiger auf ein Message-Objekt

Top, Back


AWPB_MSG_GetSubject.s(*Message)

Gibt den Betreff der Mail zurück.
Dabei werden Base64 bzw QuotedPrintable kodierte Texte automatisch dekodiert.
Falls keine Daten vorhanden sind, wird ein leerer String zurückgegeben.

Parameters:

*Message
Zeiger auf ein Message-Objekt

Top, Back


AWPB_MSG_GetSysCharsetCode.i()

Gibt den Code des aktuell verwendeten Charsets des Betriebssystems zurück.
Im Fehlerfall wird #AWPB_MSG_CS_UNKNOWN zurückgegeben.

Top, Back


AWPB_MSG_GetSysCharsetName.s()

Gibt den Namen des aktuell verwendeten Charsets des Betriebssystems zurück.
Im Fehlerfall wird ein leerer String zurückgegeben.

Top, Back


AWPB_MSG_GetTo.s(*Message)

Gibt den Empfänger der Mail zurück.
Dabei werden Base64 bzw QuotedPrintable kodierte Texte automatisch dekodiert.
Es wird der komplette Inhalt des To-Headers zurückgegeben.
Falls keine Daten vorhanden sind, wird ein leerer String zurückgegeben.

Parameters:

*Message
Zeiger auf ein Message-Objekt

Top, Back


AWPB_MSG_GetToMails.s(*Message)

Gibt die Empfänger der Mail zurück.
Dabei werden Base64 bzw QuotedPrintable kodierte Texte automatisch dekodiert.
Es werden nur die eMail-Adressen des To-Headers zurückgegeben.
Falls keine Daten vorhanden sind, wird ein leerer String zurückgegeben.

Parameters:

*Message
Zeiger auf ein Message-Objekt

Top, Back


AWPB_MSG_LoadMail.i(*Message, FileName.s)

Lädt den Mailsource für ein MessageObjekt aus einer Datei.
Wenn *Message = #Null, wird ein neues Message-Objekt angelegt und zurückgegeben. Wurde ein bestehendes Objekt übergeben, so wird dieses wiederverwendet.
Eventuell vorhandene Daten werden gelöscht. Ist der Rückgabewert #Null, wurde kein Objekt angelegt.
Es wird eine mit AWPB_MSG_SaveMail() erzeugte Datei erwartet.

Parameters:

*Message
Zeiger auf ein Message-Objekt oder #Null
FileName
Datei, die den Mailsource enthält

Top, Back


AWPB_MSG_LoadMailEML.i(*Message, FileName.s)

Lädt den Mailsource für ein MessageObjekt aus einer Datei.
Wenn *Message = #Null, wird ein neues Message-Objekt angelegt und zurückgegeben. Wurde ein bestehendes Objekt übergeben, so wird dieses wiederverwendet.
Eventuell vorhandene Daten werden gelöscht. Ist der Rückgabewert #Null, wurde kein Objekt angelegt.
Als Dateiformat wird eine ASCII-Datei erwartet, die den unbearbeiteten Quellcode enthält, wie er vom POP-Server geliefert wird.

Parameters:

*Message
Zeiger auf ein Message-Objekt oder #Null
FileName
Datei, die den Mailsource enthält

Top, Back


AWPB_MSG_SaveAttachmentsToFolder.b(ListAttachments.i(), FolderName.s)

Speichert alle Attachments der Liste in einen Ordner. Als Dateiname wird der Dateiname aus dem jeweiligen Header übernommen.
Bei einem Fehler wird #False zurückgegeben, ansonsten #True.

Parameters:

FolderName
Ordnername, in dem das Attachment gespeichert werden soll
List

Top, Back


AWPB_MSG_SaveAttachmentToFile.b(*MessagePart, FileName.s)

Speichert das Attachment in eine Datei.
Bei einem Fehler wird #False zurückgegeben, ansonsten #True.

Parameters:

*MessagePart
Zeiger auf ein MessagePart-Objekt, das ein Attachment enthält
FileName
Dateiname (inkl. Pfad), in die das Attachment gespeichert werden soll

Top, Back


AWPB_MSG_SaveAttachmentToFolder.b(*MessagePart, FolderName.s)

Speichert das Attachment in einen Ordner. Als Dateiname wird der Dateiname aus dem Header übernommen.
Bei einem Fehler wird #False zurückgegeben, ansonsten #True.

Parameters:

*MessagePart
Zeiger auf ein MessagePart-Objekt, das ein Attachment enthält
FolderName
Ordnername, in dem das Attachment gespeichert werden soll

Top, Back


AWPB_MSG_SaveMail.b(*Message, FileName.s, CompressionLevel.i)

Speichert den Mailsource des MessageObjektes in eine Datei.
Der Rückgabewert ist bei Erfolg #True, sonst #False.
Die Funktion erzeugt eine Spezialdatei, welche auf Wunsch komprimiert wird. Diese Datei lässt sich mit AWPB_MSG_LoadMail() wieder einlesen.
Um evtl BCC-Daten zu sichern, muss diese Funktion genutzt werden.

Parameters:

*Message
Zeiger auf ein Message-Objekt
CompressionLevel
Kompressionsstufe
Einer folgender Werte:
  • #AWPB_MSG_COMP_0
  • #AWPB_MSG_COMP_1
  • #AWPB_MSG_COMP_2
  • #AWPB_MSG_COMP_3
  • #AWPB_MSG_COMP_4
  • #AWPB_MSG_COMP_5
  • #AWPB_MSG_COMP_6
  • #AWPB_MSG_COMP_7
  • #AWPB_MSG_COMP_8
  • #AWPB_MSG_COMP_9
  • #AWPB_MSG_COMP_STORE
  • #AWPB_MSG_COMP_NONE
  • #AWPB_MSG_COMP_FAST
  • #AWPB_MSG_COMP_NORMAL
  • #AWPB_MSG_COMP_MAX
FileName
Name der Zieldatei

Top, Back


AWPB_MSG_SaveMailEML.b(*Message, FileName.s)

Speichert den Mailsource des MessageObjektes in eine Datei.
Der Rückgabewert ist bei Erfolg #True, sonst #False.
Die Funktion erzeugt eine ASCII-Datei, die den Puren Mailsource enthält. Evtl vorhandene BCC Daten werden NICHT gespeichert.

Parameters:

*Message
Zeiger auf ein Message-Objekt
FileName
Name der Zieldatei

Top, Back


AWPB_MSG_SetBCC(*Message, BCCList.s)

Setzt die versteckten Empfänger (BCC) der Message. Ist das Feld bereits gesetzt, so wird es ersetzt.
Wichtig: diese Daten werden nur bei Benutzung der Funktion AWPB_MSG_SaveMail() gespeichert bzw bei AWPB_MSG_LoadMail() eingelesen,
da sie im Mailbody nicht vorhanden sind

Parameters:

*Message
Zeiger auf ein Message-Objekt
BCCList
neue Empfänger (eMail, bei mehreren mit "," getrennt)

Top, Back


AWPB_MSG_SetBodyBinary.i(*MessagePart, *buffer, buflen.i, FileName.s, Name.s, ContentID.s)

Setzt den Body des übergebenen MessageParts als den übergebenen HTML-Code. Ein eigenes Charset kann angegeben werden, wird ein leerer String "" angegeben, wird das StandardCharset vom System genommen.
Die Binärdaten werden automatisch in Base64 codiert.
Zurückgegeben wird das MessageObjekt selber.

Parameters:

*buffer
Zeiger auf die Binärdaten
*MessagePart
Zeiger auf ein Message-Objekt
buflen
Länge der Binärdaten
ContentID
ContentID, die in den Header eingetragen wird
FileName
DateiName, der in den Header eingetragen wird
Name
ContentName, der in den Header eingetragen wird

Top, Back


AWPB_MSG_SetBodyHTML.i(*MessagePart, HTMLCode.s, CustomCharset.s = "")

Setzt den Body des übergebenen MessageParts als den übergebenen HTML-Code. Ein eigenes Charset kann angegeben werden, wird ein leerer String "" angegeben, wird das StandardCharset vom System genommen.
Der Text wird automatisch codiert (QuotedPrintable bzw Base64) sofern erforderlich.
Zurückgegeben wird das MessageObjekt selber.

Parameters:

*MessagePart
Zeiger auf ein Message-Objekt
CustomCharset
Name des Charsets oder leerer String
HTMLCode
HTML-Code

Top, Back


AWPB_MSG_SetBodyPlainText.i(*MessagePart, PlainText.s, CustomCharset.s = "")

Setzt den Body des übergebenen MessageParts als den übergebenen Text. Ein eigenes Charset kann angegeben werden, wird ein leerer String "" angegeben, wird das StandardCharset vom System genommen.
Der Text wird automatisch codiert (QuotedPrintable bzw Base64) sofern erforderlich.
Zurückgegeben wird das MessageObjekt selber.

Parameters:

*MessagePart
Zeiger auf ein Message-Objekt
CustomCharset
Name des Charsets oder leerer String
PlainText
Text

Top, Back


AWPB_MSG_SetCC(*Message, CCList.s)

Setzt die Kopie-Empfänger (CC) der Message. Ist das Feld bereits gesetzt, so wird es ersetzt.

Parameters:

*Message
Zeiger auf ein Message-Objekt
CCList
neue Empfänger (eMail, bei mehreren mit "," getrennt)

Top, Back


AWPB_MSG_SetCharsetCode(*MessagePart, CharsetCode.i)

Setzt das Charset-Feld des MessageParts. Ist das Feld bereits gesetzt, so wird es ersetzt.

Parameters:

*MessagePart
Zeiger auf ein MessagePart-Objekt
CharsetCode
Code des Charsets, entweder der Rückgabewert von AWPB_MSG_GetSysCharsetCode() oder einer der folgenden
  • #AWPB_MSG_CS_ISO_8859_15

Top, Back


AWPB_MSG_SetCharsetName(*MessagePart, CharsetName.s)

Setzt das Charset-Feld des MessageParts. Ist das Feld bereits gesetzt, so wird es ersetzt.

Parameters:

*MessagePart
Zeiger auf ein MessagePart-Objekt
CharsetName
Name des Charsets (z.B. Rückgabewert von AWPB_MSG_GetSysCharsetName())

Top, Back


AWPB_MSG_SetContentID(*MessagePart, ContentID.s)

Setzt das Content-ID-Feld des MessageParts. Ist das Feld bereits gesetzt, so wird es ersetzt.

Parameters:

*MessagePart
Zeiger auf ein MessagePart-Objekt
ContentID
ContentID des MessageParts

Top, Back


AWPB_MSG_SetDate(*Message, DateValue.i)

Setzt das Datum der Message. Ist das Feld bereits gesetzt, so wird es ersetzt.

Parameters:

*Message
Zeiger auf ein Message-Objekt
DateValue
neues Datum, kann mit der Date()-Funktion von PB ermittelt werden

Top, Back


AWPB_MSG_SetDispositionNotificationTo(*Message, Adr.s)

Setzt das Disposition-Notification-To-Feld der Message. Ist das Feld bereits gesetzt, so wird es ersetzt.

Parameters:

*Message
Zeiger auf ein Message-Objekt
Adr
neue Adresse

Top, Back


AWPB_MSG_SetFrom(*Message, From.s)

Setzt den Absender der Message. Ist der Absender bereits gesetzt, so wird er ersetzt.

Parameters:

*Message
Zeiger auf ein Message-Objekt
From
neuer Absender (eMail)

Top, Back


AWPB_MSG_SetMailSource.i(*Message, Source.s)

Setzt den Mailsource für ein MessageObjekt.
Wenn *Message = #Null, wird ein neues Message-Objekt angelegt und zurückgegeben. Wurde ein bestehendes Objekt übergeben, so wird dieses wiederverwendet.
Eventuell vorhandene Daten werden gelöscht. Ist der Rückgabewert #Null, wurde kein Objekt angelegt.

Parameters:

*Message
Zeiger auf ein Message-Objekt oder #Null
Source
Source der eMail

Top, Back


AWPB_MSG_SetMultipart.i(*Message, Type.i)

Markiert das übergebenen MessageObjekt als MultiPart-Message.
Zurückgegeben wird das MessageObjekt selber.

Parameters:

*Message
Zeiger auf ein Message-Objekt
Type
Typ des Multiparts, einer der folgenden Werte:
  • #AWPB_MSG_MP_RELATED
  • #AWPB_MSG_MP_MIXED
  • #AWPB_MSG_MP_ALTERNATIVE

Top, Back


AWPB_MSG_SetPriority(*Message, Priority.i)

Setzt die Priorität (X_Priority) der Message. Ist das Feld bereits gesetzt, so wird es ersetzt.

Parameters:

*Message
Zeiger auf ein Message-Objekt
Priority
neue Priorität, einer der folgenden Werte:
  • #AWPB_MSG_PRIO_HIGHEST
  • #AWPB_MSG_PRIO_HIGH
  • #AWPB_MSG_PRIO_NORMAL
  • #AWPB_MSG_PRIO_LOW
  • #AWPB_MSG_PRIO_LOWEST

Top, Back


AWPB_MSG_SetReplyTo(*Message, ReplyTo.s)

Setzt das Reply-To-Feld der Message. Ist das Feld bereits gesetzt, so wird es ersetzt.

Parameters:

*Message
Zeiger auf ein Message-Objekt
ReplyTo
neue Adresse

Top, Back


AWPB_MSG_SetSubject(*Message, Subject.s)

Setzt den Betreff der Message. Ist der Betreff bereits gesetzt, so wird er ersetzt.

Parameters:

*Message
Zeiger auf ein Message-Objekt
Subject
neuer Betreff

Top, Back


AWPB_MSG_SetTo(*Message, ToList.s)

Setzt die Empfänger (To) der Message. Ist das Feld bereits gesetzt, so wird es ersetzt.

Parameters:

*Message
Zeiger auf ein Message-Objekt
ToList
neue Empfänger (eMail, bei mehreren mit "," getrennt)

Top, Back