EmailTool
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:8276
Extends
ExtendedCRMObjectBase<EmailTool>
Eigenschaften
_instance
protected _instance: EmailTool;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:12
Abgeleitet von
ExtendedCRMObjectBase._instance
className
protected readonly className: string;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:16
Abgeleitet von
ExtendedCRMObjectBase.className
lastErrorAsync
Abfragesignatur
get lastErrorAsync(): Promise<OLEError>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:8297
Liefert ein OLEError-Objekt zurück.
Rückgabewert
Promise<OLEError>
nameAsync
Abfragesignatur
get nameAsync(): Promise<string>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:8313
Liefert den Namen des eingestellten eMail-Tools aus den Projekteigenschaften zurück.
Rückgabewert
Promise<string>
Konstruktoren
Konstruktor
new EmailTool(
emailTool,
combitCRMVersion,
disposeInstance): EmailTool;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:8280
Parameter
| Parameter | Type | Default value |
|---|---|---|
emailTool | EmailTool | undefined |
combitCRMVersion | number | CRMVersion | undefined |
disposeInstance | boolean | true |
Rückgabewert
EmailTool
Überschreibt
ExtendedCRMObjectBase<CoreCRM.EmailTool>.constructor
Methoden
[asyncDispose]()
asyncDispose: Promise<void>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:93
Rückgabewert
Promise<void>
Abgeleitet von
ExtendedCRMObjectBase.[asyncDispose]
[dispose]()
dispose: void;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:88
Rückgabewert
void
Abgeleitet von
ExtendedCRMObjectBase.[dispose]
createMailingAsync()
createMailingAsync(name, description): Promise<EmailToolMailing>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:8326
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>
createRecipientListAsync()
createRecipientListAsync(
name,
description,
attributeAssignmendFilePath): Promise<EmailToolRecipientList>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:8347
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. |
attributeAssignmendFilePath | 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>
dispose()
dispose(): void;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:72
Rückgabewert
void
Abgeleitet von
ExtendedCRMObjectBase.dispose
disposeAsync()
disposeAsync(): Promise<void>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:56
Rückgabewert
Promise<void>
Abgeleitet von
ExtendedCRMObjectBase.disposeAsync
getMailingAsync()
getMailingAsync(campaingId): Promise<EmailToolMailing>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:8366
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>
getMailingListsAsync()
getMailingListsAsync(): Promise<DataCollection>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:8383
Liefert ein DataCollection-Objekt zurück, um eine Liste der aktuellen Mailings zu erhalten.
Rückgabewert
Promise<DataCollection>
getRecipientFoldersAsync()
getRecipientFoldersAsync(): Promise<DataCollection>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:8401
Liefert ein DataCollection-Objekt zurück, um eine Liste des aktuellen Ordners zu erhalten.
Rückgabewert
Promise<DataCollection>
getRecipientListAsync()
getRecipientListAsync(receiverListId, attributeAssignmentFilePath): Promise<EmailToolRecipientList>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:8421
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>
getRecipientListsAsync()
getRecipientListsAsync(): Promise<DataCollection>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:8439
Liefert ein DataCollection-Objekt zurück, um eine Liste der aktuellen Empfänger-Listen zu erhalten.
Rückgabewert
Promise<DataCollection>
guardDisposed()
protected guardDisposed(): void;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:29
Wift einen Error, wenn die Instanz bereits freigegeben wurde.
Rückgabewert
void
Throws
Error wenn die Instanz bereits freigegeben wurde.
Abgeleitet von
ExtendedCRMObjectBase.guardDisposed
isDisposed()
isDisposed(): boolean;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:51
Gibt an, ob die Instanz bereits freigegeben wurde.
Rückgabewert
boolean
true wenn die Instanz bereits freigegeben wurde, andernfalls false.
Abgeleitet von
ExtendedCRMObjectBase.isDisposed
setOptionAsync()
setOptionAsync(name, value): Promise<boolean>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:8459
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>