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
AsyncDisposableDisposable
Eigenschaften
IsDisposed
get IsDisposed(): boolean
Gibt an, ob das Objekt bereits Freigegeben wurde
Rückgabewert
boolean
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:5273
LastError
get LastError(): OLEError
Liefert ein OLEError -Objekt zurück.
Rückgabewert
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:5250
Name
get Name(): string
Liefert den Namen des eingestellten eMail-Tools aus den Projekteigenschaften zurück.
Rückgabewert
string
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:5267
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
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:5298
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
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:5318
Dispose()
Dispose(): void
Standardimplementierung des Dispose
Rückgabewert
void
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:5468
DisposeAsync()
DisposeAsync(): Promise<void>
Standardimplementierung des AsyncDispose
Rückgabewert
Promise<void>
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:5457
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
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:5336
GetMailingLists()
GetMailingLists()
GetMailingLists(): DataCollection
Liefert ein DataCollection -Objekt zurück, um eine Liste der aktuellen Mailings zu erhalten.
Rückgabewert
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:5353
GetMailingLists(mailingListID)
GetMailingLists(mailingListID): DataCollection
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
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:5360
GetRecipientFolders()
GetRecipientFolders(): DataCollection
Liefert ein DataCollection -Objekt zurück, um eine Liste des aktuellen Ordners zu erhalten.
Rückgabewert
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:5391
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
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:5410
GetRecipientLists()
GetRecipientLists(): DataCollection
Liefert ein DataCollection -Objekt zurück, um eine Liste der aktuellen Empfänger-Listen zu erhalten.
Rückgabewert
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:5427
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.v13.ts:5451
[asyncDispose]()
asyncDispose: Promise<void>
Standardimplementierung des AsyncDispose Symbols
Rückgabewert
Promise<void>
Implementierung von
AsyncDisposable.[asyncDispose]
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:5463
[dispose]()
dispose: void
Standardimplementierung des Dispose Symbols
Rückgabewert
void
Implementierung von
Disposable.[dispose]
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:5474
[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.v13.ts:5482