EmailToolRecipientList
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:8838
Das EmailToolRecipientList-Objekt beinhaltet Eigenschaften und Methoden, um eine Empfänger-Liste zu verwalten
Extends
ExtendedCRMObjectBase<EmailToolRecipientList>
Eigenschaften
_instance
protected _instance: EmailToolRecipientList;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:12
Abgeleitet von
ExtendedCRMObjectBase._instance
className
protected readonly className: string;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:16
Abgeleitet von
ExtendedCRMObjectBase.className
idAsync
Abfragesignatur
get idAsync(): Promise<string>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:8876
Liefert die ID der aktuellen Empfänger-Liste zurück.
Rückgabewert
Promise<string>
lastErrorAsync
Abfragesignatur
get lastErrorAsync(): Promise<OLEError>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:8859
Liefert ein OLEError-Objekt zurück.
Rückgabewert
Promise<OLEError>
operationStatusAsync
Abfragesignatur
get operationStatusAsync(): Promise<DataCollection>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:8886
Hiermit kann überprüft werden, ob die Operationen beim Speichern (EmailToolRecipientList.save) bereits abgeschlossen sind. Es wird ein DataCollection-Objekt zurückgeliefert, welches ein DataItem-Objekt enthält.
Rückgabewert
Promise<DataCollection>
Konstruktoren
Konstruktor
new EmailToolRecipientList(
emailToolRecipientList,
combitCRMVersion,
disposeInstance): EmailToolRecipientList;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:8842
Parameter
| Parameter | Type | Default value |
|---|---|---|
emailToolRecipientList | EmailToolRecipientList | undefined |
combitCRMVersion | number | CRMVersion | undefined |
disposeInstance | boolean | true |
Rückgabewert
EmailToolRecipientList
Überschreibt
ExtendedCRMObjectBase<CoreCRM.EmailToolRecipientList>.constructor
Methoden
[asyncDispose]()
asyncDispose: Promise<void>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:93
Rückgabewert
Promise<void>
Abgeleitet von
ExtendedCRMObjectBase.[asyncDispose]
[dispose]()
dispose: void;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:88
Rückgabewert
void
Abgeleitet von
ExtendedCRMObjectBase.[dispose]
addRecordAsync()
addRecordAsync(record): Promise<number>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:8932
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.
addRecordSetAsync()
addRecordSetAsync(recordSet): Promise<number>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:8949
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.
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.
changeEmailAddressAsync()
changeEmailAddressAsync(currentEmailAddress, newEmailAddress): Promise<boolean>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:9171
Ä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>
dispose()
dispose(): void;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:72
Rückgabewert
void
Abgeleitet von
ExtendedCRMObjectBase.dispose
disposeAsync()
disposeAsync(): Promise<void>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:56
Rückgabewert
Promise<void>
Abgeleitet von
ExtendedCRMObjectBase.disposeAsync
getAllRecipientsAsync()
getAllRecipientsAsync(attributeAssignmendFilePath?): Promise<DataCollection>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:9022
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>
getPropertyAsync()
getPropertyAsync(name): Promise<unknown>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:8918
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>
getRecipientStatusAsync()
getRecipientStatusAsync(record, mailFieldName): Promise<DataCollection>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:9114
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>
getSubscribersAsync()
getSubscribersAsync(attributeAssignmendFilePath?): Promise<DataCollection>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:9061
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>
getUnsubscribersAsync()
getUnsubscribersAsync(): Promise<DataCollection>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:9040
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>
guardDisposed()
protected guardDisposed(): void;
Definiert in: lib/combitCRM.SDK.v12.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.v12.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
removeRecordAsync()
removeRecordAsync(record, mailFieldName): Promise<boolean>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:8966
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<boolean>
removeRecordSetAsync()
removeRecordSetAsync(recordSet, mailFieldName): Promise<boolean>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:8983
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 wird der 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 des zu entfernenden Datensatzes steht. |
Rückgabewert
Promise<boolean>
saveAsync()
saveAsync(): Promise<DataCollection>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:9001
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>
setPropertyAsync()
setPropertyAsync(name, value): Promise<boolean>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:8906
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 | unknown | Wert für die Eigenschaft |
Rückgabewert
Promise<boolean>
subscribeRecordAsync()
subscribeRecordAsync(record, mailFieldName): Promise<boolean>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:9082
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>
unsubscribeRecordAsync()
unsubscribeRecordAsync(record, mailFieldName): Promise<boolean>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:9098
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>
updateRecordAsync()
updateRecordAsync(record): Promise<number>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:9138
Sammelt die Informationen aus dem Datensatz für das Aktualisieren eines bestehenden Empfängers, die später bei EmailToolRecipientList.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.
updateRecordSetAsync()
updateRecordSetAsync(recordSet): Promise<number>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:9155
Sammelt die Informationen aus jedem einzelnen Datensatz im RecordSet für das Aktualisieren bestehender Empfänger, die später bei EmailToolRecipientList.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.