Office.InternetHeaders interface
Das InternetHeaders -Objekt stellt benutzerdefinierte Internetheader dar, die beibehalten werden, nachdem das Nachrichtenelement Exchange verlassen hat und in eine MIME-Nachricht konvertiert wird.
Internetheader werden als Zeichenfolgenschlüssel-Wert-Paare pro Element gespeichert.
Hinweis: Dieses Objekt ist dafür vorgesehen, dass Sie Ihre benutzerdefinierten Kopfzeilen für ein Nachrichtenelement festlegen und abrufen können. Weitere Informationen finden Sie unter Abrufen und Festlegen von Internetheadern für eine Nachricht in einem Outlook-Add-In.
Hinweise
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 mobilen Geräten unterstützt werden, finden Sie unter Outlook JavaScript-APIs, die in Outlook auf mobilen Geräten unterstützt werden.
Empfohlene Vorgehensweisen:
Derzeit sind Internetheader eine begrenzte Ressource im Postfach eines Benutzers. Wenn das Kontingent aufgebraucht ist, können Sie keine weiteren Internetheader für dieses Postfach erstellen, was zu unerwartetem Verhalten von Clients führen kann, die diese Funktion nutzen.
Wenden Sie die folgenden Richtlinien an, wenn Sie Internetheader in Ihrem Add-In erstellen.
Erstellen Sie die mindest erforderliche Anzahl von Headern. Das Headerkontingent basiert auf der Gesamtgröße der Header, die auf eine Nachricht angewendet werden. In Exchange Online ist der Headergrenzwert auf 256 KB begrenzt, während in einer lokalen Exchange-Umgebung der Grenzwert vom Administrator Ihres organization festgelegt wird. Weitere Informationen zu Headergrenzwerten finden Sie unter Exchange Online Nachrichtengrenzwerte und Exchange Server Nachrichtengrenzwerte.
Benennen Sie Header, damit Sie ihre Werte später wiederverwenden und aktualisieren können. Vermeiden Sie daher eine variable Benennung von Headern (z. B. basierend auf Benutzereingaben oder einem Zeitstempel).
Methoden
| get |
Bei einem Array von Internetheadernamen gibt diese Methode einen Datensatz zurück, der diese Internetheader und ihre Werte enthält. Wenn das Add-In einen nicht verfügbaren Header anfordert, wird dieser Header in den Ergebnissen nicht zurückgegeben.
Hinweis: Diese Methode soll die Werte der benutzerdefinierten Header zurückgeben, die Sie mithilfe der |
| get |
Bei einem Array von Internetheadernamen gibt diese Methode einen Datensatz zurück, der diese Internetheader und ihre Werte enthält. Wenn das Add-In einen nicht verfügbaren Header anfordert, wird dieser Header in den Ergebnissen nicht zurückgegeben.
Hinweis: Diese Methode soll die Werte der benutzerdefinierten Header zurückgeben, die Sie mithilfe der |
| remove |
Bei einem Array von Internetheadernamen entfernt diese Methode die angegebenen Header aus der Internetheaderauflistung.
Hinweis: Diese Methode dient zum Entfernen der benutzerdefinierten Header, die Sie mithilfe der |
| remove |
Bei einem Array von Internetheadernamen entfernt diese Methode die angegebenen Header aus der Internetheaderauflistung.
Hinweis: Diese Methode dient zum Entfernen der benutzerdefinierten Header, die Sie mithilfe der |
| set |
Legt die angegebenen Internetheader auf die angegebenen Werte fest. Die Hinweis: Diese Methode dient zum Festlegen der Werte Ihrer benutzerdefinierten Header. |
| set |
Legt die angegebenen Internetheader auf die angegebenen Werte fest. Die Hinweis: Diese Methode dient zum Festlegen der Werte Ihrer benutzerdefinierten Header. |
Details zur Methode
getAsync(names, options, callback)
Bei einem Array von Internetheadernamen gibt diese Methode einen Datensatz zurück, der diese Internetheader und ihre Werte enthält. Wenn das Add-In einen nicht verfügbaren Header anfordert, wird dieser Header in den Ergebnissen nicht zurückgegeben.
Hinweis: Diese Methode soll die Werte der benutzerdefinierten Header zurückgeben, die Sie mithilfe 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 zurückzugebenden Internetheader.
- options
- Office.AsyncContextOptions
Ein Objektliteral, das eine oder mehrere der folgenden Eigenschaften enthält: asyncContextEntwickler können jedes Objekt bereitstellen, auf das sie in der Rückruffunktion zugreifen möchten.
- callback
-
(asyncResult: Office.AsyncResult<Record<string, string>>) => void
Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter vom asyncResultTyp Office.AsyncResultaufgerufen. Die Zeichenfolgenschlüssel-Wert-Paare von Internetheadern werden in der asyncResult.value -Eigenschaft zurückgegeben. Alle aufgetretenen Fehler werden in der asyncResult.error -Eigenschaft bereitgestellt.
Gibt zurück
void
Hinweise
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 mobilen Geräten unterstützt werden, finden Sie unter Outlook JavaScript-APIs, die in Outlook auf mobilen Gerä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 einem Array von Internetheadernamen gibt diese Methode einen Datensatz zurück, der diese Internetheader und ihre Werte enthält. Wenn das Add-In einen nicht verfügbaren Header anfordert, wird dieser Header in den Ergebnissen nicht zurückgegeben.
Hinweis: Diese Methode soll die Werte der benutzerdefinierten Header zurückgeben, die Sie mithilfe der setAsync -Methode festgelegt haben.
getAsync(names: string[], callback: (asyncResult: Office.AsyncResult<Record<string, string>>) => void): void;Parameter
- names
-
string[]
Die Namen der zurückzugebenden Internetheader.
- callback
-
(asyncResult: Office.AsyncResult<Record<string, string>>) => void
Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter vom asyncResultTyp Office.AsyncResultaufgerufen. Die Zeichenfolgenschlüssel-Wert-Paare von Internetheadern werden in der asyncResult.value -Eigenschaft zurückgegeben. Alle aufgetretenen Fehler werden in der asyncResult.error -Eigenschaft bereitgestellt.
Gibt zurück
void
Hinweise
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 mobilen Geräten unterstützt werden, finden Sie unter Outlook JavaScript-APIs, die in Outlook auf mobilen Geräten unterstützt werden.
removeAsync(names, options, callback)
Bei einem Array von Internetheadernamen entfernt diese Methode die angegebenen Header aus der Internetheaderauflistung.
Hinweis: Diese Methode dient zum Entfernen der benutzerdefinierten Header, die Sie mithilfe der setAsync -Methode festlegen.
removeAsync(names: string[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;Parameter
- names
-
string[]
Die Namen der zu entfernenden Internetheader.
- options
- Office.AsyncContextOptions
Ein Objektliteral, das eine oder mehrere der folgenden Eigenschaften enthält: asyncContextEntwickler können jedes Objekt bereitstellen, auf das sie in der Rückruffunktion zugreifen möchten.
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
Optional. Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter vom asyncResultTyp Office.AsyncResultaufgerufen. Alle aufgetretenen Fehler werden in der asyncResult.error -Eigenschaft bereitgestellt.
Gibt zurück
void
Hinweise
Minimale Berechtigungsstufe: Element lesen/schreiben
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 mobilen Geräten unterstützt werden, finden Sie unter Outlook JavaScript-APIs, die in Outlook auf mobilen Gerä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.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 einem Array von Internetheadernamen entfernt diese Methode die angegebenen Header aus der Internetheaderauflistung.
Hinweis: Diese Methode dient zum Entfernen der benutzerdefinierten Header, die Sie mithilfe der setAsync -Methode festlegen.
removeAsync(names: string[], callback?: (asyncResult: Office.AsyncResult<void>) => void): void;Parameter
- names
-
string[]
Die Namen der zu entfernenden Internetheader.
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
Optional. Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter vom asyncResultTyp Office.AsyncResultaufgerufen. Alle aufgetretenen Fehler werden in der asyncResult.error -Eigenschaft bereitgestellt.
Gibt zurück
void
Hinweise
Minimale Berechtigungsstufe: Element lesen/schreiben
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 mobilen Geräten unterstützt werden, finden Sie unter Outlook JavaScript-APIs, die in Outlook auf mobilen Geräten unterstützt werden.
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: Diese Methode dient zum Festlegen der Werte Ihrer benutzerdefinierten Header.
setAsync(headers: Record<string, string>, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;Parameter
- headers
-
Record<string, string>
Die Namen und die entsprechenden Werte der festzulegenden Header. 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: asyncContextEntwickler können jedes Objekt bereitstellen, auf das sie in der Rückruffunktion zugreifen möchten.
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
Optional. Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter vom asyncResultTyp Office.AsyncResultaufgerufen. Alle aufgetretenen Fehler werden in der asyncResult.error -Eigenschaft bereitgestellt.
Gibt zurück
void
Hinweise
Minimale Berechtigungsstufe: Element lesen/schreiben
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 mobilen Geräten unterstützt werden, finden Sie unter Outlook JavaScript-APIs, die in Outlook auf mobilen Geräten unterstützt werden.
Das Headerkontingent basiert auf der Gesamtgröße der Header, die auf eine Nachricht angewendet werden. In Exchange Online ist der Headergrenzwert auf 256 KB begrenzt, während in einer lokalen Exchange-Umgebung der Grenzwert vom Administrator Ihres organization festgelegt wird. Weitere Informationen zu Headergrenzwerten finden Sie unter Exchange Online Nachrichtengrenzwerte und Exchange Server Nachrichtengrenzwerte.
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: Diese Methode dient zum Festlegen der Werte Ihrer benutzerdefinierten Header.
setAsync(headers: Record<string, string>, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;Parameter
- headers
-
Record<string, string>
Die Namen und die entsprechenden Werte der festzulegenden Header. 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 vom asyncResultTyp Office.AsyncResultaufgerufen. Alle aufgetretenen Fehler werden in der asyncResult.error -Eigenschaft bereitgestellt.
Gibt zurück
void
Hinweise
Minimale Berechtigungsstufe: Element lesen/schreiben
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 mobilen Geräten unterstützt werden, finden Sie unter Outlook JavaScript-APIs, die in Outlook auf mobilen Geräten unterstützt werden.
Das Headerkontingent basiert auf der Gesamtgröße der Header, die auf eine Nachricht angewendet werden. In Exchange Online ist der Headergrenzwert auf 256 KB begrenzt, während in einer lokalen Exchange-Umgebung der Grenzwert vom Administrator Ihres organization festgelegt wird. Weitere Informationen zu Headergrenzwerten finden Sie unter Exchange Online Nachrichtengrenzwerte und Exchange Server Nachrichtengrenzwerte.
Office Add-ins