EmailTool

Das EmailTool -Objekt beinhaltet Eigenschaften und Methoden, um ein im cRM integriertes externes Tool für professionelles und leistungsfähiges Kampagnenmanagement zu verwenden.

Implementiert

• AsyncDisposable
• Disposable

Eigenschaften

IsDisposed

get IsDisposed(): boolean

Gibt an, ob das Objekt bereits Freigegeben wurde

Rückgabewert

boolean

Definiert in

combitCRM.SDK.WindowsClient.v11.ts:4760

---

LastError

get LastError(): OLEError

Liefert ein OLEError -Objekt zurück.

Rückgabewert

OLEError

Definiert in

combitCRM.SDK.WindowsClient.v11.ts:4737

---

Name

get Name(): string

Liefert den Namen des eingestellten eMail-Tools aus den Projekteigenschaften zurück.

Rückgabewert

string

Definiert in

combitCRM.SDK.WindowsClient.v11.ts:4754

Methoden

CreateMailing()

CreateMailing(mailingName, mailingDescription): EmailToolMailing

Liefert ein EmailToolMailing -Objekt zurück, um eine neue Kampagne zu erstellen.

Parameter

Parameter	Type	Description
mailingName	string	Der Name der zu erstellenden Kampagne.
mailingDescription	string	Eine Kurzbeschreibung für die zu erstellende Kampagne.

Rückgabewert

EmailToolMailing

Definiert in

combitCRM.SDK.WindowsClient.v11.ts:4785

---

CreateRecipientList()

CreateRecipientList(
   name, 
   description, 
   attributesStructureFileName): EmailToolRecipientList

Liefert ein EmailToolRecipientList -Objekt zurück, um eine neue Kampagne zu erstellen.

Parameter

Parameter	Type	Description
name	string	Der Name der zu erstellenden Empfänger-Liste.
description	string	Eine Kurzbeschreibung für du zu erstellende EmpfängerListe.
attributesStructureFileName	string	Dateipfad zur Attributszuordnungsdatei. Die dort eingestellten Datensatz-Felder werden vom übergebenen Record-Objekt abgefragt und beim Speichern der Empfänger-Liste übertragen.

Rückgabewert

EmailToolRecipientList

Definiert in

combitCRM.SDK.WindowsClient.v11.ts:4805

---

Dispose()

Dispose(): void

Standardimplementierung des Dispose

Rückgabewert

void

Definiert in

combitCRM.SDK.WindowsClient.v11.ts:4947

---

DisposeAsync()

DisposeAsync(): Promise<void>

Standardimplementierung des AsyncDispose

Rückgabewert

Promise<void>

Definiert in

combitCRM.SDK.WindowsClient.v11.ts:4936

---

ExtentMailing()

ExtentMailing(mailingId, mailingListId): EmailToolMailing

Parameter

Parameter	Type
mailingId	string
mailingListId	string

Rückgabewert

EmailToolMailing

Definiert in

combitCRM.SDK.WindowsClient.v11.ts:4836

---

GetMailing()

GetMailing(mailingId): EmailToolMailing

Liefert ein EmailToolMailing -Objekt zurück, um eine bereits vorhandene Kampagne zu bearbeiten.

Parameter

Parameter	Type	Description
mailingId	string	Eindeutige ID der Kampagne aus dem Zielsystem.

Rückgabewert

EmailToolMailing

Definiert in

combitCRM.SDK.WindowsClient.v11.ts:4823

---

GetMailingLists()

GetMailingLists(): DataCollection

Liefert ein DataCollection -Objekt zurück, um eine Liste der aktuellen Mailings zu erhalten.

Rückgabewert

DataCollection

Definiert in

combitCRM.SDK.WindowsClient.v11.ts:4853

---

GetRecipientFolders()

GetRecipientFolders(): DataCollection

Liefert ein DataCollection -Objekt zurück, um eine Liste des aktuellen Ordners zu erhalten.

Rückgabewert

DataCollection

Definiert in

combitCRM.SDK.WindowsClient.v11.ts:4870

---

GetRecipientList()

GetRecipientList(mailingListID, attributesStructureFileName): EmailToolRecipientList

Liefert ein EmailToolRecipientList -Objekt zurück, um eine bereits vorhandene Empfänger-Liste zu bearbeiten.

Parameter

Parameter	Type	Description
mailingListID	string	Eindeutige ID der Empfänger-Liste aus dem Zielsystem.
attributesStructureFileName	string	Dateipfad zur Attributszuordnungsdatei. Wird benötigt, um bspw.beim Hinzufügen(AddRecord/AddRecordSet) von neuen Datensätzen die Zuordnung der Felder aus dem cRM in die EmpfängerListe zu steuern.

Rückgabewert

EmailToolRecipientList

Definiert in

combitCRM.SDK.WindowsClient.v11.ts:4889

---

GetRecipientLists()

GetRecipientLists(): DataCollection

Liefert ein DataCollection -Objekt zurück, um eine Liste der aktuellen Empfänger-Listen zu erhalten.

Rückgabewert

DataCollection

Definiert in

combitCRM.SDK.WindowsClient.v11.ts:4906

---

SetOption()

SetOption(option, value): boolean

Ermöglicht das Setzen von Optionen
Optionen, die unterstützt werden (+), sind abhängig vom verwendeten E-Mail-Tool. Ein Eintrag (-) bedeutet, dass die Option nicht unterstützt wird.

Parameter

Parameter	Type	Description
option	string	Name der Option.
value	string	Wert der Option.

Rückgabewert

boolean

Remarks

Version 11.5.0

Die Methode/Eigenschaft wird erst ab dieser Version unterstützt. Bei vorherigen Versionen führt der Aufruf zu einer Exception.

Definiert in

combitCRM.SDK.WindowsClient.v11.ts:4930

---

[asyncDispose]()

asyncDispose: Promise<void>

Standardimplementierung des AsyncDispose Symbols

Rückgabewert

Promise<void>

Implementierung von

AsyncDisposable.[asyncDispose]

Definiert in

combitCRM.SDK.WindowsClient.v11.ts:4942

---

[dispose]()

dispose: void

Standardimplementierung des Dispose Symbols

Rückgabewert

void

Implementierung von

Disposable.[dispose]

Definiert in

combitCRM.SDK.WindowsClient.v11.ts:4953

---

[hasInstance]()

static hasInstance: boolean

Symbol.hasInstance welches eine benutzerdefinierte Überprüfung der 'instanceof'-Operation für Objekte ermöglicht.

Parameter

Parameter	Type
value	any

Rückgabewert

boolean

Definiert in

combitCRM.SDK.WindowsClient.v11.ts:4961