CIB mail technischer Leitfaden: Allgemeine Properties

CIB mail technischer Leitfaden

5. Technische Schnittstellen

5.21. Allgemeine Properties

Allgemein
MAPI-Properties
SMTP-Properties

Allgemein

Die sogenannten "Properties" oder Eigenschaften bilden ein wesentliches Kriterium bei dem Aufruf der eigentlich auszuführenden Methode. Alle unten im Klartext genannten Optionsnamen sind in den einzelnen Headerdateien der Komponenten auch als „define“ deklariert und auch über diese „defines“ in Ihrem Sourcecode ansprechbar. Die verschiedenen Ausgabemodule besitzen weitere spezielle Properties, die dort in den einzelnen Unterkapiteln beschrieben sind.

Zum Setzen der Optionen steht die Funktion CibMailSetProperty und zum Abholen die Funktion CibMailGetProperty zur Verfügung.

Das CIB smtp/mail Modul ermöglicht das Erzeugen von eMail Nachrichten inkl. eines oder mehrere Dateianhänge (die ggf. vorher durch eines der Ausgabemodule erzeugt wurden). CIB mail nutzt wahlweise das SMTP-Protokoll oder das MAPI-Protokoll. Bei Verwendung des MAPI-Protokolls wird das SimpleMAPI Interface verwendet und ist auch nur auf dieser Plattform verfügbar.

Die eMail kann im Hintergrund (=“silent“) oder über den eMail-Dialog des jeweils eingesetzten eMail-Clients aufbereitet und versandt werden.

Allgemeine Properties der CIB mail Komponente (MAPI und SMTP):

Optionsname	Optionswert	Datentyp
MailRecipientsMailBox	eMail-Adressen der Empfänger, jeweils durch Semikolon voneinander getrennt	Char*
MailCCRecipientsMailBox	eMail-Adressen der Empfänger von Kopien der eMail, jeweils durch Semikolon voneinander getrennt	Char*
MailBCCRecipientsMailBox	eMail-Adressen der Empfänger von Black Kopien der eMail, jeweils durch Semikolon voneinander getrennt	Char*
MailSenderMailBox	Absender-eMail-Adresse	Char*
MailSubject	Betreff der eMail, begrenzt auf 256 Zeichen oder weniger.	Char*
MailTextFilename	Nachricht-Text der eMail. Default = NULL	Char*
MailAttachmentFilename	Anhänge der eMail	Char*
MailProtocol	Zum Mail-Versand verwendetes Protokoll: “SMTP” oder “MAPI” Default =SMTP	Char*
MailTraceFilename	Name der Protokolldatei in die ein Trace geschrieben werden soll	Char*

MAPI-Properties

Folgende Eigenschaften stehen nur für den E-Mail-Versand über die MAPI-Schnittstelle (nur unter Windows) zur Verfügung:

Optionsname	Optionswert	Datentyp
"" (COMOD_PROP_SET_TO_DEFAULT)	NULL Setzt alle Eigenschaften auf Ihre Defaultwerte zurück	void*
MailDialog	Gibt an, ob ein Mail-Dialog geöffnet werden soll, der dem Benutzer die Empfänger und weitere Sende-Optionen anzeigt. Default ist FALSE.	bool
MailLogonDialog	Gibt an, ob ein Mail-Logon-Dialog geöffnet werden soll für ein Logon durch den Benutzer falls erforderlich. Default ist FALSE.	bool
MailAvailable		Char*
MailResolveName		bool

SMTP-Properties

Folgende Eigenschaften stehen nur für den E-Mail-Versand über SMTP zur Verfügung.

Bei Verwendung des SMTP-Protokolls müssen vorher mindestens die Eigenschaften MailSenderMailBox, MailRecipientsMailBox, MailServer, MailServerPort, MailSubject und MailTextFilename gesetzt worden sein.

Optionsname	Optionswert	Datentyp
MailAttachmentMemoryAddress	Memory-Adresse der Mail-Anhangsdaten	Char*
MailAttachmentMimeType	MIME Typ der Mail-Anhangsdaten (e.g. applichation/pdf) Default = text/plain	Char*
MailTextMemoryAddress	Memory-Adresse des Mail-Textes	Char*
MailTextContentType	Content type des Mail-Textes (e.g. text/html) charset=… kann zusätzlich angegeben werden (e.g. text/html; charset=UTF-8) Bei Dateinamen-Erweiterung == ".htm" ist der Default = “text/html; charset=ISO-8859-1“ Anderenfalls ist der Default = “text/plain; charset=ISO-8859-1”	Char*
MailSenderFullName	Vollständiger Name des Absenders	Char*
MailRecipientsFullName	Vollständige Namen der Empfänger jeweils durch Semikolon voneinander getrennt	Char*
MailCCRecipientsFullName	Vollständige Namen der Empfänger der Kopien der eMail, jeweils durch Semikolon voneinander getrennt	Char*
MailBCCRecipientsFullName	Vollständige Namen der Empfänger der Black Kopien der eMail, jeweils durch Semikolon voneinander getrennt	Char*
MailReplyToMailBox	eMail-Adresse des Empfängers der Antwort-eMail
MailReplyToFullName	Vollständige Namen des Empfängers der Antwort-eMail	Char*
MailAdditionalHeader	optional: Zusätzliche Mail-Header-Einträge, e.g. X-Mailer ...	Char*
MailAuthLogin	Benutzer-Login-Name zur Authentifizierung	Char*
MailAuthPassword	Benutzer-Login-Kennwort zur Authentifizierung	Char*
MailProtocol	Zum Mail-Versand verwendetes Protokoll: “SMTP” oder “MAPI”	Char*
MailServer	Message Transfer Agent - sendender Server Default = localhost	Char*
MailServerPort	Port zur Verbindung mit dem Server [MTA] Default = 25	Char*
MailWorkSpace	Gibt den Verzeichnis-Pfad der Mail-Anhangsdateien und der Mailtext-Datei an.	Char*
SMTP	Gibt an, ob das SMTP-Protokoll verwendet werden soll. Default ist FALSE	bool
MAPI	Gibt an, ob das MAPI-Protokoll verwendet werden soll. Default ist FALSE	bool
UseBulkMail	Gibt an, ob die Massenmail-Option verwendet werden soll. Default ist FALSE	bool