Office. Appointment Read interface

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminteilnehmer

Beispiele

// This example gets the body of the item as plain text.
Office.context.mailbox.item.body.getAsync(
    Office.CoercionType.Text,
    { asyncContext: "This is passed to the callback" },
    (result) => {
        // Do something with the result.
    }
);

// The following is an example of the result parameter passed to the callback function.
{
    "value": "TEXT of whole body (including message threads that appear below the current body)",
    "status": "succeeded",
    "asyncContext": "This is passed to the callback"
}

dateTimeCreated

Ruft das Datum und die Uhrzeit der Erstellung eines Elements ab.

dateTimeCreated: Date;

Eigenschaftswert

Date

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminteilnehmer

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-date-time-created-read.yaml

console.log(`Creation date and time: ${Office.context.mailbox.item.dateTimeCreated}`);

dateTimeModified

Ruft das Datum und die Uhrzeit der letzten Änderung eines Elements ab.

dateTimeModified: Date;

Eigenschaftswert

Date

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminteilnehmer

Wichtig: 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.

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-date-time-modified-read.yaml

console.log(`Date and time item last modified: ${Office.context.mailbox.item.dateTimeModified}`);

end

Ruft das Datum und die Uhrzeit ab, zu dem der Termin beendet werden soll.

Die end -Eigenschaft ist ein Date Objekt, das als UTC-Datums- und Uhrzeitwert (Coordinated Universal Time) ausgedrückt wird. Sie können die convertToLocalClientTime -Methode verwenden, um den end Eigenschaftswert in das lokale Datum und die lokale Uhrzeit des Clients zu konvertieren.

Wenn Sie die Time.setAsync-Methode verwenden, um die Endzeit im Verfassenmodus festzulegen, sollten Sie die convertToUtcClientTime-Methode verwenden, um die Ortszeit auf dem Client für den Server in UTC umzuwandeln.

end: Date;

Eigenschaftswert

Date

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminteilnehmer

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-end-read.yaml

console.log(`Appointment ends: ${Office.context.mailbox.item.end}`);

enhancedLocation

Ruft die Speicherorte eines Termins ab.

Die enhancedLocation -Eigenschaft gibt ein EnhancedLocation-Objekt zurück, mit dem Sie den Satz von Speicherorten (die jeweils durch ein LocationDetails-Objekt dargestellt werden) abrufen können, die dem Termin zugeordnet sind.

enhancedLocation: EnhancedLocation;

Eigenschaftswert

Office.EnhancedLocation

Hinweise

Office.EmailAddressDetails[]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminteilnehmer

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-add-remove-enhancedlocation-appointment.yaml

Office.context.mailbox.item.enhancedLocation.getAsync((result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Failed to get locations. Error message: ${result.error.message}`);
    return;
  }
  const places = result.value;
  if (places && places.length > 0) {
    result.value.forEach(function(place) {
      console.log(`Location: ${place.displayName} (type: ${place.locationIdentifier.type})`);
      if (place.locationIdentifier.type === Office.MailboxEnums.LocationType.Room) {
        console.log("Email address: " + place.emailAddress);
      }
    });
  } else {
    console.log("There are no locations.");
  }
});

isAllDayEvent

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Gibt einen booleschen Wert zurück, der angibt, ob das Ereignis den ganzen Tag ist.

isAllDayEvent: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: Postfachvorschau ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminteilnehmer

Beispiele

const isAllDayEvent = Office.context.mailbox.item.isAllDayEvent;
console.log("Is this an all-day event? " + isAllDayEvent);

itemClass

Ruft die Exchange Web Services-Elementklasse des ausgewählten Termins ab.

Gibt für nicht wiederkehrende Termine und IPM.Appointment.Occurrence für Terminserien zurückIPM.Appointment.

itemClass: string;

Eigenschaftswert

string

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminteilnehmer

Wichtig: Sie können benutzerdefinierte Klassen erstellen, die eine Standardelementklasse erweitern. Beispiel: IPM.Appointment.Contoso.

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-item-class-read.yaml

console.log(`Item class: ${Office.context.mailbox.item.itemClass}`);

itemId

Ruft den EWS-Elementbezeichner (Exchange Web Services) des aktuellen Elements ab.

itemId: string;

Eigenschaftswert

string

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminteilnehmer

Wichtig:

Die itemId Eigenschaft ist im Verfassenmodus nicht verfügbar. Wenn ein Elementbezeichner erforderlich ist, kann die Office.context.mailbox.item.saveAsync -Methode verwendet werden, um das Element im Speicher zu speichern, der den Elementbezeichner im asyncResult.value Parameter in der Rückruffunktion zurückgibt. Wenn das Element bereits gespeichert ist, können Sie stattdessen die Office.context.mailbox.item.getItemIdAsync -Methode aufrufen.
Die zurückgegebene Element-ID ist nicht mit der Outlook-Eintrags-ID oder der id identisch, die von der Outlook-REST-API verwendet wird. Bevor Sie REST-API-Aufrufe mit diesem Wert ausführen, sollte sie mit Office.context.mailbox.convertToRestIdkonvertiert werden.

Beispiele

// The following code checks for the presence of an item
// identifier. If the `itemId` property returns `null` or
// `undefined`, it saves the item to the store and gets the
// item identifier from the asynchronous result.
// **Important**: `saveAsync` was introduced with requirement set 1.3
// so you can't get the `itemId` in Compose mode in earlier sets.
let itemId = Office.context.mailbox.item.itemId;
if (itemId === null || itemId == undefined) {
    Office.context.mailbox.item.saveAsync(function(result) {
        itemId = result.value;
    });
}

itemType

Ruft den Typ des Elements ab, das eine Instanz darstellt.

Die itemType Eigenschaft gibt einen der Enumerationswerte zurück, der ItemType angibt, ob das Elementobjekt instance eine Nachricht oder ein Termin ist.

itemType: MailboxEnums.ItemType | string;

Eigenschaftswert

Office.MailboxEnums.ItemType | string

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminteilnehmer

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-item-type.yaml

const itemType = Office.context.mailbox.item.itemType;
switch (itemType) {
    case Office.MailboxEnums.ItemType.Appointment:
        console.log(`Current item is an ${itemType}.`);
        break;
    case Office.MailboxEnums.ItemType.Message:
        console.log(`Current item is a ${itemType}. A message could be an email, meeting request, meeting response, or meeting cancellation.`);
        break;
}

location

Ruft den Ort eines Termins ab.

Die location-Eigenschaft gibt eine Zeichenfolge zurück, die den Ort des Termins enthält.

location: string;

Eigenschaftswert

string

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminteilnehmer

Beispiele

const location = Office.context.mailbox.item.location;
console.log("location: " + location);

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-location-read.yaml

console.log(`Appointment location: ${Office.context.mailbox.item.location}`);

normalizedSubject

Ruft den Betreff eines Elements ab, wobei alle Präfixe entfernt wurden (einschließlich RE: und FWD:).

Die normalizedSubject -Eigenschaft ruft den Betreff des Elements mit allen Standardpräfixen (z. B. RE: und FW:) ab, die von E-Mail-Programmen hinzugefügt werden. Verwenden Sie subject die -Eigenschaft, um den Betreff des Elements mit intakten Präfixen abzurufen.

normalizedSubject: string;

Eigenschaftswert

string

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminteilnehmer

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-normalized-subject-read.yaml

console.log(`Normalized subject: ${Office.context.mailbox.item.normalizedSubject}`);

notificationMessages

Ruft die Benachrichtigungen für ein Element ab.

notificationMessages: NotificationMessages;

Eigenschaftswert

Office.NotificationMessages

Hinweise

[ API-Satz: Postfach 1.3 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminteilnehmer

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/35-notifications/add-getall-remove.yaml

// Adds a progress indicator to the mail item.
const id = $("#notificationId").val().toString();
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.ProgressIndicator,
    message: "Progress indicator with id = " + id
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);

...

// Adds an informational notification to the mail item.
const id = $("#notificationId").val().toString();
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Non-persistent informational notification message with id = " + id,
    icon: "icon1",
    persistent: false
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);

...

// Adds a persistent information notification to the mail item.
const id = $("#notificationId").val().toString();
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Persistent informational notification message with id = " + id,
    icon: "icon1",
    persistent: true
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);

...

// Gets all the notification messages and their keys for the current mail item.
Office.context.mailbox.item.notificationMessages.getAllAsync((asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Failed) {
    console.log(asyncResult.error.message);
    return;
  }

  console.log(asyncResult.value);
});

...

// Replaces a notification message of a given key with another message.
const id = $("#notificationId").val().toString();
Office.context.mailbox.item.notificationMessages.replaceAsync(
  id,
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Notification message with id = " + id + " has been replaced with an informational message.",
    icon: "icon2",
    persistent: false
  },
  handleResult);

...

// Removes a notification message from the current mail item.
const id = $("#notificationId").val().toString();
Office.context.mailbox.item.notificationMessages.removeAsync(id, handleResult);

optionalAttendees

Bietet Zugriff auf die optionalen Teilnehmer eines Ereignisses. Der Typ des Objekts und die Zugriffsebene hängen vom Modus des aktuellen Elements ab.

Die optionalAttendees -Eigenschaft gibt ein Array zurück, das ein EmailAddressDetails-Objekt für jeden optionalen Teilnehmer an der Besprechung enthält. Die maximale Anzahl der zurückgegebenen Teilnehmer variiert je nach Outlook-Client.

Windows: 500 Teilnehmer
Android, klassische Mac-Benutzeroberfläche, iOS: 100 Teilnehmer
Neue Mac-Benutzeroberfläche, Webbrowser: Keine Beschränkung

optionalAttendees: EmailAddressDetails[];

Eigenschaftswert

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminteilnehmer

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-optional-attendees-appointment-attendee.yaml

const apptOptionalAttendees = Office.context.mailbox.item.optionalAttendees;
console.log("Optional attendees:");
for (let i = 0; i < apptOptionalAttendees.length; i++) {
  console.log(
    apptOptionalAttendees[i].displayName +
      " (" +
      apptOptionalAttendees[i].emailAddress +
      ") - response: " +
      apptOptionalAttendees[i].appointmentResponse
  );
}

organizer

Ruft die E-Mail-Eigenschaften des Besprechungsorganisators ab.

organizer: EmailAddressDetails;

Eigenschaftswert

Office.EmailAddressDetails

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminteilnehmer

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-organizer-appointment-attendee.yaml

const apptOrganizer = Office.context.mailbox.item.organizer;
console.log("Organizer: " + apptOrganizer.displayName + " (" + apptOrganizer.emailAddress + ")");

recurrence

Ruft das Serienmuster eines Termins ab. Ruft das Wiederholungsmuster einer Besprechungsanfrage ab.

Die recurrence Eigenschaft gibt ein Recurrence-Objekt für Terminserien oder Besprechungsanfragen zurück, wenn ein Element eine Reihe oder ein instance in einer Reihe ist. null wird für einzelne Termine und Besprechungsanfragen einzelner Termine zurückgegeben.

Hinweis: Besprechungsanfragen haben den itemClass Wert IPM.Schedule.Meeting.Request.

Hinweis: Wenn das Serienobjekt NULL ist, gibt dies an, dass das Objekt ein einzelner Termin oder eine Besprechungsanfrage eines einzelnen Termins und NICHT Teil einer Reihe ist.

recurrence: Recurrence;

Eigenschaftswert

Office.Recurrence

Hinweise

Office.EmailAddressDetails[]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminteilnehmer

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/50-recurrence/get-recurrence-read.yaml

const recurrence = Office.context.mailbox.item.recurrence;

if (recurrence === undefined) {
  console.log("This item is a message but not a meeting request.");
} else if (recurrence === null) {
  console.log("This is a single appointment.");
} else {
  console.log(JSON.stringify(recurrence));
}

requiredAttendees

Bietet Zugriff auf die erforderlichen Teilnehmer eines Ereignisses. Der Typ des Objekts und die Zugriffsebene hängen vom Modus des aktuellen Elements ab.

Die requiredAttendees -Eigenschaft gibt ein Array zurück, das ein EmailAddressDetails-Objekt für jeden erforderlichen Teilnehmer an der Besprechung enthält. Die maximale Anzahl der zurückgegebenen Teilnehmer variiert je nach Outlook-Client.

Windows: 500 Teilnehmer
Android, klassische Mac-Benutzeroberfläche, iOS: 100 Teilnehmer
Neue Mac-Benutzeroberfläche, Webbrowser: Keine Beschränkung

requiredAttendees: EmailAddressDetails[];

Eigenschaftswert

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminteilnehmer

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-required-attendees-appointment-attendee.yaml

const apptRequiredAttendees = Office.context.mailbox.item.requiredAttendees;
console.log("Required attendees:");
for (let i = 0; i < apptRequiredAttendees.length; i++) {
  console.log(
    apptRequiredAttendees[i].displayName +
      " (" +
      apptRequiredAttendees[i].emailAddress +
      ") - response: " +
      apptRequiredAttendees[i].appointmentResponse
  );
}

sensitivity

Stellt den Vertraulichkeitswert des Termins bereit.

sensitivity: MailboxEnums.AppointmentSensitivityType;

Eigenschaftswert

Office.MailboxEnums.AppointmentSensitivityType

Hinweise

[ API-Satz: Postfach 1.14 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminteilnehmer

Wichtig: Outlook im Web, neue Outlook unter Windows und Outlook auf Mac unterstützen nur die Empfindlichkeitsstufen "Normal" und "Privat".

Beispiele

const sensitivity = Office.context.mailbox.item.sensitivity;
console.log("Sensitivity: " + sensitivity);

seriesId

Ruft die ID der Reihe ab, zu der ein instance gehört.

In Outlook im Web, unter Windows (neu und klassisch) und unter Mac gibt die seriesId EWS-ID (Exchange Web Services) des übergeordneten Elements (Serie) zurück, zu dem dieses Element gehört. Unter iOS und Android gibt die seriesId jedoch die REST-ID des übergeordneten Elements zurück.

Hinweis: Der von der seriesId -Eigenschaft zurückgegebene Bezeichner ist identisch mit dem Exchange-Webdienst-Elementbezeichner. Die seriesId Eigenschaft ist nicht mit den Outlook-IDs identisch, die von der Outlook-REST-API verwendet werden. Bevor Sie REST-API-Aufrufe mit diesem Wert ausführen, sollte sie mit Office.context.mailbox.convertToRestIdkonvertiert werden. Weitere Informationen finden Sie unter Verwenden der Outlook-REST-APIs aus einem Outlook-Add-In.

Die seriesId -Eigenschaft gibt für Elemente zurück null , die keine übergeordneten Elemente haben, z. B. einzelne Termine, Reihenelemente oder Besprechungsanfragen, und gibt für alle anderen Elemente zurück undefined , bei denen es sich nicht um Besprechungsanfragen handelt.

seriesId: string;

Eigenschaftswert

string

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminteilnehmer

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/50-recurrence/get-series-id.yaml

const seriesId = Office.context.mailbox.item.seriesId;

if (seriesId === undefined) {
  console.log("This is a message that's not a meeting request.");
} else if (seriesId === null) {
  console.log("This is a single appointment, a parent series, or a meeting request for a series or single meeting.");
} else {
  console.log("This is an instance belonging to series with ID " + seriesId);
}

start

Ruft das Datum und die Uhrzeit ab, zu dem der Termin beginnen soll.

Die start -Eigenschaft ist ein Date Objekt, das als UTC-Datums- und Uhrzeitwert (Coordinated Universal Time) ausgedrückt wird. Sie können die convertToLocalClientTime -Methode verwenden, um den Wert in das lokale Datum und die lokale Uhrzeit des Clients zu konvertieren.

start: Date;

Eigenschaftswert

Date

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminteilnehmer

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-start-read.yaml

console.log(`Appointment starts: ${Office.context.mailbox.item.start}`);

subject

Ruft die Beschreibung ab, die im Betrefffeld eines Elements angezeigt wird.

Die subject-Eigenschaft ruft den gesamten Betreff des Elements ab oder legt ihn fest – so, wie er vom E-Mail-Server gesendet wird.

Die subject-Eigenschaft gibt eine Zeichenfolge zurück. Verwenden Sie die normalizedSubject -Eigenschaft, um den Betreff abzüglich aller führenden Präfixe wie RE: und FW:abzurufen.

subject: string;

Eigenschaftswert

string

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminteilnehmer

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-subject-read.yaml

console.log(`Subject: ${Office.context.mailbox.item.subject}`);

Details zur Methode

addHandlerAsync(eventType, handler, options, callback)

Fügt einen Ereignishandler für ein unterstütztes Ereignis hinzu. Hinweis: Ereignisse sind nur bei der Implementierung des Aufgabenbereichs verfügbar.

Unterstützte Ereignisse finden Sie im Abschnitt Item-Objektmodellereignisse.

addHandlerAsync(eventType: Office.EventType | string, handler: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parameter

eventType: Office.EventType | string

Das Ereignis, das den Handler aufrufen soll

handler: any

Die Funktion, die das Ereignis behandeln soll. Die Funktion muss einen einzigen Parameter akzeptieren (ein Objektliteral). Die type -Eigenschaft für den -Parameter entspricht dem parameter, der eventType an addHandlerAsyncübergeben wird.

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

Gibt zurück

void

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminteilnehmer

Beispiele

function myHandlerFunction(eventarg) {
    if (eventarg.attachmentStatus === Office.MailboxEnums.AttachmentStatus.Added) {
        const attachment = eventarg.attachmentDetails;
        console.log("Event Fired and Attachment Added!");
        getAttachmentContentAsync(attachment.id, options, callback);
    }
}

Office.context.mailbox.item.addHandlerAsync(Office.EventType.AttachmentsChanged, myHandlerFunction, myCallback);

addHandlerAsync(eventType, handler, callback)

Fügt einen Ereignishandler für ein unterstütztes Ereignis hinzu. Hinweis: Ereignisse sind nur bei der Implementierung des Aufgabenbereichs verfügbar.

Unterstützte Ereignisse finden Sie im Abschnitt Item-Objektmodellereignisse.

addHandlerAsync(eventType: Office.EventType | string, handler: any, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parameter

eventType: Office.EventType | string

Das Ereignis, das den Handler aufrufen soll

handler: any

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

Gibt zurück

void

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminteilnehmer

displayReplyAllForm(formData)

Zeigt ein Antwortformular an, das entweder den Absender und alle Empfänger der ausgewählten Nachricht oder den Organisator und alle Teilnehmer des ausgewählten Termins enthält.

displayReplyAllForm(formData: string | ReplyFormData): void;

Parameter

formData: string | Office.ReplyFormData

Eine Zeichenfolge, die Text- und HTML-Code enthält, die den Hauptteil des Antwortformulars darstellen. Die Zeichenfolge ist auf 32 KB oder ein ReplyFormData-Objekt beschränkt, das Text- oder Anlagendaten und eine Rückruffunktion enthält.

Gibt zurück

void

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminteilnehmer

Wichtig:

In Outlook im Web und dem neuen Outlook unter Windows wird das Antwortformular als Popupformular in der 3-Spalten-Ansicht und als Popupformular in der 2-Spalten- oder 1-Spalten-Ansicht angezeigt.

Wenn einer der Zeichenfolgenparameter seinen Grenzwert überschreitet, löst displayReplyAllForm eine Ausnahme aus.
Wenn Anlagen im formData.attachments Parameter angegeben sind, versucht Outlook, alle Anlagen herunterzuladen und an das Antwortformular anzufügen. Wenn Anlagen nicht hinzugefügt werden können, wird in der Formularbenutzeroberfläche ein Fehler angezeigt. Wenn dies nicht möglich ist, wird keine Fehlermeldung ausgegeben.
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

// The following code passes a string to the `displayReplyAllForm` method.
Office.context.mailbox.item.displayReplyAllForm('hello there');
Office.context.mailbox.item.displayReplyAllForm('<b>hello there</b>');

// Reply with an empty body.
Office.context.mailbox.item.displayReplyAllForm({});

// Reply with just a body.
Office.context.mailbox.item.displayReplyAllForm(
{
'htmlBody' : 'hi'
});

// Reply with a body and a file attachment.
Office.context.mailbox.item.displayReplyAllForm(
{
    'htmlBody' : 'hi',
    'attachments' :
    [
        {
        'type' : Office.MailboxEnums.AttachmentType.File,
        'name' : 'squirrel.png',
        'url' : 'http://i.imgur.com/sRgTlGR.jpg'
        }
    ]
});

// Reply with a body and an item attachment.
Office.context.mailbox.item.displayReplyAllForm(
{
    'htmlBody' : 'hi',
    'attachments' :
    [
        {
        'type' : 'item',
        'name' : 'rand',
        'itemId' : Office.context.mailbox.item.itemId
        }
    ]
});

// Reply with a body, file attachment, item attachment, and a callback.
Office.context.mailbox.item.displayReplyAllForm(
{
    'htmlBody' : 'hi',
    'attachments' :
    [
        {
            'type' : Office.MailboxEnums.AttachmentType.File,
            'name' : 'squirrel.png',
            'url' : 'http://i.imgur.com/sRgTlGR.jpg'
        },
        {
            'type' : 'item',
            'name' : 'rand',
            'itemId' : Office.context.mailbox.item.itemId
        }
    ],
    'callback' : function(asyncResult)
    {
        console.log(asyncResult.value);
    }
});

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/55-display-items/display-reply-forms.yaml

Office.context.mailbox.item.displayReplyAllForm("This is a reply ALL with <b>some bold text</b>.");

displayReplyAllFormAsync(formData, options, callback)

Zeigt ein Antwortformular an, das entweder den Absender und alle Empfänger der ausgewählten Nachricht oder den Organisator und alle Teilnehmer des ausgewählten Termins enthält.

displayReplyAllFormAsync(formData: string | ReplyFormData, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parameter

formData: string | Office.ReplyFormData

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

Gibt zurück

void

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminteilnehmer

Wichtig:

In Outlook im Web und dem neuen Outlook unter Windows wird das Antwortformular als Popupformular in der 3-Spalten-Ansicht und als Popupformular in der 2-Spalten- oder 1-Spalten-Ansicht angezeigt.
Wenn einer der Zeichenfolgenparameter seinen Grenzwert überschreitet, löst displayReplyAllFormAsync eine Ausnahme aus.
Wenn Anlagen im formData.attachments Parameter angegeben sind, versucht Outlook, alle Anlagen herunterzuladen und an das Antwortformular anzufügen. Wenn Anlagen nicht hinzugefügt werden können, wird in der Formularbenutzeroberfläche ein Fehler angezeigt. Wenn dies nicht möglich ist, wird keine Fehlermeldung ausgegeben.
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-reply-forms.yaml

Office.context.mailbox.item.displayReplyAllFormAsync("This is a reply ALL with <b>some bold text</b>.", function(
  asyncResult
) {
  console.log(JSON.stringify(asyncResult));
});

displayReplyAllFormAsync(formData, callback)

Zeigt ein Antwortformular an, das entweder den Absender und alle Empfänger der ausgewählten Nachricht oder den Organisator und alle Teilnehmer des ausgewählten Termins enthält.

displayReplyAllFormAsync(formData: string | ReplyFormData, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parameter

formData: string | Office.ReplyFormData

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

Gibt zurück

void

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminteilnehmer

Wichtig:

In Outlook im Web und dem neuen Outlook unter Windows wird das Antwortformular als Popupformular in der 3-Spalten-Ansicht und als Popupformular in der 2-Spalten- oder 1-Spalten-Ansicht angezeigt.
Wenn einer der Zeichenfolgenparameter seinen Grenzwert überschreitet, löst displayReplyAllFormAsync eine Ausnahme aus.
Wenn Anlagen im formData.attachments Parameter angegeben sind, versucht Outlook, alle Anlagen herunterzuladen und an das Antwortformular anzufügen. Wenn Anlagen nicht hinzugefügt werden können, wird in der Formularbenutzeroberfläche ein Fehler angezeigt. Wenn dies nicht möglich ist, wird keine Fehlermeldung ausgegeben.
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.

displayReplyForm(formData)

Zeigt ein Antwortformular an, das nur den Absender der ausgewählten Nachricht oder den Organisator des ausgewählten Termins enthält.

displayReplyForm(formData: string | ReplyFormData): void;

Parameter

formData: string | Office.ReplyFormData

Gibt zurück

void

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminteilnehmer

Wichtig:

In Outlook im Web und dem neuen Outlook unter Windows wird das Antwortformular als Popupformular in der 3-Spalten-Ansicht und als Popupformular in der 2-Spalten- oder 1-Spalten-Ansicht angezeigt.
Wenn einer der Zeichenfolgenparameter seinen Grenzwert überschreitet, löst displayReplyForm eine Ausnahme aus.
Wenn Anlagen im formData.attachments Parameter angegeben sind, versucht Outlook, alle Anlagen herunterzuladen und an das Antwortformular anzufügen. Wenn Anlagen nicht hinzugefügt werden können, wird in der Formularbenutzeroberfläche ein Fehler angezeigt. Wenn dies nicht möglich ist, wird keine Fehlermeldung ausgegeben.
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-reply-forms.yaml

Office.context.mailbox.item.displayReplyForm("This is a reply with <i>some text in italics</i>.");

...

Office.context.mailbox.item.displayReplyForm({
  htmlBody: "This is a reply with an inline image and an item attachment.<br><img src='cid:dog.jpg'>",
  attachments: [
    { type: "file", url: "https://i.imgur.com/9S36xvA.jpg", name: "dog.jpg", inLine: true },
    { type: "item", itemId: Office.context.mailbox.item.itemId, name: "test_email.msg" }
  ],
  callback: (result) => {
    if (result.status === Office.AsyncResultStatus.Failed) {
      console.error(`Action failed with message ${result.error.message}`);
      return;
    }

    console.log("Created reply with attachments.");
  }
});

displayReplyFormAsync(formData, options, callback)

Zeigt ein Antwortformular an, das nur den Absender der ausgewählten Nachricht oder den Organisator des ausgewählten Termins enthält.

displayReplyFormAsync(formData: string | ReplyFormData, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parameter

formData: string | Office.ReplyFormData

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

Gibt zurück

void

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminteilnehmer

Wichtig:

In Outlook im Web und dem neuen Outlook unter Windows wird das Antwortformular als Popupformular in der 3-Spalten-Ansicht und als Popupformular in der 2-Spalten- oder 1-Spalten-Ansicht angezeigt.
Wenn einer der Zeichenfolgenparameter seinen Grenzwert überschreitet, löst displayReplyFormAsync eine Ausnahme aus.
Wenn Anlagen im formData.attachments Parameter angegeben sind, versucht Outlook, alle Anlagen herunterzuladen und an das Antwortformular anzufügen. Wenn Anlagen nicht hinzugefügt werden können, wird in der Formularbenutzeroberfläche ein Fehler angezeigt. Wenn dies nicht möglich ist, wird keine Fehlermeldung ausgegeben.
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-reply-forms.yaml

Office.context.mailbox.item.displayReplyFormAsync("This is a reply with <i>some text in italics</i>.", function(
  asyncResult
) {
  console.log(JSON.stringify(asyncResult));
});

...

// The async version is only available starting with requirement set 1.9.
// It provides a callback when the new appointment form has been created.
Office.context.mailbox.item.displayReplyFormAsync(
  {
    htmlBody: "This is a reply with an inline image and an item attachment.<br><img src='cid:dog.jpg'>",
    attachments: [
      { type: "file", url: "http://i.imgur.com/9S36xvA.jpg", name: "dog.jpg", inLine: true },
      { type: "item", itemId: Office.context.mailbox.item.itemId, name: "test_email.msg" }
    ]
  },
  (asyncResult) => {
    console.log(JSON.stringify(asyncResult));
  }
);

displayReplyFormAsync(formData, callback)

Zeigt ein Antwortformular an, das nur den Absender der ausgewählten Nachricht oder den Organisator des ausgewählten Termins enthält.

displayReplyFormAsync(formData: string | ReplyFormData, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parameter

formData: string | Office.ReplyFormData

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

Gibt zurück

void

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminteilnehmer

Wichtig:

In Outlook im Web und dem neuen Outlook unter Windows wird das Antwortformular als Popupformular in der 3-Spalten-Ansicht und als Popupformular in der 2-Spalten- oder 1-Spalten-Ansicht angezeigt.
Wenn einer der Zeichenfolgenparameter seinen Grenzwert überschreitet, löst displayReplyFormAsync eine Ausnahme aus.
Wenn Anlagen im formData.attachments Parameter angegeben sind, versucht Outlook, alle Anlagen herunterzuladen und an das Antwortformular anzufügen. Wenn Anlagen nicht hinzugefügt werden können, wird in der Formularbenutzeroberfläche ein Fehler angezeigt. Wenn dies nicht möglich ist, wird keine Fehlermeldung ausgegeben.
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.

getAttachmentContentAsync(attachmentId, options, callback)

Ruft eine Anlage aus einer Nachricht oder einem Termin ab und gibt sie als AttachmentContent -Objekt zurück.

Die getAttachmentContentAsync -Methode ruft die Anlage mit dem angegebenen Bezeichner aus dem Element ab. Als bewährte Methode sollten Sie den Bezeichner der Anlage aus einem item.attachments-Aufruf abrufen und dann in derselben Sitzung diesen Bezeichner verwenden, um die Anlage abzurufen. In Outlook im Web, auf mobilen Geräten und in neuen Outlook unter Windows ist die Anlage-ID nur innerhalb derselben Sitzung gültig. Eine Sitzung ist beendet, wenn der Benutzer die App schließt, oder wenn der Benutzer mit der Erstellung eines Inlineformulars beginnt, dann wird das Formular anschließend eingeblendt, um in einem separaten Fenster fortzufahren.

getAttachmentContentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void): void;

Parameter

attachmentId: string

Der Bezeichner der Anlage, die Sie abrufen möchten.

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<Office.AttachmentContent>) => void

Optional. Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter aufgerufen, asyncResult, der ein Office.AsyncResult -Objekt ist. Wenn der Aufruf fehlschlägt, enthält die asyncResult.error Eigenschaft einen Fehlercode mit dem Grund für den Fehler.

Gibt zurück

void

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminteilnehmer

Fehler:

AttachmentTypeNotSupported : Der Anlagentyp wird nicht unterstützt. Zu den nicht unterstützten Typen gehören eingebettete Bilder im Rich-Text-Format oder andere Elementanlagetypen als E-Mail- oder Kalenderelemente (z. B. kontakt- oder aufgabenelement).
InvalidAttachmentId : Der Anlagenbezeichner ist nicht vorhanden.

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/40-attachments/get-attachment-content.yaml

// Gets the attachments of the current message or appointment in read mode.
// The item.attachments call can only be used in read mode.
const attachments = item.attachments;
if (attachments.length <= 0) {
  console.log("Mail item has no attachments.");
  return;
}

for (let i = 0; i < attachments.length; i++) {
  // Log the attachment type and its contents to the console.
  item.getAttachmentContentAsync(attachments[i].id, handleAttachmentsCallback);
}

getAttachmentContentAsync(attachmentId, callback)

Ruft eine Anlage aus einer Nachricht oder einem Termin ab und gibt sie als AttachmentContent -Objekt zurück.

getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void): void;

Parameter

attachmentId: string

Der Bezeichner der Anlage, die Sie abrufen möchten.

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

Gibt zurück

void

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminteilnehmer

Fehler:

AttachmentTypeNotSupported : Der Anlagentyp wird nicht unterstützt. Zu den nicht unterstützten Typen gehören eingebettete Bilder im Rich-Text-Format oder andere Elementanlagetypen als E-Mail- oder Kalenderelemente (z. B. kontakt- oder aufgabenelement).
InvalidAttachmentId : Der Anlagenbezeichner ist nicht vorhanden.

getEntities()

Warnung

Diese API ist nun veraltet.

Use regular expression rules instead.

Ruft die Entitäten im Text des ausgewählten Elements ab.

Warnung: Entitätsbasierte kontextbezogene Outlook-Add-Ins werden jetzt eingestellt. Regeln für reguläre Ausdrücke werden jedoch weiterhin unterstützt. Es wird empfohlen, Ihr Kontext-Add-In zu aktualisieren, um Regeln für reguläre Ausdrücke als alternative Lösung zu verwenden. Eine Anleitung zum Implementieren dieser Regeln finden Sie unter Kontextbezogene Outlook-Add-Ins.

getEntities(): Entities;

Gibt zurück

Office.Entities

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminteilnehmer

getEntitiesByType(entityType)

Warnung

Diese API ist nun veraltet.

Use regular expression rules instead.

Ruft ein Array aller Entitäten des angegebenen Typs ab, die im Texts des ausgewählten Elements enthalten sind.

getEntitiesByType(entityType: MailboxEnums.EntityType | string): Array<string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion>;

Parameter

entityType: Office.MailboxEnums.EntityType | string

Einer der EntityType Enumerationswerte.

Gibt zurück

Array<string | Office.Contact | Office.MeetingSuggestion | Office.PhoneNumber | Office.TaskSuggestion>

Wenn der in entityType übergebene Wert kein gültiges Element der EntityType-Enumeration ist, gibt die Methode null zurück. Wenn keine Entitäten des angegebenen Typs im Text des Elements vorhanden sind, gibt die Methode ein leeres Array zurück. Andernfalls hängt der Typ der Objekte im zurückgegebenen Array vom Typ der Entität ab, die im entityType-Parameter angefordert wurde.

Hinweise

Mindestberechtigungsstufe: eingeschränkt

Anwendbarer Outlook-Modus: Terminteilnehmer

getFilteredEntitiesByName(name)

Warnung

Diese API ist nun veraltet.

Use regular expression rules instead.

Gibt bekannte Entitäten im ausgewählten Element zurück, die den benannten Filter übergeben, der in einer reinen Add-In-Manifestdatei definiert ist.

getFilteredEntitiesByName(name: string): Array<string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion>;

Parameter

name: string

Der Name des ItemHasKnownEntity-Regelelements, das den entsprechenden Filter definiert.

Gibt zurück

Array<string | Office.Contact | Office.MeetingSuggestion | Office.PhoneNumber | Office.TaskSuggestion>

Die Entitäten, die mit dem regulären Ausdruck übereinstimmen, der ItemHasKnownEntity im Regelelement in der Add-In-Manifestdatei mit dem angegebenen FilterName Elementwert definiert ist. Wenn im Manifest kein ItemHasKnownEntity Element mit einem FilterName Elementwert vorhanden ist, der dem name Parameter entspricht, gibt die Methode zurück null. Wenn der name Parameter mit einem ItemHasKnownEntity Element im Manifest übereinstimmt, aber keine Entitäten im aktuellen Element vorhanden sind, die übereinstimmen, gibt die Methode ein leeres Array zurück.

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminteilnehmer

getInitializationContextAsync(options, callback)

Ruft Initialisierungsdaten ab, die übergeben werden, wenn das Add-In durch eine Nachricht mit Aktionen aktiviert wird.

getInitializationContextAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;

Parameter

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<string>) => void

Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter vom Typ Office.AsyncResultaufgerufen. Bei Erfolg werden die Initialisierungskontextdaten als Zeichenfolge (oder eine leere Zeichenfolge, wenn kein Initialisierungskontext vorhanden ist) in der asyncResult.value -Eigenschaft bereitgestellt.

Gibt zurück

void

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminteilnehmer

Beispiele

// Get the initialization context (if present).
Office.context.mailbox.item.getInitializationContextAsync((asyncResult) => {
    if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
        if (asyncResult.value.length > 0) {
            // The value is a string, parse to an object.
            const context = JSON.parse(asyncResult.value);
            // Do something with context.
        } else {
            // Empty context, treat as no context.
        }
    } else {
        // Handle the error.
    }
});

getInitializationContextAsync(callback)

Ruft Initialisierungsdaten ab, die übergeben werden, wenn das Add-In durch eine Nachricht mit Aktionen aktiviert wird.

getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;

Parameter

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

Gibt zurück

void

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminteilnehmer

getRegExMatches()

Gibt Zeichenfolgenwerte im ausgewählten Element zurück, die den regulären Ausdrücken entsprechen, die in einer reinen Add-In-Manifestdatei definiert sind.

getRegExMatches(): any;

Gibt zurück

any

Ein Objekt, das Arrays von Zeichenfolgen enthält, die den regulären Ausdrücken entsprechen, die in der Add-In-Manifestdatei definiert sind. Der Name jedes Arrays ist gleich dem entsprechenden Wert des RegExName-Attributs der Abgleichsregel ItemHasRegularExpressionMatch . Für eine ItemHasRegularExpressionMatch Regel muss eine übereinstimmende Zeichenfolge in der -Eigenschaft des Elements auftreten, das von dieser Regel angegeben wird. Der einfache PropertyName-Typ definiert die unterstützten Eigenschaften.

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminteilnehmer

Wichtig:

Entitätsbasierte kontextbezogene Outlook-Add-Ins werden jetzt eingestellt. Regeln für reguläre Ausdrücke werden jedoch weiterhin unterstützt. Es wird empfohlen, Ihr Kontext-Add-In zu aktualisieren, um Regeln für reguläre Ausdrücke als alternative Lösung zu verwenden. Eine Anleitung zum Implementieren dieser Regeln finden Sie unter Kontextbezogene Outlook-Add-Ins.
Diese Methode wird mit dem Aktivierungsregelnfeature für Outlook-Add-Ins verwendet, das vom einheitlichen Manifest für Microsoft 365 nicht unterstützt wird.
Wenn Sie eine ItemHasRegularExpressionMatch Regel für die body-Eigenschaft eines Elements angeben, sollte der reguläre Ausdruck den Text weiter filtern und nicht versuchen, den gesamten Textkörper des Elements zurückzugeben. Die Verwendung eines regulären Ausdrucks wie .* zum Abrufen des gesamten Textkörpers eines Elements gibt nicht immer die erwarteten Ergebnisse zurück. Verwenden Sie stattdessen die Body.getAsync-Methode, um den gesamten Textkörper abzurufen.
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

// Consider an add-in manifest has the following `Rule` element:
//<Rule xsi:type="RuleCollection" Mode="And">
//  <Rule xsi:type="ItemIs" FormType="Read" ItemType="Message" />
//  <Rule xsi:type="RuleCollection" Mode="Or">
//    <Rule xsi:type="ItemHasRegularExpressionMatch" RegExName="fruits" RegExValue="apple|banana|coconut" PropertyName="BodyAsPlaintext" IgnoreCase="true" />
//    <Rule xsi:type="ItemHasRegularExpressionMatch" RegExName="veggies" RegExValue="tomato|onion|spinach|broccoli" PropertyName="BodyAsPlaintext" IgnoreCase="true" />
//  </Rule>
//</Rule>

// The object returned from `getRegExMatches` would have two properties: `fruits` and `veggies`.
//{
//'fruits': ['apple','banana','Banana','coconut'],
//'veggies': ['tomato','onion','spinach','broccoli']
//}

// The following example shows how to access the array of
// matches for the regular expression rule elements `fruits`
// and `veggies`, which are specified in the manifest.
const allMatches = Office.context.mailbox.item.getRegExMatches();
const fruits = allMatches.fruits;
const veggies = allMatches.veggies;

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/75-regex-matches/contextual.yaml

// This API only works when you click on the highlighted word "ScriptLab".
console.log(Office.context.mailbox.item.getRegExMatches());

getRegExMatchesByName(name)

Gibt Zeichenfolgenwerte im ausgewählten Element zurück, die mit dem benannten regulären Ausdruck übereinstimmen, der in einer reinen Add-In-Manifestdatei definiert ist.

getRegExMatchesByName(name: string): string[];

Parameter

name: string

Der Name des ItemHasRegularExpressionMatch-Regelelements, das den entsprechenden Filter definiert.

Gibt zurück

string[]

Ein Array, das die Zeichenfolgen enthält, die mit dem im Regelelement in der ItemHasRegularExpressionMatch Add-In-Manifestdatei definierten regulären Ausdruck mit dem angegebenen RegExName Elementwert übereinstimmen.

Hinweise

[ API-Satz: Postfach 1.8 für die Unterstützung freigegebener Ordner, Postfach 1.13 für die Unterstützung freigegebener Postfächer ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminteilnehmer

Wichtig:

Entitätsbasierte kontextbezogene Outlook-Add-Ins werden jetzt eingestellt. Regeln für reguläre Ausdrücke werden jedoch weiterhin unterstützt. Es wird empfohlen, Ihr Kontext-Add-In zu aktualisieren, um Regeln für reguläre Ausdrücke als alternative Lösung zu verwenden. Eine Anleitung zum Implementieren dieser Regeln finden Sie unter Kontextbezogene Outlook-Add-Ins.
Diese Methode wird mit dem Aktivierungsregelnfeature für Outlook-Add-Ins verwendet, das vom einheitlichen Manifest für Microsoft 365 nicht unterstützt wird.
Wenn Sie eine ItemHasRegularExpressionMatch Regel für die body-Eigenschaft eines Elements angeben, sollte der reguläre Ausdruck den Text weiter filtern und nicht versuchen, den gesamten Textkörper des Elements zurückzugeben. Die Verwendung eines regulären Ausdrucks wie .* zum Abrufen des gesamten Textkörpers eines Elements gibt nicht immer die erwarteten Ergebnisse zurück. Verwenden Sie stattdessen die Body.getAsync-Methode, um den gesamten Textkörper abzurufen.
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

// Consider an add-in manifest has the following `Rule` element:
//<Rule xsi:type="RuleCollection" Mode="And">
//  <Rule xsi:type="ItemIs" FormType="Read" ItemType="Message" />
//  <Rule xsi:type="RuleCollection" Mode="Or">
//    <Rule xsi:type="ItemHasRegularExpressionMatch" RegExName="fruits" RegExValue="apple|banana|coconut" PropertyName="BodyAsPlaintext" IgnoreCase="true" />
//    <Rule xsi:type="ItemHasRegularExpressionMatch" RegExName="veggies" RegExValue="tomato|onion|spinach|broccoli" PropertyName="BodyAsPlaintext" IgnoreCase="true" />
//  </Rule>
//</Rule>

// The object returned from `getRegExMatches` would have two properties: `fruits` and `veggies`.
//{
//'fruits': ['apple','banana','Banana','coconut'],
//'veggies': ['tomato','onion','spinach','broccoli']
//}

const fruits = Office.context.mailbox.item.getRegExMatchesByName("fruits");
const veggies = Office.context.mailbox.item.getRegExMatchesByName("veggies");

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/75-regex-matches/contextual.yaml

// This API only works when you click on the highlighted word "ScriptLab".
console.log(Office.context.mailbox.item.getRegExMatchesByName("sampleRegexName"));

getSelectedEntities()

Warnung

Diese API ist nun veraltet.

Use regular expression rules instead.

Ruft die Entitäten ab, die in einer hervorgehobenen Übereinstimmung gefunden werden, die ein Benutzer ausgewählt hat. Hervorgehobene Übereinstimmungen gelten für Kontext-Add-Ins.

getSelectedEntities(): Entities;

Gibt zurück

Office.Entities

Hinweise

[ API-Satz: Postfach 1.6 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminteilnehmer

getSelectedRegExMatches()

Gibt Zeichenfolgenwerte in einer hervorgehobenen Übereinstimmung zurück, die den regulären Ausdrücken entsprechen, die in einer reinen Add-In-Manifestdatei definiert sind. Hervorgehobene Übereinstimmungen gelten für Kontext-Add-Ins.

getSelectedRegExMatches(): any;

Gibt zurück

any

Ein Objekt, das Arrays von Zeichenfolgen enthält, die den regulären Ausdrücken entsprechen, die in der Add-In-Manifestdatei definiert sind. Der Name jedes Arrays ist gleich dem entsprechenden Wert des RegExName Attributs der Übereinstimmenden ItemHasRegularExpressionMatch Regel. Für eine ItemHasRegularExpressionMatch Regel muss eine übereinstimmende Zeichenfolge in der -Eigenschaft des Elements auftreten, das von dieser Regel angegeben wird. Der einfache PropertyName-Typ definiert die unterstützten Eigenschaften.

Hinweise

[ API-Satz: Postfach 1.6 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminteilnehmer

Wichtig:

Entitätsbasierte kontextbezogene Outlook-Add-Ins werden jetzt eingestellt. Regeln für reguläre Ausdrücke werden jedoch weiterhin unterstützt. Es wird empfohlen, Ihr Kontext-Add-In zu aktualisieren, um Regeln für reguläre Ausdrücke als alternative Lösung zu verwenden. Eine Anleitung zum Implementieren dieser Regeln finden Sie unter Kontextbezogene Outlook-Add-Ins.
Diese Methode wird mit dem Aktivierungsregelnfeature für Outlook-Add-Ins verwendet, das vom einheitlichen Manifest für Microsoft 365 nicht unterstützt wird.
Diese Methode wird in Outlook unter iOS oder Android 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.
Wenn Sie eine ItemHasRegularExpressionMatch Regel für die body-Eigenschaft eines Elements angeben, sollte der reguläre Ausdruck den Text weiter filtern und nicht versuchen, den gesamten Textkörper des Elements zurückzugeben. Die Verwendung eines regulären Ausdrucks wie .* zum Abrufen des gesamten Textkörpers eines Elements gibt nicht immer die erwarteten Ergebnisse zurück. Verwenden Sie stattdessen die Body.getAsync-Methode, um den gesamten Textkörper abzurufen.

Beispiele

// Consider an add-in manifest has the following `Rule` element:
//<Rule xsi:type="RuleCollection" Mode="And">
//  <Rule xsi:type="ItemIs" FormType="Read" ItemType="Message" />
//  <Rule xsi:type="RuleCollection" Mode="Or">
//    <Rule xsi:type="ItemHasRegularExpressionMatch" RegExName="fruits" RegExValue="apple|banana|coconut" PropertyName="BodyAsPlaintext" IgnoreCase="true" />
//    <Rule xsi:type="ItemHasRegularExpressionMatch" RegExName="veggies" RegExValue="tomato|onion|spinach|broccoli" PropertyName="BodyAsPlaintext" IgnoreCase="true" />
//  </Rule>
//</Rule>

// The object returned from `getRegExMatches` would have two properties: `fruits` and `veggies`.
//{
//'fruits': ['apple','banana','Banana','coconut'],
//'veggies': ['tomato','onion','spinach','broccoli']
//}

// The following example shows how to access the array of matches for the
// regular expression rule elements `fruits` and `veggies`, which are
// specified in the manifest.
const selectedMatches = Office.context.mailbox.item.getSelectedRegExMatches();
const fruits = selectedMatches.fruits;
const veggies = selectedMatches.veggies;

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/75-regex-matches/contextual.yaml

const matches = Office.context.mailbox.item.getSelectedRegExMatches();
if (matches) {
    console.log(matches);
} else {
    console.error("Open add-in by clicking on a highlighted regex match, for this API to return something useful.");
}

getSharedPropertiesAsync(options, callback)

Ruft die Eigenschaften eines Termins oder einer Nachricht in einem freigegebenen Ordner oder freigegebenen Postfach ab.

Weitere Informationen zur Verwendung dieser API finden Sie unter Aktivieren von Szenarien für freigegebene Ordner und freigegebene Postfächer in einem Outlook-Add-In.

getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void): void;

Parameter

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<Office.SharedProperties>) => 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 asyncResult.value -Eigenschaft stellt die Eigenschaften des freigegebenen Elements bereit.

Gibt zurück

void

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminteilnehmer

Hinweis: Diese Methode wird in Outlook unter iOS oder Android nicht unterstützt.

getSharedPropertiesAsync(callback)

Ruft die Eigenschaften eines Termins oder einer Nachricht in einem freigegebenen Ordner oder freigegebenen Postfach ab.

Weitere Informationen zur Verwendung dieser API finden Sie unter Aktivieren von Szenarien für freigegebene Ordner und freigegebene Postfächer in einem Outlook-Add-In.

getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void): void;

Parameter

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

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.8 für die Unterstützung freigegebener Ordner, Postfach 1.13 für die Unterstützung freigegebener Postfächer ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminteilnehmer

Hinweis: Diese Methode wird in Outlook unter iOS oder Android nicht unterstützt.

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/65-delegates-and-shared-folders/get-shared-properties.yaml

Office.context.mailbox.item.getSharedPropertiesAsync((result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.error("The current folder or mailbox isn't shared.");
    return;
  }
  const sharedProperties = result.value;
  console.log(`Owner: ${sharedProperties.owner}`);
  console.log(`Permissions: ${sharedProperties.delegatePermissions}`);
  console.log(`Target mailbox: ${sharedProperties.targetMailbox}`);
});

loadCustomPropertiesAsync(callback, userContext)

Lädt asynchron benutzerdefinierte Eigenschaften für dieses Add-In für das ausgewählte Element.

Benutzerdefinierte Eigenschaften werden als Schlüssel-Wert-Paare pro App und Element gespeichert. Diese Methode gibt ein CustomProperties-Objekt im Rückruf zurück, das Methoden für den Zugriff auf die benutzerdefinierten Eigenschaften bereitstellt, die für das aktuelle Element und das aktuelle Add-In spezifisch sind. Benutzerdefinierte Eigenschaften werden für das Element nicht verschlüsselt, sodass dies nicht als sicherer Speicher verwendet werden sollte.

Die benutzerdefinierten Eigenschaften werden als CustomProperties-Objekt in der asyncResult.value-Eigenschaft bereitgestellt. Dieses Objekt kann verwendet werden, um benutzerdefinierte Eigenschaften aus dem E-Mail-Element abzurufen, festzulegen, zu speichern und zu entfernen.

loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult<CustomProperties>) => void, userContext?: any): void;

Parameter

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

Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter vom Typ Office.AsyncResultaufgerufen.

userContext: any

Optional. Entwickler können ein beliebiges Objekt bereitstellen, auf das sie in der Callbackfunktion zugreifen möchten. Der Zugriff auf dieses Objekt kann über die asyncResult.asyncContext-Eigenschaft in der Callbackfunktion erfolgen.

Gibt zurück

void

Hinweise

Weitere Informationen zu benutzerdefinierten Eigenschaften finden Sie unter Abrufen und Festlegen von Add-In-Metadaten für ein Outlook-Add-In.

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminteilnehmer

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/15-item-custom-properties/load-set-get-save.yaml

Office.context.mailbox.item.loadCustomPropertiesAsync((result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.error(`loadCustomPropertiesAsync failed with message ${result.error.message}`);
    return;
  }

  customProps = result.value;
  console.log("Loaded the CustomProperties object.");
});

removeHandlerAsync(eventType, options, callback)

Entfernt die Ereignishandler für einen unterstützten Ereignistyp. Hinweis: Ereignisse sind nur bei der Implementierung des Aufgabenbereichs verfügbar.

Unterstützte Ereignisse finden Sie im Abschnitt Item-Objektmodellereignisse.

removeHandlerAsync(eventType: Office.EventType | string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parameter

eventType: Office.EventType | string

Das Ereignis, das den Handler widerrufen soll.

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

Gibt zurück

void

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminteilnehmer

removeHandlerAsync(eventType, callback)

Entfernt die Ereignishandler für einen unterstützten Ereignistyp. Hinweis: Ereignisse sind nur bei der Implementierung des Aufgabenbereichs verfügbar.

Unterstützte Ereignisse finden Sie im Abschnitt Item-Objektmodellereignisse.

removeHandlerAsync(eventType: Office.EventType | string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parameter

eventType: Office.EventType | string

Das Ereignis, das den Handler widerrufen soll.

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

Gibt zurück

void

Hinweise