Office.InternetHeaders interface

Paket:
outlook

Das InternetHeaders Objekt stellt benutzerdefinierte Internetheader dar, die beibehalten werden, nachdem das Nachrichtenelement Exchange verlassen und in eine MIME-Nachricht konvertiert wurde.

Internetheader werden als Schlüssel-Wert-Zeichenschaftspaare pro Element gespeichert.

Hinweis: Dieses Objekt ist für Sie vorgesehen, um Ihre benutzerdefinierten Header für ein Nachrichtenelement festzulegen und abzurufen. Weitere Informationen finden Sie unter Abrufen und Festlegen von Internetkopfzeilen für eine Nachricht in einem Outlook-Add-In.

Hinweise

API-Satz: Postfach 1.8

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Compose

Wichtig: Die Internetheader-API wird in Outlook unter Android und unter iOS ab Version 4.2405.0 unterstützt. Weitere Informationen zu Features, die in Outlook auf Mobilgeräten unterstützt werden, finden Sie unter Outlook-JavaScript-APIs, die in Outlook auf Mobilgeräten unterstützt werden.

Empfohlene Vorgehensweise

Derzeit sind Internetheader eine endliche Ressource im Postfach eines Benutzers. Wenn das Kontingent erschöpft ist, können Sie keine weiteren Internetheader für dieses Postfach erstellen. Dies kann zu unerwartetem Verhalten von Clients führen, die zum Funktionieren darauf angewiesen sind.

Wenden Sie die folgenden Richtlinien an, wenn Sie Internetheader in Ihrem Add-In erstellen.

  • Erstellen Sie die erforderliche Mindestanzahl von Headern. Das Headerkontingent basiert auf der Gesamtgröße der auf eine Nachricht angewendeten Header. In Exchange Online ist das Headerlimit auf 256 KB beschränkt, während das Limit in einer lokalen Exchange-Umgebung vom Administrator Ihrer organization festgelegt wird. Weitere Informationen zu Headergrenzwerten finden Sie unter Exchange Online-Nachrichtengrenzwerte und Exchange Server-Nachrichtengrenzwerte.

  • Kopfzeilen benennen, damit Sie ihre Werte später wiederverwenden und aktualisieren können. Vermeiden Sie daher, Header variabel zu benennen (z. B. basierend auf Benutzereingaben, Zeitstempeln usw.).

Verwendet von

Methoden

getAsync(names, options, callback)

Bei gegebener Matrix von Internetheadernamen gibt diese Methode einen Datensatz zurück, der diese Internetheader und ihre Werte enthält. Wenn das Add-In einen Header anfordert, der nicht verfügbar ist, wird dieser Header in den Ergebnissen nicht zurückgegeben.

Hinweis: Diese Methode soll die Werte der benutzerdefinierten Header zurückgeben, die Sie mit der setAsync Methode festgelegt haben.
getAsync(names, callback)

Bei gegebener Matrix von Internetheadernamen gibt diese Methode einen Datensatz zurück, der diese Internetheader und ihre Werte enthält. Wenn das Add-In einen Header anfordert, der nicht verfügbar ist, wird dieser Header in den Ergebnissen nicht zurückgegeben.

Hinweis: Diese Methode soll die Werte der benutzerdefinierten Header zurückgeben, die Sie mit der setAsync Methode festgelegt haben.
removeAsync(names, options, callback)

Bei gegebener Matrix von Internetheadernamen entfernt diese Methode die angegebenen Header aus der Internetheaderauflistung.

Hinweis: Mit dieser Methode sollen die benutzerdefinierten Header entfernt werden, die Sie mit der setAsync Methode festgelegt haben.
removeAsync(names, callback)

Bei gegebener Matrix von Internetheadernamen entfernt diese Methode die angegebenen Header aus der Internetheaderauflistung.

Hinweis: Mit dieser Methode sollen die benutzerdefinierten Header entfernt werden, die Sie mit der setAsync Methode festgelegt haben.
setAsync(headers, options, callback)

Legt die angegebenen Internetheader auf die angegebenen Werte fest.

Die setAsync Methode erstellt einen neuen Header, wenn der angegebene Header noch nicht vorhanden ist. Andernfalls wird der vorhandene Wert durch den neuen Wert ersetzt.

Hinweis: Mit dieser Methode können Sie die Werte Ihrer benutzerdefinierten Header festlegen.
setAsync(headers, callback)

Legt die angegebenen Internetheader auf die angegebenen Werte fest.

Die setAsync Methode erstellt einen neuen Header, wenn der angegebene Header noch nicht vorhanden ist. Andernfalls wird der vorhandene Wert durch den neuen Wert ersetzt.

Hinweis: Mit dieser Methode können Sie die Werte Ihrer benutzerdefinierten Header festlegen.

Details zur Methode

getAsync(names, options, callback)

Bei gegebener Matrix von Internetheadernamen gibt diese Methode einen Datensatz zurück, der diese Internetheader und ihre Werte enthält. Wenn das Add-In einen Header anfordert, der nicht verfügbar ist, wird dieser Header in den Ergebnissen nicht zurückgegeben.

Hinweis: Diese Methode soll die Werte der benutzerdefinierten Header zurückgeben, die Sie mit der setAsync Methode festgelegt haben.

getAsync(names: string[], options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<Record<string, string>>) => void): void;

Parameter

names

string[]

Die Namen der Internetheader, die zurückgegeben werden sollen.

options
Office.AsyncContextOptions

Ein Objektliteral, das eine oder mehrere der folgenden Eigenschaften enthält: asyncContext: Entwickler können jedes Objekt, auf das sie zugreifen möchten, in der Rückruffunktion bereitstellen.

callback

(asyncResult: Office.AsyncResult<Record<string, string>>) => void

Wenn die Methode abgeschlossen ist, wird die im callback Parameter übergebene Funktion mit einem einzelnen Parameter aufgerufen, asyncResult, vom Typ Office.AsyncResult. Die Schlüssel-Wert-Zeichenfolgenpaare der Internetheader werden in der asyncResult.value Eigenschaft zurückgegeben. Alle aufgetretenen Fehler werden in der asyncResult.error Eigenschaft angegeben.

Gibt zurück

void

Hinweise

API-Satz: Postfach 1.8

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Compose

Wichtig: Die Internetheader-API wird in Outlook unter Android und unter iOS ab Version 4.2405.0 unterstützt. Weitere Informationen zu Features, die in Outlook auf Mobilgeräten unterstützt werden, finden Sie unter Outlook-JavaScript-APIs, die in Outlook auf Mobilgeräten unterstützt werden.

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/70-mime-headers/manage-custom-internet-headers-message-compose.yaml

Office.context.mailbox.item.internetHeaders.getAsync(
  ["preferred-fruit", "preferred-vegetable", "best-vegetable", "nonexistent-header"],
  function (asyncResult) {
    if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
      console.log("Selected headers: " + JSON.stringify(asyncResult.value));
    } else {
      console.log("Error getting selected headers: " + JSON.stringify(asyncResult.error));
    }
  }
);

getAsync(names, callback)

Bei gegebener Matrix von Internetheadernamen gibt diese Methode einen Datensatz zurück, der diese Internetheader und ihre Werte enthält. Wenn das Add-In einen Header anfordert, der nicht verfügbar ist, wird dieser Header in den Ergebnissen nicht zurückgegeben.

Hinweis: Diese Methode soll die Werte der benutzerdefinierten Header zurückgeben, die Sie mit der setAsync Methode festgelegt haben.

getAsync(names: string[], callback: (asyncResult: Office.AsyncResult<Record<string, string>>) => void): void;

Parameter

names

string[]

Die Namen der Internetheader, die zurückgegeben werden sollen.

callback

(asyncResult: Office.AsyncResult<Record<string, string>>) => void

Wenn die Methode abgeschlossen ist, wird die im callback Parameter übergebene Funktion mit einem einzelnen Parameter aufgerufen, asyncResult, vom Typ Office.AsyncResult. Die Schlüssel-Wert-Zeichenfolgenpaare der Internetheader werden in der asyncResult.value Eigenschaft zurückgegeben. Alle aufgetretenen Fehler werden in der asyncResult.error Eigenschaft angegeben.

Gibt zurück

void

Hinweise

API-Satz: Postfach 1.8

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Compose

Wichtig: Die Internetheader-API wird in Outlook unter Android und unter iOS ab Version 4.2405.0 unterstützt. Weitere Informationen zu Features, die in Outlook auf Mobilgeräten unterstützt werden, finden Sie unter Outlook-JavaScript-APIs, die in Outlook auf Mobilgeräten unterstützt werden.

removeAsync(names, options, callback)

Bei gegebener Matrix von Internetheadernamen entfernt diese Methode die angegebenen Header aus der Internetheaderauflistung.

Hinweis: Mit dieser Methode sollen die benutzerdefinierten Header entfernt werden, die Sie mit der setAsync Methode festgelegt haben.

removeAsync(names: string[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parameter

names

string[]

Die Namen der Internetheader, die entfernt werden sollen.

options
Office.AsyncContextOptions

Ein Objektliteral, das eine oder mehrere der folgenden Eigenschaften enthält: asyncContext: Entwickler können jedes Objekt, auf das sie zugreifen möchten, in der Rückruffunktion bereitstellen.

callback

(asyncResult: Office.AsyncResult<void>) => void

Optional. Wenn die Methode abgeschlossen ist, wird die im callback Parameter übergebene Funktion mit einem einzelnen Parameter aufgerufen, asyncResult, vom Typ Office.AsyncResult. Alle aufgetretenen Fehler werden in der asyncResult.error Eigenschaft angegeben.

Gibt zurück

void

Hinweise

API-Satz: Postfach 1.8

Mindestberechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Compose

Wichtig:

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/70-mime-headers/manage-custom-internet-headers-message-compose.yaml

Office.context.mailbox.item.internetHeaders.removeAsync(
  ["best-vegetable", "nonexistent-header"],
  function (asyncResult) {
    if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
      console.log("Successfully removed selected headers");
    } else {
      console.log("Error removing selected headers: " + JSON.stringify(asyncResult.error));
    }
  }
);

removeAsync(names, callback)

Bei gegebener Matrix von Internetheadernamen entfernt diese Methode die angegebenen Header aus der Internetheaderauflistung.

Hinweis: Mit dieser Methode sollen die benutzerdefinierten Header entfernt werden, die Sie mit der setAsync Methode festgelegt haben.

removeAsync(names: string[], callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parameter

names

string[]

Die Namen der Internetheader, die entfernt werden sollen.

callback

(asyncResult: Office.AsyncResult<void>) => void

Optional. Wenn die Methode abgeschlossen ist, wird die im callback Parameter übergebene Funktion mit einem einzelnen Parameter aufgerufen, asyncResult, vom Typ Office.AsyncResult. Alle aufgetretenen Fehler werden in der asyncResult.error Eigenschaft angegeben.

Gibt zurück

void

Hinweise

API-Satz: Postfach 1.8

Mindestberechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Compose

Wichtig:

setAsync(headers, options, callback)

Legt die angegebenen Internetheader auf die angegebenen Werte fest.

Die setAsync Methode erstellt einen neuen Header, wenn der angegebene Header noch nicht vorhanden ist. Andernfalls wird der vorhandene Wert durch den neuen Wert ersetzt.

Hinweis: Mit dieser Methode können Sie die Werte Ihrer benutzerdefinierten Header festlegen.

setAsync(headers: Record<string, string>, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parameter

headers

Record<string, string>

Die Namen und entsprechenden Werte der Header, die festgelegt werden sollen. Dies sollte ein Datensatzobjekt sein, dessen Schlüssel Internetheadernamen und Werte die entsprechenden Headerwertzeichenfolgen sind.

options
Office.AsyncContextOptions

Ein Objektliteral, das eine oder mehrere der folgenden Eigenschaften enthält: asyncContext: Entwickler können jedes Objekt, auf das sie zugreifen möchten, in der Rückruffunktion bereitstellen.

callback

(asyncResult: Office.AsyncResult<void>) => void

Optional. Wenn die Methode abgeschlossen ist, wird die im callback Parameter übergebene Funktion mit einem einzelnen Parameter aufgerufen, asyncResult, vom Typ Office.AsyncResult. Alle aufgetretenen Fehler werden in der asyncResult.error Eigenschaft angegeben.

Gibt zurück

void

Hinweise

API-Satz: Postfach 1.8

Mindestberechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Compose

Wichtig:

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/70-mime-headers/manage-custom-internet-headers-message-compose.yaml

Office.context.mailbox.item.internetHeaders.setAsync(
  { "preferred-fruit": "orange", "preferred-vegetable": "broccoli", "best-vegetable": "spinach" },
  function (asyncResult) {
    if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
      console.log("Successfully set headers");
    } else {
      console.log("Error setting headers: " + JSON.stringify(asyncResult.error));
    }
  }

);

setAsync(headers, callback)

Legt die angegebenen Internetheader auf die angegebenen Werte fest.

Die setAsync Methode erstellt einen neuen Header, wenn der angegebene Header noch nicht vorhanden ist. Andernfalls wird der vorhandene Wert durch den neuen Wert ersetzt.

Hinweis: Mit dieser Methode können Sie die Werte Ihrer benutzerdefinierten Header festlegen.

setAsync(headers: Record<string, string>, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parameter

headers

Record<string, string>

Die Namen und entsprechenden Werte der Header, die festgelegt werden sollen. Dies sollte ein Datensatzobjekt sein, dessen Schlüssel Internetheadernamen und Werte die entsprechenden Headerwertzeichenfolgen sind.

callback

(asyncResult: Office.AsyncResult<void>) => void

Optional. Wenn die Methode abgeschlossen ist, wird die im callback Parameter übergebene Funktion mit einem einzelnen Parameter aufgerufen, asyncResult, vom Typ Office.AsyncResult. Alle aufgetretenen Fehler werden in der asyncResult.error Eigenschaft angegeben.

Gibt zurück

void

Hinweise

API-Satz: Postfach 1.8

Mindestberechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Compose

Wichtig: