CIB mail technischer Leitfaden

5. Technische Schnittstellen

5.1. CibMailJobHandle

typedef
struct tagCibMailJobHandleStruct
{
        /* no data */
} CibMailJobHandleStruct;
typedef CibMailJobHandleStruct* CibMailJobHandle;

Das "Jobinterface" ordnet jedem Mailauftrag der durchgeführt werden soll ein "Auftragshandle" vom Typ CibMailJobHandle zu. Dieses Objekt dient als Stellvertreterobjekt des Auftrags. Sowohl das

  • Setzen und Lesen von Properties (mit CibMailSetJobProperty/CibMailGetJobProperty) als auch das
  • Ausführen des Auftrags (mit CibMailJobConnect, CibMailJobSend, CibMailJobDisconnect) sowie das
  • Abholen von Fehlerinformationen (mit CibMailJobGetError, CibMailJobGetErrorText)

 beziehen sich bei diesen Routinen stets auf ein solches Jobhandle.

Man eröffnet einen Auftrag, indem man ein Jobhandle (mit CibMailJobCreate) erzeugt. Nach dem Setzen der Properties und dem Ausführen der eMail-Übertragung gibt man das Jobhandle wieder frei (mit CibMailJobFree).