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

Eigenschaften

IsDisposed

get IsDisposed(): boolean

Gibt an, ob das Objekt bereits Freigegeben wurde

Rückgabewert

boolean

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:8434

---

LastError

get LastError(): OLEError

Liefert ein OLEError -Objekt zurück.

Rückgabewert

OLEError

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:8410

---

Name

get Name(): string

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

Rückgabewert

string

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:8428

Methoden

CreateMailing()

CreateMailing(name, description): Promise<EmailToolMailing>

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

Parameter

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

Rückgabewert

Promise<EmailToolMailing>

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:8451

---

CreateRecipientList()

CreateRecipientList(
   name, 
   description, 
attributeAssignmentFilePath): Promise<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.
attributeAssignmentFilePath	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

Promise<EmailToolRecipientList>

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:8472

---

DisposeAsync()

DisposeAsync(): Promise<void>

Standardimplementierung des AsyncDispose

Rückgabewert

Promise<void>

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:8596

---

GetMailing()

GetMailing(campaingId): Promise<EmailToolMailing>

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

Parameter

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

Rückgabewert

Promise<EmailToolMailing>

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:8491

---

GetMailingLists()

GetMailingLists(): Promise<DataCollection>

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

Rückgabewert

Promise<DataCollection>

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:8509

---

GetRecipientFolders()

GetRecipientFolders(): Promise<DataCollection>

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

Rückgabewert

Promise<DataCollection>

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:8527

---

GetRecipientList()

GetRecipientList(receiverListId, attributeAssignmentFilePath): Promise<EmailToolRecipientList>

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

Parameter

Parameter	Type	Description
receiverListId	string	Eindeutige ID der Empfänger-Liste aus dem Zielsystem.
attributeAssignmentFilePath	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

Promise<EmailToolRecipientList>

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:8547

---

GetRecipientLists()

GetRecipientLists(): Promise<DataCollection>

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

Rückgabewert

Promise<DataCollection>

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:8565

---

SetOption()

SetOption(name, value): Promise<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
name	string	Name der Option.
value	string	Wert der Option.

Rückgabewert

Promise<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

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:8590

---

[asyncDispose]()

asyncDispose: Promise<void>

Standardimplementierung des AsyncDispose Symbols

Rückgabewert

Promise<void>

Implementierung von

AsyncDisposable.[asyncDispose]

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:8602

---

[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

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:8610