EmailToolRecipientList

Das EmailToolRecipientList -Objekt beinhaltet Eigenschaften und Methoden, um eine Empfänger-Liste zu verwalten

Implementiert

• AsyncDisposable
• Disposable

Eigenschaften

ID

get ID(): string

Liefert die ID der aktuellen Empfänger-Liste zurück.

Rückgabewert

string

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:5895

---

IsDisposed

get IsDisposed(): boolean

Gibt an, ob das Objekt bereits Freigegeben wurde

Rückgabewert

boolean

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:5918

---

LastError

get LastError(): OLEError

Liefert ein OLEError -Objekt zurück.

Rückgabewert

OLEError

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:5878

---

OperationStatus

get OperationStatus(): DataCollection

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.

Rückgabewert

DataCollection

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:5904

Methoden

AddRecord()

AddRecord(record): number

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

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.

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:5967

---

AddRecordSet()

AddRecordSet(recordSet): number

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

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.

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:5986

---

ChangeEmailAddress()

ChangeEmailAddress(currentEmailAddress, newEmailAddress): boolean

Ä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

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.

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:6261

---

Dispose()

Dispose(): void

Standardimplementierung des Dispose

Rückgabewert

void

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:6278

---

DisposeAsync()

DisposeAsync(): Promise<void>

Standardimplementierung des AsyncDispose

Rückgabewert

Promise<void>

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:6267

---

GetAllRecipients()

GetAllRecipients()

GetAllRecipients(): DataCollection

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.

Rückgabewert

DataCollection

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:6052

GetAllRecipients(attributeFields)

GetAllRecipients(attributeFields): DataCollection

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
attributeFields	string	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

DataCollection

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:6060

---

GetOperationResults()

GetOperationResults(): DataCollection

Rückgabewert

DataCollection

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:6087

---

GetProperty()

GetProperty(name): unknown

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

unknown

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:5953

---

GetRecipientStatus()

GetRecipientStatus(record, mailFieldName): DataCollection

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

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.

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:6198

---

GetSubscribers()

GetSubscribers()

GetSubscribers(): DataCollection

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

Rückgabewert

DataCollection

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:6121

GetSubscribers(attributeFields)

GetSubscribers(attributeFields): DataCollection

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

DataCollection

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:6130

---

GetUnsubscribers()

GetUnsubscribers(): DataCollection

Liefert ein DataCollection-Objekt zurück, um nur alle abgemeldeten Empfänger ("Unsubscribers") der Empfänger-Liste abfragen zu können.

Rückgabewert

DataCollection

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:6104

---

RemoveRecord()

RemoveRecord(record, mailFieldName): boolean

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

boolean

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:6002

---

RemoveRecordSet()

RemoveRecordSet(recordSet, mailFieldName): boolean

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

boolean

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:6018

---

Save()

Save(): DataCollection

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

DataCollection

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:6035

---

SetProperty()

SetProperty(name, value): boolean

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

boolean

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:5943

---

SubscribeRecord()

SubscribeRecord(record, mailFieldName): boolean

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

boolean

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:6164

---

UnsubscribeRecord()

UnsubscribeRecord(record, mailFieldName): boolean

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

boolean

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:6179

---

UpdateRecord()

UpdateRecord(record): number

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

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.

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:6224

---

UpdateRecordSet()

UpdateRecordSet(recordSet): number

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

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.

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:6242

---

[asyncDispose]()

asyncDispose: Promise<void>

Standardimplementierung des AsyncDispose Symbols

Rückgabewert

Promise<void>

Implementierung von

AsyncDisposable.[asyncDispose]

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:6273

---

[dispose]()

dispose: void

Standardimplementierung des Dispose Symbols

Rückgabewert

void

Implementierung von

Disposable.[dispose]

Definiert in

combitCRM.SDK.WindowsClient.v13.ts:6284

---

[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:6292