EmailToolRecipientList
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:11047
Das EmailToolRecipientList -Objekt beinhaltet Eigenschaften und Methoden, um eine Empfänger-Liste zu verwalten
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
Implementiert
AsyncDisposableDisposable
Eigenschaften
ID
Abfragesignatur
get ID(): string;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:11080
Liefert die ID der aktuellen Empfänger-Liste zurück.
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
Rückgabewert
string
IsDisposed
Abfragesignatur
get IsDisposed(): boolean;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:11104
Gibt an, ob das Objekt bereits Freigegeben wurde
Rückgabewert
boolean
LastError
Abfragesignatur
get LastError(): OLEError;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:11062
Liefert ein OLEError -Objekt zurück.
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
Rückgabewert
OperationStatus
Abfragesignatur
get OperationStatus(): DataCollection;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:11090
Hiermit kann überprüft werden, ob die Operationen beim Speichern ( Save() ) bereits abgeschlossen sind. Es wird ein DataCollection-Objekt zurückgeliefert, welches ein DataItem-Objekt enthält.
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
Rückgabewert
Methoden
[asyncDispose]()
asyncDispose: Promise<void>;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:11445
Standardimplementierung des AsyncDispose Symbols
Rückgabewert
Promise<void>
Implementierung von
AsyncDisposable.[asyncDispose]
[dispose]()
dispose: void;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:11456
Standardimplementierung des Dispose Symbols
Rückgabewert
void
Implementierung von
Disposable.[dispose]
AddRecord()
AddRecord(record): Promise<number>;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:11156
Sammelt die Informationen aus dem Datensatz für den neuen Empfänger, die später bei Save übertragen wird.Hierbei werden auch eMail-Adressen in der Sperrliste berücksichtigt und der Vorgang mit dem Rückgabewert 2 abgeschlossen.
Parameter
| Parameter | Type | Description |
|---|---|---|
record | Record | Fügt den aktuellen Datensatz in die Empfänger-Liste hinzu |
Rückgabewert
Promise<number>
0 - Es ist ein Fehler aufgetreten.
1 - Das Sammeln der Informationen für den Datensatz war erfolgreich.
2 - Es ist eine Warnung beim Sammeln der Informationen für den Datensatz aufgetreten - eMail-Adresse befindet sich auf der Sperrliste. Im LastError-Objektmit dem Fehler-Code 66 wird dann in dessen Eigenschaft ErrorAppendix die gesperrte eMail-Addresse aufgelistet.
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
AddRecordSet()
AddRecordSet(recordSet): Promise<number>;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:11176
Sammelt die Informationen aus jedem einzelnen Datensatz im RecordSet für die neuen Empfänger, die später bei Save übertragen werden. Hierbei werden auch eMail-Adressen in der Sperrliste berücksichtigt.
Befindet sich eine eMail-Adresse in der Sperrliste, so wird der Vorgang vollständig ausgeführt und liefert jedoch 2 zurück(siehe Rückgabewert)
Parameter
| Parameter | Type | Description |
|---|---|---|
recordSet | RecordSet | Fügt die einzelnen Datensätze in die Empfänger-Liste hinzu. Welche Felder pro Datensatz dazu berücksichtigt werden, ergibt sich aus dem Parameter Attributszuordnungsdatei, mit dem das Objekt EmailToolRecipientList erstellt wurde. |
Rückgabewert
Promise<number>
0 - Es ist ein Fehler aufgetreten.
1 - Das Sammeln der Informationen für den Datensatz war erfolgreich.
2 - Es ist eine Warnung beim Sammeln der Informationen für den Datensatz aufgetreten - eMail-Adresse befindet sich auf der Sperrliste. Im LastError-Objektmit dem Fehler-Code 66 wird dann in dessen Eigenschaft ErrorAppendix die gesperrte eMail-Addresse aufgelistet.
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
ChangeEmailAddress()
ChangeEmailAddress(currentEmailAddress, newEmailAddress): Promise<boolean>;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:11433
Ändert die eMail-Adresse eines Teilnehmers
Parameter
| Parameter | Type | Description |
|---|---|---|
currentEmailAddress | string | Die eMail-Adresse, die geändert werden soll. |
newEmailAddress | string | Der neue Wert der zu ändernden eMail-Adresse |
Rückgabewert
Promise<boolean>
Remarks
Version 11.2.0
Die Methode/Eigenschaft wird erst ab dieser Version unterstützt. Bei vorherigen Versionen führt der Aufruf zu einer Exception.
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
Dispose()
Dispose(): void;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:11450
Standardimplementierung des Dispose
Rückgabewert
void
DisposeAsync()
DisposeAsync(): Promise<void>;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:11439
Standardimplementierung des AsyncDispose
Rückgabewert
Promise<void>
GetAllRecipients()
GetAllRecipients(attributeAssignmendFilePath?): Promise<DataCollection>;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:11249
Liefert ein DataCollection -Objekt zurück, um alle Empfänger der Empfänger-Liste abfragen zu können. Hierbei werden auch pro Empfänger die Felder aus der Empfänger-Liste berücksichtigt.
Parameter
| Parameter | Type | Description |
|---|---|---|
attributeAssignmendFilePath? | string | Dieser Parameter ist optional. Wenn dieser nicht angegeben wird, leer ist oder ein "*" enthält, so werden immer alle Felder der Empfänger-Liste zurückgemeldet.Man kann hier auch eine kommaseparierte Liste an Feldnamen übergeben, um gezielt nur eine Auswahl an Felder zu erhalten - bspw. "Feld1, Feld8" Alternativ kann aber auch der Dateipfad zur Attributszuordnungsdatei angegeben werden.Die dort eingestellten Felder werden pro Empfänger aus der Empfänger-Liste abgefragt |
Rückgabewert
Promise<DataCollection>
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
GetProperty()
GetProperty(name): Promise<unknown>;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:11141
Darüber können für eine Empfänger-Liste spezifische Eigenschaften zurückgegeben werden.
Parameter
| Parameter | Type | Description |
|---|---|---|
name | string | Name der Eigenschaft. |
Rückgabewert
Promise<unknown>
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
GetRecipientStatus()
GetRecipientStatus(record, mailFieldName): Promise<DataCollection>;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:11367
Liefert ein DataCollection-Objekt zurück, um den Empfänger der Empfänger-Liste abfragen zu können
Parameter
| Parameter | Type | Description |
|---|---|---|
record | Record | Datensatz, der abgefragt werden soll. |
mailFieldName | string | Feldname, des Feldes, in dem die eMail-Adresse des Datensatzes steht. |
Rückgabewert
Promise<DataCollection>
Remarks
Version 11.3.0
Die Methode/Eigenschaft wird erst ab dieser Version unterstützt. Bei vorherigen Versionen führt der Aufruf zu einer Exception.
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
GetSubscribers()
GetSubscribers(attributeAssignmendFilePath?): Promise<DataCollection>;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:11299
Liefert ein DataCollection-Objekt zurück, um nur alle angemeldeten Empfänger ("Subscribers") der Empfänger-Liste abfragen zu können. Hierbei werden auch pro Empfänger die Felder aus der Empfänger-Liste berücksichtigt
Parameter
| Parameter | Type | Description |
|---|---|---|
attributeAssignmendFilePath? | string | Dieser Parameter ist optional. Wenn dieser nicht angegeben wird, leer ist oder ein "*" enthält, so werden immer alle Felder der Empfänger-Liste zurückgemeldet.Man kann hier auch eine kommaseparierte Liste an Feldnamen übergeben, um gezielt nur eine Auswahl an Felder zu erhalten - bspw. "Feld1, Feld8" Alternativ kann aber auch der Dateipfad zur Attributszuordnungsdatei angegeben werden.Die dort eingestellten Felder werden pro Empfänger aus der Empfänger-Liste abgefragt |
Rückgabewert
Promise<DataCollection>
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
GetUnsubscribers()
GetUnsubscribers(): Promise<DataCollection>;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:11278
Liefert ein DataCollection-Objekt zurück, um nur alle abgemeldeten Empfänger ("Unsubscribers") der Empfänger-Liste abfragen zu können.
Rückgabewert
Promise<DataCollection>
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
RemoveRecord()
RemoveRecord(record, mailFieldName): Promise<number>;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:11193
Sammelt die Informationen aus dem Datensatz, um diesen später bei Save in der Empfänger-Liste zu entfernen.
Hinweis: Bei der Verwendung von Inxmail wird der Empfänger vollständig global aus dem System entfernt.
Parameter
| Parameter | Type | Description |
|---|---|---|
record | Record | Datensatz, der aus der Empfänger-Liste entfernt werden soll. |
mailFieldName | string | Feldname, indem die eMail-Adresse des zu entfernenden Datensatzes steht. |
Rückgabewert
Promise<number>
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
RemoveRecordSet()
RemoveRecordSet(recordSet, mailFieldName): Promise<number>;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:11210
Sammelt die Informationen aus jedem einzelnen Datensatz im RecordSet, um diese bei Save später aus der Empfänger-Liste zu entfernen.
Hinweis: Bei der Verwendung von Inxmail werden die Empfänger vollständig global aus dem System entfernt.
Parameter
| Parameter | Type | Description |
|---|---|---|
recordSet | RecordSet | Datensätze, die aus der Empfänger-Liste entfernt werden sollen |
mailFieldName | string | Feldname, indem die eMail-Adresse der zu entfernenden Datensätze steht. |
Rückgabewert
Promise<number>
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
Save()
Save(): Promise<DataCollection>;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:11228
Wurde das EmailToolRecipientList-Objekt mit Hilfe von GetRecipientList abgefragt, wird hierbei eine vorhandene Empfänger-Liste abgefragt. Bei CreateRecipientList wird eine neue Empfänger-Liste mit den Werten aus SetProperty erstellt.
Im Anschluss werden die Datensätze aus AddRecord/AddRecordSet, UpdateRecord/UpdateRecordSet sowie RemoveRecord/RemoveRecordSet auf die Empfänger-Liste angewendet.
Es wird als Ergebnis ein DataCollection-Objekt zurückgeliefert, welches bei Erfolg genau ein DataItem-Objekt enthält, mit dem Feld "id" (Case-Sensitiv!), welches der eindeutigen ID der Empfänger-Liste entspricht.
Wird eine neue Empfänger-Liste erstellt und gespeichert, sollte man sich die ID unbedingt merken.Wurde eine bereits bekannte Empfänger-Liste gespeichert, so entspricht die ID der bekannten ID der EmpfängerListe.
Wichtig: Mit Hilfe der Eigenschaft OperationStatus kann geprüft werden, ob das Hinzufügen, Aktualisieren und/oder Entfernen der Empfänger-Liste bereits vollständig abgeschlossen ist.
Rückgabewert
Promise<DataCollection>
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
SetProperty()
SetProperty(name, value): Promise<boolean>;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:11130
Darüber können für eine neue Empfänger-Liste spezifische Eigenschaften gesammelt werden, die dann später bei der Speicherung(siehe Save) berücksichtigt werden.
Parameter
| Parameter | Type | Description |
|---|---|---|
name | string | Name der Eigenschaft. |
value | any | Wert für die Eigenschaft. |
Rückgabewert
Promise<boolean>
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
SubscribeRecord()
SubscribeRecord(record, mailFieldName): Promise<boolean>;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:11331
Versucht den Empfänger für die angegebene eMail Adresse in der aktuellen bereits existierenden Empfänger-Liste einzutragen bzw. als angemeldet zu markieren. Dies wird direkt und ohne Save ausgeführt.
Hinweis: Wenn die Empfänger-Liste über ein Double-Opt-In-Verfahren verfügt, wird unter Umständen zunächst nur eine Bestätigungs-eMail ausgelöst, über die dann der Empfänger die neue Anmeldung zunächst bestätigen muss.
Parameter
| Parameter | Type | Description |
|---|---|---|
record | Record | Datensatz, der in der Empfänger-Liste erneut angemeldet werden soll. |
mailFieldName | string | Feldname, indem die eMail-Adresse des erneut anzumeldenden Datensatzes steht. |
Rückgabewert
Promise<boolean>
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
UnsubscribeRecord()
UnsubscribeRecord(record, mailFieldName): Promise<boolean>;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:11347
Versucht den Empfänger für die angegebene eMail Adresse aus der aktuellen bereits existierenden Empfänger-Liste auszutragen bzw. als abgemeldet zu markieren. Dies wird direkt und ohne Save ausgeführt.
Parameter
| Parameter | Type | Description |
|---|---|---|
record | Record | Datensatz, der aus der Empfänger-Liste abgemeldet werden soll |
mailFieldName | string | Feldname, indem die eMail-Adresse des abzumeldenden Datensatzes steht. |
Rückgabewert
Promise<boolean>
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
UpdateRecord()
UpdateRecord(record): Promise<number>;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:11394
Sammelt die Informationen aus dem Datensatz für das Aktualisieren eines bestehenden Empfängers, die später bei Save() übertragen wird. Hierbei werden auch eMail-Adressen in der Sperrliste berücksichtigt und der Vorgang mit dem Rückgabewert 2 abgeschlossen
Parameter
| Parameter | Type | Description |
|---|---|---|
record | Record | Aktualisiert den aktuellen Datensatz in der Empfänger-Liste. Welche Felder dazu berücksichtigt werden, ergibt sich aus dem Parameter Attributszuordnungsdatei, mit dem das Objekt EmailToolRecipientList erstellt wurde. |
Rückgabewert
Promise<number>
0 - Es ist ein Fehler aufgetreten.
1 - Das Sammeln der Informationen für den Datensatz war erfolgreich.
2 - Es ist eine Warnung beim Sammeln der Informationen für den Datensatz aufgetreten - eMail-Adresse befindet sich auf der Sperrliste. Im LastError-Objektmit dem Fehler-Code 66 wird dann in dessen Eigenschaft ErrorAppendix die gesperrte eMail-Addresse aufgelistet.
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
UpdateRecordSet()
UpdateRecordSet(recordSet): Promise<number>;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:11413
Sammelt die Informationen aus jedem einzelnen Datensatz im RecordSet für das Aktualisieren bestehender Empfänger, die später bei Save() übertragen werden.Hierbei werden auch eMail-Adressen in der Sperrliste berücksichtigt.Befindet sich eine eMail-Adresse in der Sperrliste, so wird der Vorgang vollständig ausgeführt und liefert jedoch 2 zurück (siehe Rückgabewert).
Parameter
| Parameter | Type | Description |
|---|---|---|
recordSet | RecordSet | Aktualisiert die einzelnen Datensätze in der Empfänger-Liste. Welche Felder pro Datensatz dazu berücksichtigt werden, ergibt sich aus dem Parameter Attributszuordnungsdatei, mit dem das Objekt EmailToolRecipientList erstellt wurde. |
Rückgabewert
Promise<number>
0 - Es ist ein Fehler aufgetreten.
1 - Das Sammeln der Informationen für den Datensatz war erfolgreich.
2 - Es ist eine Warnung beim Sammeln der Informationen für den Datensatz aufgetreten - eMail-Adresse befindet sich auf der Sperrliste. Im LastError-Objektmit dem Fehler-Code 66 wird dann in dessen Eigenschaft ErrorAppendix die gesperrte eMail-Addresse aufgelistet.
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
[hasInstance]()
static hasInstance: boolean;
Definiert in: sdk/cosmolink.SDK.CRMApplication.ts:11464
Symbol.hasInstance welches eine benutzerdefinierte Überprüfung der 'instanceof'-Operation für Objekte ermöglicht.
Parameter
| Parameter | Type |
|---|---|
value | any |
Rückgabewert
boolean