Office.Mailbox interface
Bietet Zugriff auf das Microsoft Outlook-Add-In-Objektmodell.
Wichtige Eigenschaften:
diagnostics
: Stellt Diagnoseinformationen für ein Outlook-Add-In bereit.item
: Stellt Methoden und Eigenschaften für den Zugriff auf eine Nachricht oder einen Termin in einem Outlook-Add-In bereit.userProfile
: Stellt Informationen zum Benutzer in einem Outlook-Add-In bereit.
Hinweise
Mindestberechtigungsstufe: eingeschränkt
Anwendbarer Outlook-Modus: Compose oder Lesen
Beispiele
Office.onReady(() => {
document.addEventListener('DOMContentLoaded', () => {
// Get a reference to the mailbox and use it to add an event handler.
const mailbox = Office.context.mailbox;
mailbox.addHandlerAsync(Office.EventType.ItemChanged, loadNewItem, (result) => {
if (result.status === Office.AsyncResultStatus.Failed) {
// Handle error.
}
});
});
});
function loadNewItem(eventArgs) {
const item = Office.context.mailbox.item;
// Check that item isn't null.
if (item !== null) {
// Work with item. For example, define and call a function that
// loads the properties of the newly selected item.
loadProps(item);
}
}
Eigenschaften
diagnostics | Stellt einem Outlook-Add-In Diagnoseinformationen bereit. Enthält die folgenden Member.
Weitere Informationen findest du unter Office.Diagnostics. |
ews |
Ruft die URL des EWS-Endpunkts (Exchange Web Services) für dieses E-Mail-Konto ab. |
item | Das Postfachelement. Je nach Kontext, in dem das Add-In geöffnet wurde, kann der Elementtyp variieren. Wenn IntelliSense nur für einen bestimmten Typ oder Modus angezeigt werden soll, wandeln Sie dieses Element in eine der folgenden Elemente um: MessageCompose, MessageRead, AppointmentCompose, AppointmentRead Wichtig:
|
user |
Informationen zum Benutzer, der dem Postfach zugeordnet ist. Dies umfasst den Kontotyp, den Anzeigenamen, die E-Mail-Adresse und die Zeitzone. Weitere Informationen findest du unter Office.UserProfile. |
Methoden
convert |
Konvertiert eine unterstützte ID in das EWS-Format (Exchange-Webdienste). |
convert |
Ruft ein Wörterbuch mit Uhrzeitinformationen basierend auf der Zeiteinstellung des lokalen Clients ab. Die vom Outlook-Client verwendete Zeitzone variiert je nach Plattform. Outlook unter Windows (klassisch) und auf Mac verwendet die Zeitzone des Clientcomputers. Outlook im Web und neue Outlook unter Windows verwenden die Zeitzone, die im Exchange Admin Center (EAC) festgelegt ist. Sie sollten Datums- und Uhrzeitwerte bearbeiten, damit die auf der Benutzeroberfläche angezeigten Werte immer den von Benutzer erwarteten Zeitzonen entsprechen. In Outlook für Windows (klassisch) und auf Mac gibt die |
convert |
Konvertiert eine unterstützte ID in das REST-Format. |
convert |
Ruft ein Die |
display |
Zeigt einen bestehenden Kalendertermin an. Die In Outlook für Mac können Sie diese Methode verwenden, um einen einzelnen Termin anzuzeigen, der nicht Teil einer Serie ist, oder den master Termins einer Serie. Sie können jedoch keine instance der Reihe anzeigen, da Sie nicht auf die Eigenschaften (einschließlich der Element-ID) von Instanzen einer Serie zugreifen können. In Outlook im Web und dem neuen Outlook unter Windows öffnet diese Methode das angegebene Formular nur, wenn der Text des Formulars kleiner oder gleich 32.000 Zeichen ist. Wenn der angegebene Elementbezeichner keinen vorhandenen Termin identifiziert, wird auf dem Clientcomputer oder Gerät ein leerer Bereich geöffnet, und es wird keine Fehlermeldung zurückgegeben. |
display |
Zeigt eine vorhandene Nachricht an. Die In Outlook im Web und dem neuen Outlook unter Windows öffnet diese Methode das angegebene Formular nur, wenn der Text des Formulars kleiner oder gleich 32.000 Zeichen ist. Wenn der angegebene Elementbezeichner keine vorhandene Nachricht identifiziert, wird keine Meldung auf dem Clientcomputer angezeigt, und es wird keine Fehlermeldung zurückgegeben. |
display |
Zeigt ein Formular zum Erstellen eines neuen Kalendertermins an. Mit der In Outlook im Web und neuen Outlook unter Windows zeigt diese Methode immer ein Formular mit einem Teilnehmerfeld an. Wenn Sie keine Teilnehmer als Eingabeargumente angeben, zeigt die Methode ein Formular mit der Schaltfläche Speichern an. Wenn Sie Teilnehmer angegeben haben, enthält das Formular die Teilnehmer und eine Schaltfläche Senden. Wenn Sie in Outlook für Windows (klassisch) und auf Mac teilnehmer oder Ressourcen in den Wenn einer der Parameter die angegebenen Größenbeschränkungen überschreitet oder wenn ein unbekannter Parametername angegeben wird, wird eine Ausnahme ausgelöst. |
get |
Ruft eine Zeichenfolge ab, die einen Token enthält, der verwendet wird, um eine Anlage oder ein Element von einem Exchange Server abzurufen. Die Das Token wird als Zeichenfolge in der |
get |
Gibt true zurück, wenn das aktuelle Postfach von Microsoft Intune verwaltet wird. |
get |
Gibt true zurück, wenn die MAM-Richtlinie (Intune Mobile Application Management) eines organization einem Add-In den Zugriff auf Daten vom angegebenen Speicherort aus zulässt. |
get |
Gibt true zurück, wenn die MAM-Richtlinie (Intune Mobile Application Management) eines organization zulässt, dass ein Add-In Daten am angegebenen Speicherort speichert. |
get |
Ruft ein Token ab, das den Benutzer und das Office-Add-In identifiziert. Das Token wird als Zeichenfolge in der |
make |
Sendet eine asynchrone Anforderung an einen Exchange-Webdienstdienst (EWS) auf dem Exchange-Server, der das Postfach des Benutzers hostet. Die |
Details zur Eigenschaft
diagnostics
Stellt einem Outlook-Add-In Diagnoseinformationen bereit.
Enthält die folgenden Member.
hostName
(Zeichenfolge): Eine Zeichenfolge, die den Namen der Office-Anwendung darstellt. Es sollte einer der folgenden Werte sein:Outlook
,newOutlookWindows
,OutlookWebApp
,OutlookIOS
oder .OutlookAndroid
Hinweis: Der Wert "Outlook" wird für Outlook unter Windows (klassisch) und für Mac zurückgegeben.hostVersion
(Zeichenfolge): Eine Zeichenfolge, die die Version der Office-Anwendung oder der Exchange Server (z. B. "15.0.468.0") darstellt. Wenn das Mail-Add-In in Outlook unter Windows (klassisch), auf Mac oder auf mobilen Geräten ausgeführt wird, gibt diehostVersion
Eigenschaft die Version des Outlook-Clients zurück. In Outlook im Web und neuen Outlook unter Windows gibt die Eigenschaft die Version des Exchange Server zurück.OWAView
(MailboxEnums.OWAView
oder Zeichenfolge): Eine Enumeration (oder ein Zeichenfolgenliteral), das die aktuelle Ansicht von Outlook im Web darstellt. Wenn die Anwendung nicht Outlook im Web ist, führt der Zugriff auf diese Eigenschaft zu undefiniert. Outlook im Web verfügt über drei Ansichten (OneColumn
- angezeigt, wenn der Bildschirm schmal ist, - wird angezeigt,TwoColumns
wenn der Bildschirm breiter ist, undThreeColumns
- angezeigt, wenn der Bildschirm breit ist), die der Breite des Bildschirms und des Fensters und der Anzahl der Spalten entsprechen, die angezeigt werden können.
Weitere Informationen findest du unter Office.Diagnostics.
diagnostics: Diagnostics;
Eigenschaftswert
Hinweise
Mindestberechtigungsstufe: Element lesen
Anwendbarer Outlook-Modus: Compose oder Lesen
Ab Postfachanforderungssatz 1.5 können Sie auch die Office.context.Diagnose-Eigenschaft verwenden, um ähnliche Informationen abzurufen.
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-diagnostic-information.yaml
// This function gets a mailbox's diagnostic information, such as Outlook client and version, and logs it to the console.
const diagnostics = Office.context.mailbox.diagnostics;
console.log(`Client application: ${diagnostics.hostName}`);
console.log(`Client version: ${diagnostics.hostVersion}`);
switch (diagnostics.OWAView) {
case undefined:
console.log("Current view (Outlook on the web only): Not applicable. An Outlook desktop client is in use.");
break;
case Office.MailboxEnums.OWAView.OneColumnNarrow:
console.log("Current view (Outlook on the web only): Viewed from an older generation mobile phone");
break;
case Office.MailboxEnums.OWAView.OneColumn:
console.log("Current view (Outlook on the web only): Viewed from a newer generation mobile phone");
break;
case Office.MailboxEnums.OWAView.TwoColumns:
console.log("Current view (Outlook on the web only): Viewed from a tablet");
break;
case Office.MailboxEnums.OWAView.ThreeColumns:
console.log("Current view (Outlook on the web only): Viewed from a desktop computer");
break;
}
ewsUrl
Ruft die URL des EWS-Endpunkts (Exchange Web Services) für dieses E-Mail-Konto ab.
ewsUrl: string;
Eigenschaftswert
string
Hinweise
Mindestberechtigungsstufe: Element lesen
Anwendbarer Outlook-Modus: Compose oder Lesen
Wichtig:
Ihre App muss über die im Manifest angegebene Berechtigung zum Lesen von Elementen verfügen, um das
ewsUrl
Element im Lesemodus aufrufen zu können.Im Verfassenmodus müssen Sie die
saveAsync
-Methode aufrufen, bevor Sie denewsUrl
Member verwenden können. Ihre App muss über Lese-/Schreibberechtigungen für Elemente verfügen, um diesaveAsync
-Methode aufrufen zu können.Diese Eigenschaft wird in Outlook unter Android oder iOS nicht unterstützt. Weitere Informationen zu unterstützten APIs in Outlook Mobile finden Sie unter In Outlook unterstützte JavaScript-APIs auf mobilen Geräten.
Der
ewsUrl
Wert kann von einem Remotedienst verwendet werden, um EWS-Aufrufe an das Postfach des Benutzers zu tätigen. Sie können beispielsweise einen Remotedienst erstellen, um Anlagen aus dem ausgewählten Element abzurufen.
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/85-tokens-and-service-calls/ids-and-urls.yaml
// Get the EWS URL and EWS item ID.
console.log("EWS URL: " + Office.context.mailbox.ewsUrl);
const ewsId = Office.context.mailbox.item.itemId;
console.log("EWS item ID: " + Office.context.mailbox.item.itemId);
// Convert the EWS item ID to a REST-formatted ID.
const restId = Office.context.mailbox.convertToRestId(ewsId, Office.MailboxEnums.RestVersion.v2_0);
console.log("REST item ID: " + restId);
// Convert the REST-formatted ID back to an EWS-formatted ID.
const ewsId2 = Office.context.mailbox.convertToEwsId(restId, Office.MailboxEnums.RestVersion.v2_0);
console.log("EWS ID (from REST ID): " + ewsId2);
item
Das Postfachelement. Je nach Kontext, in dem das Add-In geöffnet wurde, kann der Elementtyp variieren. Wenn IntelliSense nur für einen bestimmten Typ oder Modus angezeigt werden soll, wandeln Sie dieses Element in eine der folgenden Elemente um:
MessageCompose, MessageRead, AppointmentCompose, AppointmentRead
Wichtig:
Beachten Sie beim Aufrufen
Office.context.mailbox.item
einer Nachricht, dass der Lesebereich im Outlook-Client aktiviert sein muss. Eine Anleitung zum Konfigurieren des Lesebereichs finden Sie unter Verwenden und Konfigurieren des Lesebereichs für die Vorschau von Nachrichten.item
kann NULL sein, wenn Das Add-In das Anheften des Aufgabenbereichs unterstützt. Ausführliche Informationen zur Behandlung finden Sie unter Implementieren eines anheftbaren Aufgabenbereichs in Outlook.
item?: Item & ItemCompose & ItemRead & Message & MessageCompose & MessageRead & Appointment & AppointmentCompose & AppointmentRead;
Eigenschaftswert
userProfile
Informationen zum Benutzer, der dem Postfach zugeordnet ist. Dies umfasst den Kontotyp, den Anzeigenamen, die E-Mail-Adresse und die Zeitzone.
Weitere Informationen findest du unter Office.UserProfile.
userProfile: UserProfile;
Eigenschaftswert
Details zur Methode
convertToEwsId(id, restVersion)
Konvertiert eine unterstützte ID in das EWS-Format (Exchange-Webdienste).
convertToEwsId(id: string, restVersion: MailboxEnums.RestVersion | string): string;
Parameter
- id
-
string
Die ID, die in das EWS-Format konvertiert werden soll. Bei dieser Zeichenfolge kann es sich um eine Element-ID handeln, die für die Outlook-REST-APIs formatiert ist, oder um eine konversations-ID, die aus Office.context.mailbox.item.conversationId
abgerufen wurde.
- restVersion
-
Office.MailboxEnums.RestVersion | string
Ein Wert, der die Version der Outlook-REST-API angibt, die zum Abrufen der Element-ID verwendet wurde.
Gibt zurück
string
Hinweise
Mindestberechtigungsstufe: eingeschränkt
Anwendbarer Outlook-Modus: Compose oder Lesen
Wichtig:
Im Oktober 2024 werden ältere Exchange-Benutzeridentitäts- und -Rückruftoken für alle Exchange Online Mandanten standardmäßig deaktiviert. Dies ist Teil der Secure Future Initiative von Microsoft, die Organisationen die Tools zur Verfügung stellt, die sie benötigen, um auf die aktuelle Bedrohungslandschaft zu reagieren. Exchange-Benutzeridentitätstoken funktionieren weiterhin für lokale Exchange-Instanzen. Die Authentifizierung geschachtelter Apps ist der empfohlene Ansatz für token in Zukunft. Weitere Informationen finden Sie in unserem Blogbeitrag und in den häufig gestellten Fragen.
Diese Methode wird in Outlook unter Android oder iOS nicht unterstützt. Weitere Informationen zu unterstützten APIs in Outlook Mobile finden Sie unter In Outlook unterstützte JavaScript-APIs auf mobilen Geräten.
Element-IDs, die über eine REST-API (z. B. Microsoft Graph) abgerufen werden, verwenden ein anderes Format als das von EWS verwendete Format. Die
convertToEwsId
-Methode konvertiert eine REST-formatierte ID in das richtige Format für EWS.
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/85-tokens-and-service-calls/ids-and-urls.yaml
// Get the EWS URL and EWS item ID.
console.log("EWS URL: " + Office.context.mailbox.ewsUrl);
const ewsId = Office.context.mailbox.item.itemId;
console.log("EWS item ID: " + Office.context.mailbox.item.itemId);
// Convert the EWS item ID to a REST-formatted ID.
const restId = Office.context.mailbox.convertToRestId(ewsId, Office.MailboxEnums.RestVersion.v2_0);
console.log("REST item ID: " + restId);
// Convert the REST-formatted ID back to an EWS-formatted ID.
const ewsId2 = Office.context.mailbox.convertToEwsId(restId, Office.MailboxEnums.RestVersion.v2_0);
console.log("EWS ID (from REST ID): " + ewsId2);
convertToLocalClientTime(timeValue)
Ruft ein Wörterbuch mit Uhrzeitinformationen basierend auf der Zeiteinstellung des lokalen Clients ab.
Die vom Outlook-Client verwendete Zeitzone variiert je nach Plattform. Outlook unter Windows (klassisch) und auf Mac verwendet die Zeitzone des Clientcomputers. Outlook im Web und neue Outlook unter Windows verwenden die Zeitzone, die im Exchange Admin Center (EAC) festgelegt ist. Sie sollten Datums- und Uhrzeitwerte bearbeiten, damit die auf der Benutzeroberfläche angezeigten Werte immer den von Benutzer erwarteten Zeitzonen entsprechen.
In Outlook für Windows (klassisch) und auf Mac gibt die convertToLocalClientTime
Methode ein Wörterbuchobjekt mit den Werten zurück, die auf die Zeitzone des Clientcomputers festgelegt sind. In Outlook im Web und dem neuen Outlook unter Windows gibt die convertToLocalClientTime
Methode ein Wörterbuchobjekt mit den Werten zurück, die auf die im EAC angegebene Zeitzone festgelegt sind.
convertToLocalClientTime(timeValue: Date): LocalClientTime;
Parameter
- timeValue
-
Date
Ein Date
-Objekt.
Gibt zurück
Hinweise
Mindestberechtigungsstufe: Element lesen
Anwendbarer Outlook-Modus: Compose oder Lesen
convertToRestId(id, restVersion)
Konvertiert eine unterstützte ID in das REST-Format.
convertToRestId(id: string, restVersion: MailboxEnums.RestVersion | string): string;
Parameter
- id
-
string
Die ID, die in das REST-Format konvertiert werden soll. Bei dieser Zeichenfolge kann es sich um eine Element-ID handeln, die für EWS formatiert ist und normalerweise von Office.context.mailbox.item.itemId
abgerufen wird, eine Konversations-ID, die vonOffice.context.mailbox.item.conversationId
abgerufen wird, oder eine Serien-ID, die von Office.context.mailbox.item.seriesId
abgerufen wird.
- restVersion
-
Office.MailboxEnums.RestVersion | string
Ein Wert, der die Version der Outlook-REST-API angibt, die mit der konvertierten ID verwendet wird.
Gibt zurück
string
Hinweise
Mindestberechtigungsstufe: eingeschränkt
Anwendbarer Outlook-Modus: Compose oder Lesen
Wichtig:
Diese Methode wird in Outlook unter Android oder iOS nicht unterstützt. Weitere Informationen zu unterstützten APIs in Outlook Mobile finden Sie unter In Outlook unterstützte JavaScript-APIs auf mobilen Geräten.
Element-IDs, die über Exchange-Webdienste (EWS) oder über die
itemId
-Eigenschaft abgerufen werden, verwenden ein anderes Format als das format, das von REST-APIs (z. B. Microsoft Graph) verwendet wird. DieconvertToRestId
-Methode konvertiert eine EWS-formatierte ID in das richtige Format für REST.
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/85-tokens-and-service-calls/ids-and-urls.yaml
// Get the EWS URL and EWS item ID.
console.log("EWS URL: " + Office.context.mailbox.ewsUrl);
const ewsId = Office.context.mailbox.item.itemId;
console.log("EWS item ID: " + Office.context.mailbox.item.itemId);
// Convert the EWS item ID to a REST-formatted ID.
const restId = Office.context.mailbox.convertToRestId(ewsId, Office.MailboxEnums.RestVersion.v2_0);
console.log("REST item ID: " + restId);
// Convert the REST-formatted ID back to an EWS-formatted ID.
const ewsId2 = Office.context.mailbox.convertToEwsId(restId, Office.MailboxEnums.RestVersion.v2_0);
console.log("EWS ID (from REST ID): " + ewsId2);
convertToUtcClientTime(input)
Ruft ein Date
-Objekt aus einem Wörterbuch ab, das Zeitinformationen enthält.
Die convertToUtcClientTime
-Methode konvertiert ein Wörterbuch, das ein lokales Datum und eine lokale Uhrzeit enthält, in ein Date
-Objekt mit den richtigen Werten für das lokale Datum und die lokale Uhrzeit.
convertToUtcClientTime(input: LocalClientTime): Date;
Parameter
- input
- Office.LocalClientTime
Der zu konvertierende Wert für die lokale Uhrzeit.
Gibt zurück
Date
Ein Date-Objekt der Uhrzeit in UTC.
Hinweise
Mindestberechtigungsstufe: Element lesen
Anwendbarer Outlook-Modus: Compose oder Lesen
Beispiele
// Represents 3:37 PM PDT on Monday, August 26, 2019.
const input = {
date: 26,
hours: 15,
milliseconds: 2,
minutes: 37,
month: 7,
seconds: 2,
timezoneOffset: -420,
year: 2019
};
// result should be a Date object.
const result = Office.context.mailbox.convertToUtcClientTime(input);
// Output should be "2019-08-26T22:37:02.002Z".
console.log(result.toISOString());
displayAppointmentForm(itemId)
Zeigt einen bestehenden Kalendertermin an.
Die displayAppointmentForm
-Methode öffnet einen vorhandenen Kalendertermin in einem neuen Fenster auf dem Desktop.
In Outlook für Mac können Sie diese Methode verwenden, um einen einzelnen Termin anzuzeigen, der nicht Teil einer Serie ist, oder den master Termins einer Serie. Sie können jedoch keine instance der Reihe anzeigen, da Sie nicht auf die Eigenschaften (einschließlich der Element-ID) von Instanzen einer Serie zugreifen können.
In Outlook im Web und dem neuen Outlook unter Windows öffnet diese Methode das angegebene Formular nur, wenn der Text des Formulars kleiner oder gleich 32.000 Zeichen ist.
Wenn der angegebene Elementbezeichner keinen vorhandenen Termin identifiziert, wird auf dem Clientcomputer oder Gerät ein leerer Bereich geöffnet, und es wird keine Fehlermeldung zurückgegeben.
displayAppointmentForm(itemId: string): void;
Parameter
- itemId
-
string
Der EWS-Bezeichner (Exchange Web Services, Exchange-Webdienste) für einen vorhandenen Kalendertermin.
Gibt zurück
void
Hinweise
Mindestberechtigungsstufe: Element lesen
Anwendbarer Outlook-Modus: Compose oder Lesen
Wichtig: Diese Methode wird in Outlook unter Android oder iOS nicht unterstützt. Weitere Informationen zu unterstützten APIs in Outlook Mobile finden Sie unter In Outlook unterstützte JavaScript-APIs auf mobilen Geräten.
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/55-display-items/display-existing-appointment.yaml
const itemId = $("#itemId").val();
Office.context.mailbox.displayAppointmentForm(itemId);
displayMessageForm(itemId)
Zeigt eine vorhandene Nachricht an.
Die displayMessageForm
-Methode öffnet eine vorhandene Nachricht in einem neuen Fenster auf dem Desktop.
In Outlook im Web und dem neuen Outlook unter Windows öffnet diese Methode das angegebene Formular nur, wenn der Text des Formulars kleiner oder gleich 32.000 Zeichen ist.
Wenn der angegebene Elementbezeichner keine vorhandene Nachricht identifiziert, wird keine Meldung auf dem Clientcomputer angezeigt, und es wird keine Fehlermeldung zurückgegeben.
displayMessageForm(itemId: string): void;
Parameter
- itemId
-
string
Der Exchange-Webdienste (EWS) für eine vorhandene Nachricht.
Gibt zurück
void
Hinweise
Mindestberechtigungsstufe: Element lesen
Anwendbarer Outlook-Modus: Compose oder Lesen
Wichtig:
Diese Methode wird in Outlook unter Android oder iOS nicht unterstützt. Weitere Informationen zu unterstützten APIs in Outlook Mobile finden Sie unter In Outlook unterstützte JavaScript-APIs auf mobilen Geräten.
Verwenden Sie nicht mit
displayMessageForm
einer itemId, die einen Termin darstellt. Verwenden Sie diedisplayAppointmentForm
-Methode, um einen vorhandenen Termin anzuzeigen, unddisplayNewAppointmentForm
, um ein Formular zum Erstellen eines neuen Termins anzuzeigen.
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/55-display-items/display-existing-message.yaml
const itemId = $("#itemId").val();
Office.context.mailbox.displayMessageForm(itemId);
displayNewAppointmentForm(parameters)
Zeigt ein Formular zum Erstellen eines neuen Kalendertermins an.
Mit der displayNewAppointmentForm
-Methode wird ein Formular geöffnet, mit dem der Benutzer einen neuen Termin oder eine Besprechung erstellen kann. Wenn Parameter angegeben wurden, werden die Felder im Terminformular automatisch mit dem Inhalt der Parameter ausgefüllt.
In Outlook im Web und neuen Outlook unter Windows zeigt diese Methode immer ein Formular mit einem Teilnehmerfeld an. Wenn Sie keine Teilnehmer als Eingabeargumente angeben, zeigt die Methode ein Formular mit der Schaltfläche Speichern an. Wenn Sie Teilnehmer angegeben haben, enthält das Formular die Teilnehmer und eine Schaltfläche Senden.
Wenn Sie in Outlook für Windows (klassisch) und auf Mac teilnehmer oder Ressourcen in den requiredAttendees
Parametern , optionalAttendees
oder resources
angeben, zeigt diese Methode ein Besprechungsformular mit der Schaltfläche Senden an. Wenn keine Teilnehmer angegeben werden, wird mit dieser Methode ein Terminformular mit der Schaltfläche Speichern & schließen angezeigt.
Wenn einer der Parameter die angegebenen Größenbeschränkungen überschreitet oder wenn ein unbekannter Parametername angegeben wird, wird eine Ausnahme ausgelöst.
displayNewAppointmentForm(parameters: AppointmentForm): void;
Parameter
- parameters
- Office.AppointmentForm
Eine AppointmentForm
, die den neuen Termin beschreibt. Alle Eigenschaften sind optional.
Gibt zurück
void
Hinweise
Mindestberechtigungsstufe: Element lesen
Anwendbarer Outlook-Modus: Lesen
Wichtig: Diese Methode wird in Outlook unter Android oder iOS nicht unterstützt. Weitere Informationen zu unterstützten APIs in Outlook Mobile finden Sie unter In Outlook unterstützte JavaScript-APIs auf mobilen Geräten.
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/55-display-items/display-new-appointment.yaml
const start = new Date();
const end = new Date();
end.setHours(start.getHours() + 1);
Office.context.mailbox.displayNewAppointmentForm({
requiredAttendees: ["bob@contoso.com"],
optionalAttendees: ["sam@contoso.com"],
start: start,
end: end,
location: "Home",
subject: "meeting",
resources: ["projector@contoso.com"],
body: "Hello World!"
});
getCallbackTokenAsync(callback, userContext)
Ruft eine Zeichenfolge ab, die einen Token enthält, der verwendet wird, um eine Anlage oder ein Element von einem Exchange Server abzurufen.
Die getCallbackTokenAsync
-Methode führt einen asynchronen Aufruf zum Abruf eines nicht transparenten Tokens vom Exchange-Server aus, der das Postfach des Benutzers hostet. Die Gültigkeitsdauer des Rückruftokens beträgt 5 Minuten.
Das Token wird als Zeichenfolge in der asyncResult.value
-Eigenschaft zurückgegeben.
getCallbackTokenAsync(callback: (asyncResult: Office.AsyncResult<string>) => void, userContext?: any): void;
Parameter
- callback
-
(asyncResult: Office.AsyncResult<string>) => void
Wenn die Methode abgeschlossen ist, wird die im Rückrufparameter übergebene Funktion mit einem einzelnen Parameter vom Typ Office.AsyncResult
aufgerufen. Das Token wird als Zeichenfolge in der asyncResult.value
-Eigenschaft zurückgegeben. Wenn ein Fehler aufgetreten ist, können die Eigenschaften asyncResult.error
und asyncResult.diagnostics
weitere Informationen enthalten.
- userContext
-
any
Optional. Jegliche Zustandsdaten, die an die asynchrone Methode übergeben werden.
Gibt zurück
void
Hinweise
[ API-Satz: Alle unterstützen den Lesemodus; Mailbox 1.3 wurde Compose-Modus-Unterstützung eingeführt ]
Mindestberechtigungsstufe: Element lesen
Anwendbarer Outlook-Modus: Compose oder Lesen
Wichtig:
Im Oktober 2024 werden ältere Exchange-Benutzeridentitäts- und -Rückruftoken für alle Exchange Online Mandanten standardmäßig deaktiviert. Dies ist Teil der Secure Future Initiative von Microsoft, die Organisationen die Tools zur Verfügung stellt, die sie benötigen, um auf die aktuelle Bedrohungslandschaft zu reagieren. Exchange-Benutzeridentitätstoken funktionieren weiterhin für lokale Exchange-Instanzen. Die Authentifizierung geschachtelter Apps ist der empfohlene Ansatz für token in Zukunft. Weitere Informationen finden Sie in unserem Blogbeitrag und in den häufig gestellten Fragen.
Sie können sowohl das Token als auch einen Anlagenbezeichner oder einen Elementbezeichner an ein externes System übergeben. Dieses System verwendet das Token als Bearerautorisierungstoken, um den EwS-Vorgang (Exchange Web Services) GetAttachment oder GetItem aufzurufen, um eine Anlage oder ein Element zurückzugeben. Sie können beispielsweise einen Remotedienst erstellen, um Anlagen aus dem ausgewählten Element abzurufen.
Für das Aufrufen der
getCallbackTokenAsync
Methode im Lesemodus ist eine Mindestberechtigungsstufe für das Lesen von Elementen erforderlich.Wenn Sie die
getCallbackTokenAsync
-Methode im Verfassenmodus aufrufen, müssen Sie das Element gespeichert haben. DiesaveAsync
-Methode erfordert eine Mindestberechtigungsstufe für Lese-/Schreibzugriff.Diese Methode wird in Outlook unter Android oder iOS nicht unterstützt. EWS-Vorgänge werden in Add-Ins, die in Outlook auf mobilen Clients ausgeführt werden, nicht unterstützt. Weitere Informationen zu unterstützten APIs in Outlook Mobile finden Sie unter In Outlook unterstützte JavaScript-APIs auf mobilen Geräten.
Diese Methode wird nicht unterstützt, wenn Sie ein Add-In in ein Outlook.com- oder Gmail-Postfach laden.
Anleitungen zu Delegat- oder freigegebenen Szenarien finden Sie im Artikel freigegebene Ordner und freigegebene Postfächer .
Fehler:
HTTPRequestFailure
: Fehler bei der Anforderung. Den HTTP-Fehlercode finden Sie im Diagnoseobjekt.InternalServerError
: Der Exchange-Server hat einen Fehler zurückgegeben. Weitere Informationen finden Sie im Diagnoseobjekt.NetworkError
: Der Benutzer ist nicht mehr mit dem Netzwerk verbunden. Überprüfen Sie Ihre Netzwerkverbindung, und versuchen Sie es erneut.
getIsIdentityManaged()
Gibt true zurück, wenn das aktuelle Postfach von Microsoft Intune verwaltet wird.
getIsIdentityManaged(): boolean;
Gibt zurück
boolean
True, wenn das aktuelle Postfach von Microsoft Intune verwaltet wird.
Hinweise
Mindestberechtigungsstufe: Element lesen
Anwendbarer Outlook-Modus: Compose, Lesen
Wichtig: Diese Methode wird nur in Outlook unter Android und unter iOS unterstützt, ab Version 4.2443.0.To weitere Informationen zu apIs, 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.
Fehler:
-
MAMServiceNotAvailable
: Der Client kann die Mam-Richtlinie (Mobile Application Management, Verwaltung mobiler Anwendungen) nicht abrufen.
getIsOpenFromLocationAllowed(openLocation)
Gibt true zurück, wenn die MAM-Richtlinie (Intune Mobile Application Management) eines organization einem Add-In den Zugriff auf Daten vom angegebenen Speicherort aus zulässt.
getIsOpenFromLocationAllowed(openLocation: MailboxEnums.OpenLocation): boolean;
Parameter
- openLocation
- Office.MailboxEnums.OpenLocation
Der Speicherort, von dem aus das Add-In versucht, auf Daten zuzugreifen.
Gibt zurück
boolean
True, wenn die Intune MAM-Richtlinie eines organization einem Add-In den Zugriff auf Daten vom angegebenen Speicherort aus zulässt.
Hinweise
Mindestberechtigungsstufe: Element lesen
Anwendbarer Outlook-Modus: Compose, Lesen
Wichtig: Diese Methode wird nur in Outlook unter Android und unter iOS ab Version 4.2443.0 unterstützt. Weitere Informationen zu apIs, die in Outlook auf mobilen Geräten unterstützt werden, finden Sie unter In Outlook auf mobilen Geräten unterstützte JavaScript-APIs.
Fehler:
InvalidOpenLocationInput
: Der Wert des angegebenen Speicherorts ist ungültig.MAMServiceNotAvailable
: Der Client kann die MAM-Richtlinie nicht abrufen.
getIsSaveToLocationAllowed(saveLocation)
Gibt true zurück, wenn die MAM-Richtlinie (Intune Mobile Application Management) eines organization zulässt, dass ein Add-In Daten am angegebenen Speicherort speichert.
getIsSaveToLocationAllowed(saveLocation: MailboxEnums.SaveLocation): boolean;
Parameter
- saveLocation
- Office.MailboxEnums.SaveLocation
Der Speicherort, an dem das Add-In versucht, Daten zu speichern.
Gibt zurück
boolean
True, wenn die Intune MAM-Richtlinie eines organization einem Add-In das Speichern von Daten am angegebenen Speicherort zulässt.
Hinweise
Mindestberechtigungsstufe: Element lesen
Anwendbarer Outlook-Modus: Compose, Lesen
Wichtig: Diese Methode wird nur in Outlook unter Android und unter iOS ab Version 4.2443.0 unterstützt. Weitere Informationen zu apIs, die in Outlook auf mobilen Geräten unterstützt werden, finden Sie unter In Outlook auf mobilen Geräten unterstützte JavaScript-APIs.
Fehler:
InvalidSaveLocationInput
: Der Wert des angegebenen Speicherorts ist ungültig.MAMServiceNotAvailable
: Der Client kann die MAM-Richtlinie nicht abrufen.
getUserIdentityTokenAsync(callback, userContext)
Ruft ein Token ab, das den Benutzer und das Office-Add-In identifiziert.
Das Token wird als Zeichenfolge in der asyncResult.value
-Eigenschaft zurückgegeben.
getUserIdentityTokenAsync(callback: (asyncResult: Office.AsyncResult<string>) => void, userContext?: any): void;
Parameter
- callback
-
(asyncResult: Office.AsyncResult<string>) => void
Wenn die Methode abgeschlossen ist, wird die im Rückrufparameter übergebene Funktion mit einem einzelnen Parameter vom Typ Office.AsyncResult
aufgerufen. Das Token wird als Zeichenfolge in der asyncResult.value
-Eigenschaft zurückgegeben. Wenn ein Fehler aufgetreten ist, können die Eigenschaften asyncResult.error
und asyncResult.diagnostics
weitere Informationen enthalten.
- userContext
-
any
Optional. Jegliche Zustandsdaten, die an die asynchrone Methode übergeben werden.
Gibt zurück
void
Hinweise
Mindestberechtigungsstufe: Element lesen
Anwendbarer Outlook-Modus: Compose oder Lesen
Wichtig:
Im Oktober 2024 werden ältere Exchange-Benutzeridentitäts- und -Rückruftoken für alle Exchange Online Mandanten standardmäßig deaktiviert. Dies ist Teil der Secure Future Initiative von Microsoft, die Organisationen die Tools zur Verfügung stellt, die sie benötigen, um auf die aktuelle Bedrohungslandschaft zu reagieren. Exchange-Benutzeridentitätstoken funktionieren weiterhin für lokale Exchange-Instanzen. Die Authentifizierung geschachtelter Apps ist der empfohlene Ansatz für token in Zukunft. Weitere Informationen finden Sie in unserem Blogbeitrag und in den häufig gestellten Fragen.
Die
getUserIdentityTokenAsync
Methode gibt ein Token zurück, das Sie verwenden können, um das Add-In und den Benutzer mit einem externen System zu identifizieren und zu authentifizieren.Diese Methode wird nicht unterstützt, wenn Sie ein Add-In in ein Outlook.com- oder Gmail-Postfach laden.
Fehler:
HTTPRequestFailure
: Fehler bei der Anforderung. Den HTTP-Fehlercode finden Sie im Diagnoseobjekt.InternalServerError
: Der Exchange-Server hat einen Fehler zurückgegeben. Weitere Informationen finden Sie im Diagnoseobjekt.NetworkError
: Der Benutzer ist nicht mehr mit dem Netzwerk verbunden. Überprüfen Sie Ihre Netzwerkverbindung, und versuchen Sie es erneut.
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/85-tokens-and-service-calls/user-identity-token.yaml
Office.context.mailbox.getUserIdentityTokenAsync((result) => {
if (result.status === Office.AsyncResultStatus.Failed) {
console.error(`Token retrieval failed with message: ${result.error.message}`)
return;
}
console.log(result.value);
});
makeEwsRequestAsync(data, callback, userContext)
Sendet eine asynchrone Anforderung an einen Exchange-Webdienstdienst (EWS) auf dem Exchange-Server, der das Postfach des Benutzers hostet.
Die makeEwsRequestAsync
-Methode sendet eine EWS-Anforderung für das Add-In zu Exchange.
makeEwsRequestAsync(data: any, callback: (asyncResult: Office.AsyncResult<string>) => void, userContext?: any): void;
Parameter
- data
-
any
Die EWS-Anforderung.
- callback
-
(asyncResult: Office.AsyncResult<string>) => void
Wenn die -Methode abgeschlossen ist, wird die im callback
-Parameter übergebene Funktion mit einem einzelnen Parameter aufgerufen, asyncResult
, der ein Office.AsyncResult
-Objekt ist. Die XML-Antwort der EWS-Anforderung wird als Zeichenfolge in der asyncResult.value
-Eigenschaft bereitgestellt. In Outlook im Web, unter Windows (neu und klassisch(ab Version 2303, Build 16225.10000)) und unter Mac (ab Version 16.73 (23042601)) wird eine Fehlermeldung zurückgegebenasyncResult.error
, wenn die Antwort eine Größe von 5 MB überschreitet. In früheren Versionen von Outlook unter Windows (klassisch) und auf Mac wird eine Fehlermeldung zurückgegeben, wenn die Antwort eine Größe von 1 MB überschreitet.
- userContext
-
any
Optional. Jegliche Zustandsdaten, die an die asynchrone Methode übergeben werden.
Gibt zurück
void
Hinweise
Minimale Berechtigungsstufe: Postfach lesen/schreiben
Anwendbarer Outlook-Modus: Compose oder Lesen
Wichtig:
Im Oktober 2024 werden ältere Exchange-Benutzeridentitäts- und -Rückruftoken für alle Exchange Online Mandanten standardmäßig deaktiviert. Dies ist Teil der Secure Future Initiative von Microsoft, die Organisationen die Tools zur Verfügung stellt, die sie benötigen, um auf die aktuelle Bedrohungslandschaft zu reagieren. Exchange-Benutzeridentitätstoken funktionieren weiterhin für lokale Exchange-Instanzen. Die Authentifizierung geschachtelter Apps ist der empfohlene Ansatz für token in Zukunft. Weitere Informationen finden Sie in unserem Blogbeitrag und in den häufig gestellten Fragen.
Um die
makeEwsRequestAsync
-Methode für EWS-Anforderungen zu aktivieren, muss der Serveradministrator im EWS-Verzeichnis des Clientzugriffsservers auftrue
festlegenOAuthAuthentication
.Ihr Add-In muss über die Berechtigung zum Lesen/Schreiben des Postfachs verfügen, um die
makeEwsRequestAsync
-Methode verwenden zu können. Informationen zur Verwendung der Lese-/Schreibberechtigung für Postfächer und zu den EWS-Vorgängen, die Sie mit dermakeEwsRequestAsync
-Methode aufrufen können, finden Sie unter Angeben von Berechtigungen für den E-Mail-Add-In-Zugriff auf das Postfach des Benutzers.Wenn Ihr Add-In auf Ordner zugeordnete Elemente zugreifen muss oder seine XML-Anforderung UTF-8-Codierung (
\<?xml version="1.0" encoding="utf-8"?\>
) angeben muss, muss es stattdessen Microsoft Graph- oder REST-APIs verwenden, um auf das Postfach des Benutzers zuzugreifen.Diese Methode wird in Outlook unter Android oder iOS nicht unterstützt. Weitere Informationen zu unterstützten APIs in Outlook Mobile finden Sie unter In Outlook unterstützte JavaScript-APIs auf mobilen Geräten.
Diese Methode wird nicht unterstützt, wenn das Add-In in ein Gmail-Postfach geladen wird.
Wenn Sie die
makeEwsRequestAsync
-Methode in Add-Ins verwenden, die in Outlook-Versionen vor Version 15.0.4535.1004 ausgeführt werden, müssen Sie den Codierungswert auf ISO-8859-1 (<?xml version="1.0" encoding="iso-8859-1"?>
) festlegen. Verwenden Sie die -Eigenschaft, um diemailbox.diagnostics.hostVersion
Version eines Outlook-Clients zu bestimmen. Sie müssen den Codierungswert nicht festlegen, wenn Ihr Add-In in Outlook im Web oder in outlook unter Windows ausgeführt wird. Verwenden Sie die -Eigenschaft, um den Outlook-Client zu bestimmen, in demmailbox.diagnostics.hostName
ihr Add-In ausgeführt wird.
Beispiele
function getSubjectRequest(id) {
// Return a GetItem operation request for the subject of the specified item.
const request =
'<?xml version="1.0" encoding="utf-8"?>' +
'<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"' +
' xmlns:xsd="http://www.w3.org/2001/XMLSchema"' +
' xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"' +
' xmlns:t="http://schemas.microsoft.com/exchange/services/2006/types">' +
' <soap:Header>' +
' <RequestServerVersion Version="Exchange2016" xmlns="http://schemas.microsoft.com/exchange/services/2006/types" soap:mustUnderstand="0" />' +
' </soap:Header>' +
' <soap:Body>' +
' <GetItem xmlns="http://schemas.microsoft.com/exchange/services/2006/messages">' +
' <ItemShape>' +
' <t:BaseShape>IdOnly</t:BaseShape>' +
' <t:AdditionalProperties>' +
' <t:FieldURI FieldURI="item:Subject"/>' +
' </t:AdditionalProperties>' +
' </ItemShape>' +
' <ItemIds><t:ItemId Id="' + id + '"/></ItemIds>' +
' </GetItem>' +
' </soap:Body>' +
'</soap:Envelope>';
return request;
}
function sendRequest() {
// Create a local variable that contains the mailbox.
Office.context.mailbox.makeEwsRequestAsync(
getSubjectRequest(mailbox.item.itemId), callback);
}
function callback(asyncResult) {
const result = asyncResult.value;
const context = asyncResult.asyncContext;
// Process the returned response here.
}
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/85-tokens-and-service-calls/get-icaluid-as-attendee.yaml
const ewsId = Office.context.mailbox.item.itemId;
const request = `<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:m="http://schemas.microsoft.com/exchange/services/2006/messages" xmlns:t="http://schemas.microsoft.com/exchange/services/2006/types" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header><t:RequestServerVersion Version="Exchange2013" /></soap:Header>
<soap:Body>
<m:GetItem>
<m:ItemShape>
<t:BaseShape>AllProperties</t:BaseShape>
</m:ItemShape >
<m:ItemIds>
<t:ItemId Id="${ewsId}" />
</m:ItemIds>
</m:GetItem>
</soap:Body>
</soap:Envelope>`;
Office.context.mailbox.makeEwsRequestAsync(request, (result) => {
if (result.status === Office.AsyncResultStatus.Failed) {
console.error(result.error.message);
return;
}
console.log(getUID(result.value));
});
...
const request = '<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:m="http://schemas.microsoft.com/exchange/services/2006/messages" xmlns:t="http://schemas.microsoft.com/exchange/services/2006/types" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">'+
' <soap:Header><t:RequestServerVersion Version="Exchange2010" /></soap:Header>'+
' <soap:Body>'+
' <m:CreateItem MessageDisposition="SendAndSaveCopy">'+
' <m:SavedItemFolderId><t:DistinguishedFolderId Id="sentitems" /></m:SavedItemFolderId>'+
' <m:Items>'+
' <t:Message>'+
' <t:Subject>Hello, Outlook!</t:Subject>'+
' <t:Body BodyType="HTML">This message was sent from a ScriptLab code sample, used from ' + Office.context.mailbox.diagnostics.hostName + ', version ' + Office.context.mailbox.diagnostics.hostVersion + '!</t:Body>'+
' <t:ToRecipients>'+
' <t:Mailbox><t:EmailAddress>' + Office.context.mailbox.userProfile.emailAddress + '</t:EmailAddress></t:Mailbox>'+
' </t:ToRecipients>'+
' </t:Message>'+
' </m:Items>'+
' </m:CreateItem>'+
' </soap:Body>'+
'</soap:Envelope>';
Office.context.mailbox.makeEwsRequestAsync(request, (result) => {
console.log(result);
});
Office Add-ins