EmailTool

Definiert in: combitCRM.SDK.WindowsClient.v13.ts:5236

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

Abfragesignatur

get IsDisposed(): boolean;

Definiert in: combitCRM.SDK.WindowsClient.v13.ts:5273

Gibt an, ob das Objekt bereits Freigegeben wurde

Rückgabewert

boolean

---

LastError

Abfragesignatur

get LastError(): OLEError;

Definiert in: combitCRM.SDK.WindowsClient.v13.ts:5250

Liefert ein OLEError -Objekt zurück.

Rückgabewert

OLEError

---

Name

Abfragesignatur

get Name(): string;

Definiert in: combitCRM.SDK.WindowsClient.v13.ts:5267

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

Rückgabewert

string

Methoden

[asyncDispose]()

asyncDispose: Promise<void>;

Definiert in: combitCRM.SDK.WindowsClient.v13.ts:5463

Standardimplementierung des AsyncDispose Symbols

Rückgabewert

Promise<void>

Implementierung von

AsyncDisposable.[asyncDispose]

---

[dispose]()

dispose: void;

Definiert in: combitCRM.SDK.WindowsClient.v13.ts:5474

Standardimplementierung des Dispose Symbols

Rückgabewert

void

Implementierung von

Disposable.[dispose]

---

CreateMailing()

CreateMailing(mailingName, mailingDescription): EmailToolMailing;

Definiert in: combitCRM.SDK.WindowsClient.v13.ts:5298

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

---

CreateRecipientList()

CreateRecipientList(
   name, 
   description, 
   attributesStructureFileName): EmailToolRecipientList;

Definiert in: combitCRM.SDK.WindowsClient.v13.ts:5318

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

---

Dispose()

Dispose(): void;

Definiert in: combitCRM.SDK.WindowsClient.v13.ts:5468

Standardimplementierung des Dispose

Rückgabewert

void

---

DisposeAsync()

DisposeAsync(): Promise<void>;

Definiert in: combitCRM.SDK.WindowsClient.v13.ts:5457

Standardimplementierung des AsyncDispose

Rückgabewert

Promise<void>

---

GetMailing()

GetMailing(mailingId): EmailToolMailing;

Definiert in: combitCRM.SDK.WindowsClient.v13.ts:5336

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

---

GetMailingLists()

Aufrufsignatur

GetMailingLists(): DataCollection;

Definiert in: combitCRM.SDK.WindowsClient.v13.ts:5353

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

Rückgabewert

DataCollection

Aufrufsignatur

GetMailingLists(mailingListID): DataCollection;

Definiert in: combitCRM.SDK.WindowsClient.v13.ts:5360

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

Parameter

Parameter	Type	Description
mailingListID	string	Hiermit werden nur Mailings zurückgegeben, die zu dieser Liste gehören. Siehe GetRecipientList.

Rückgabewert

DataCollection

---

GetRecipientFolders()

GetRecipientFolders(): DataCollection;

Definiert in: combitCRM.SDK.WindowsClient.v13.ts:5391

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

Rückgabewert

DataCollection

---

GetRecipientList()

GetRecipientList(mailingListID, attributesStructureFileName): EmailToolRecipientList;

Definiert in: combitCRM.SDK.WindowsClient.v13.ts:5410

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

---

GetRecipientLists()

GetRecipientLists(): DataCollection;

Definiert in: combitCRM.SDK.WindowsClient.v13.ts:5427

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

Rückgabewert

DataCollection

---

SetOption()

SetOption(option, value): boolean;

Definiert in: combitCRM.SDK.WindowsClient.v13.ts:5451

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.

---

[hasInstance]()

static hasInstance: boolean;

Definiert in: combitCRM.SDK.WindowsClient.v13.ts:5482

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

Parameter

Parameter	Type
value	any

Rückgabewert

boolean