Allgemeine Objekt-Methoden und -Eigenschaften - E-Mails

Diese Dokumentation beschreibt Methoden und Eigenschaften, die auf Objekte im Kontext von E-Mails relevant sind. E-Mails werden in agorum core als spezielle Objekte gespeichert, die selbst wiederum Teile enthalten (Nachrichtentext und Anhänge).

Neben den hier beschriebenen gelten alle Methoden und Eigenschaften aus Allgemeine Objekt-Methoden und -Eigenschaften - Basis weiterhin.

Bei den Beispielen wird davon ausgegangen, dass Sie bereits eine E-Mail geladen haben:

let objects = require('common/objects');
let mail    = objects.find('<Object.ID oder UUID einer E-Mail>');

Wo gilt welche Eigenschaft? mailBodies und mailAttachments stehen nur auf dem E-Mail-Objekt selbst zur Verfügung; auf einem einzelnen Bestandteil liefern sie undefined. Umgekehrt sind mailBody und mailAttachment auf den einzelnen Bestandteilen aussagekräftig (auf dem E-Mail-Objekt selbst liefern sie stets false).

Enthaltene Methoden und Eigenschaften

mailAttachment – Ist das Objekt ein Anhang?
mailAttachments – Liste der Anhänge einer E-Mail
mailBody – Ist das Objekt ein Body?
mailBodies - Liste der Body-Bestandteile einer E-Mail

Aufbau einer E-Mail: Ein E-Mail-Objekt ist ein eigenständiges Objekt, das seine Bestandteile referenziert. Diese Bestandteile sind einerseits die Body-Teile (Nachrichtentext, meist eine HTML-Datei) und andererseits die Anhänge. Das E-Mail-Objekt selbst ist weder Body noch Anhang. Auf ihm liefern mailBody und mailAttachment daher false. Erst auf den einzelnen Bestandteilen (erreichbar über mailBodies bzw. mailAttachments) liefern diese Eigenschaften true.

mailAttachment

Aufgabe	Datentyp
Nur lesend. Prüft, ob es sich beim Objekt um einen E-Mail-Anhang handelt.	boolean

Beispiel

let objects = require('common/objects');
let mail = objects.find('<Objekt-ID einer E-Mail>');

// iterate over e-mail attachments
mail.mailAttachments.forEach(part => {
  // mailAttachment true for attachments
  console.log(part.name + ': ' + part.mailAttachment);
});

Bedingungen/Ausnahmen

Leserechte notwendig.
Auf dem E-Mail-Objekt selbst liefert mailAttachment immer false. Der Wert ist nur auf den einzelnen Bestandteilen aussagekräftig.

mailAttachments

Aufgabe	Datentyp
Nur lesend. Liefert die E-Mail-Anhänge einer E-Mail als Array zurück. Besitzt die E-Mail keine Anhänge, wird ein leeres Array zurückgegeben.	Object[]

Beispiel

let objects = require('common/objects');
let mail = objects.find('<Objekt-ID einer E-Mail>');

let attachments = mail.mailAttachments;
attachments.forEach(a => console.log('- ' + a.name));

Bedingungen/Ausnahmen

Leserechte notwendig.
mailAttachments steht nur auf dem E-Mail-Objekt selbst zur Verfügung; auf einem einzelnen Bestandteil wird undefined zurückgegeben.

mailBody

Aufgabe	Datentyp
Nur lesend. Prüft, ob es sich beim Objekt um einen E-Mail-Body handelt (den eigentlichen Nachrichtentext einer E-Mail).	boolean

Beispiel

let objects = require('common/objects');
let mail = objects.find('<Objekt-ID einer E-Mail>');

// iterate over e-mail body parts 
mail.mailBodies.forEach(part => {
  // mailBody true for body parts
  console.log(part.name + ': ' + part.mailBody);
});

Bedingungen/Ausnahmen

Leserechte notwendig.
Auf dem E-Mail-Objekt selbst liefert mailBody immer false. Der Wert ist nur auf den einzelnen Bestandteilen aussagekräftig.

mailBodies

Aufgabe	Datentyp
Nur lesend (Eigenschaft). Liefert die Body-Bestandteile einer E-Mail als Array zurück (in der Regel ein HTML- und/oder Text-Body). Es handelt sich um das Gegenstück zu mailAttachments.	Object[]

Beispiel

let objects = require('common/objects');
let mail = objects.find('<Objekt-ID einer E-Mail>');

let bodies = mail.mailBodies;
bodies.forEach(body => console.log('- ' + body.name));

Bedingungen/Ausnahmen

Leserechte notwendig.
Besitzt die E-Mail keinen Body, wird ein leeres Array zurückgegeben.
mailBodies steht nur auf dem E-Mail-Objekt selbst zur Verfügung; auf einem einzelnen Bestandteil wird undefined zurückgegeben.