Office.AppointmentCompose interface

Ruft ein Objekt ab, das Methoden zum Bearbeiten des Textkörpers eines Elements bereitstellt.

body: Body;

Eigenschaftswert

Hinweise

[ API-Satz: Postfach 1.1 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminplaner

Beispiele

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

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

Ruft ein -Objekt ab, das Methoden zum Verwalten der Elementkategorien bereitstellt.

categories: Categories;

Eigenschaftswert

Hinweise

[ API-Satz: Postfach 1.8 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminplaner

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/45-categories/work-with-categories.yaml

Office.context.mailbox.item.categories.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const categories = asyncResult.value;
    if (categories && categories.length > 0) {
      console.log("Categories assigned to this item:");
      console.log(JSON.stringify(categories));
    } else {
      console.log("There are no categories assigned to this item.");
    }
  } else {
    console.error(asyncResult.error);
  }
});

...

// Note: In order for you to successfully add a category,
// it must be in the mailbox categories master list.

Office.context.mailbox.masterCategories.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const masterCategories = asyncResult.value;
    if (masterCategories && masterCategories.length > 0) {
      // Grab the first category from the master list.
      const categoryToAdd = [masterCategories[0].displayName];
      Office.context.mailbox.item.categories.addAsync(categoryToAdd, function(asyncResult) {
        if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
          console.log(`Successfully assigned category '${categoryToAdd}' to item.`);
        } else {
          console.log("categories.addAsync call failed with error: " + asyncResult.error.message);
        }
      });
    } else {
      console.log("There are no categories in the master list on this mailbox. You can add categories using Office.context.mailbox.masterCategories.addAsync.");
    }
  } else {
    console.error(asyncResult.error);
  }
});

...

Office.context.mailbox.item.categories.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const categories = asyncResult.value;
    if (categories && categories.length > 0) {
      // Grab the first category assigned to this item.
      const categoryToRemove = [categories[0].displayName];
      Office.context.mailbox.item.categories.removeAsync(categoryToRemove, function(asyncResult) {
        if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
          console.log(`Successfully unassigned category '${categoryToRemove}' from this item.`);
        } else {
          console.log("categories.removeAsync call failed with error: " + asyncResult.error.message);
        }
      });
    } else {
      console.log("There are no categories assigned to this item.");
    }
  } else {
    console.error(asyncResult.error);
  }
});

Ruft Datum und Zeit für das Ende des Termins ab oder legt diese fest.

Die end -Eigenschaft ist ein Time-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.

Wichtig: Im Windows-Client können Sie diese Eigenschaft nicht verwenden, um das Ende einer Serie zu aktualisieren.

end: Time;

Eigenschaftswert

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminplaner

Beispiele

// The following example sets the end time of an appointment in compose mode by
// using the `setAsync` method of the `Time` object.
const endTime = new Date("3/14/2015");
const options = {
    // Pass information that can be used in the callback.
    asyncContext: {verb: "Set"}
};
Office.context.mailbox.item.end.setAsync(endTime, options, function(result) {
    if (result.error) {
        console.debug(result.error);
    } else {
        // Access the asyncContext that was passed to the setAsync method.
        console.debug("End Time " + result.asyncContext.verb);
    }
});

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

Office.context.mailbox.item.end.getAsync((result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Action failed with message ${result.error.message}`);
    return;
  }
  console.log(`Appointment ends: ${result.value}`);
});

...

Office.context.mailbox.item.start.getAsync((result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Get start date failed with message ${result.error.message}`);
    return;
  }

  const end = result.value; // Set end to current start date and time.
  end.setDate(end.getDate() + 1); // Set end as 1 day later than start date.
  Office.context.mailbox.item.end.setAsync(end, (result) => {
    if (result.status !== Office.AsyncResultStatus.Succeeded) {
      console.error(`Set end date failed with message ${result.error.message}`);
      return;
    }
    console.log(`Successfully set end date and time to ${end}`);
  });
});

Ruft die Speicherorte des Termins ab oder legt diese fest. Die enhancedLocation Eigenschaft gibt ein EnhancedLocation-Objekt zurück, das Methoden zum Abrufen, Entfernen oder Hinzufügen von Speicherorten für ein Element bereitstellt.

enhancedLocation: EnhancedLocation;

Eigenschaftswert

Hinweise

[ API-Satz: Postfach 1.8 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminplaner

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.");
  }
});

...

const locations = [
  {
    id: "Contoso",
    type: Office.MailboxEnums.LocationType.Custom
  },
  {
    id: "room500@test.com",
    type: Office.MailboxEnums.LocationType.Room
  }
];
Office.context.mailbox.item.enhancedLocation.addAsync(locations, (result) => {
  if (result.status === Office.AsyncResultStatus.Succeeded) {
    console.log(`Successfully added locations ${JSON.stringify(locations)}`);
  } else {
    console.error(`Failed to add locations. Error message: ${result.error.message}`);
  }
});

...

const locations = [
  {
    id: "Contoso",
    type: Office.MailboxEnums.LocationType.Custom
  },
  {
    id: "room500@test.com",
    type: Office.MailboxEnums.LocationType.Room
  }
];
Office.context.mailbox.item.enhancedLocation.removeAsync(locations, (result) => {
  if (result.status === Office.AsyncResultStatus.Succeeded) {
    console.log(`Successfully removed locations ${JSON.stringify(locations)}`);
  } else {
    console.error(`Failed to remove locations. Error message: ${result.error.message}`);
  }
});

Ruft die Office.IsAllDayEvent-Eigenschaft eines Termins ab oder legt diese fest.

isAllDayEvent: IsAllDayEvent;

Eigenschaftswert

Hinweise

[ API-Satz: Postfachvorschau ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminplaner

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/99-preview-apis/get-set-isalldayevent.yaml

Office.context.mailbox.item.isAllDayEvent.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Is this an all-day event? " + asyncResult.value);
  } else {
    console.log("Failed to get if this is an all-day event. Error: " + JSON.stringify(asyncResult.error));
  }
});

...

Office.context.mailbox.item.isAllDayEvent.setAsync(true, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Failed) {
    console.log("Failed to set all-day event: " + JSON.stringify(asyncResult.error));
  } else {
    console.log("Appointment set to all-day event.");
  }
});

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

Die itemType-Eigenschaft gibt einen der Werte der ItemType-Enumeration zurück, der angibt, ob es sich bei der item-Objektinstanz um eine Nachricht oder einen Termin handelt.

itemType: MailboxEnums.ItemType | string;

Eigenschaftswert

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminplaner

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;
}

Ruft den Ort eines Termins ab bzw. legt ihn fest. Die location -Eigenschaft gibt ein Location-Objekt zurück, das Methoden bereitstellt, die zum Abrufen und Festlegen der Position des Termins verwendet werden.

location: Location;

Eigenschaftswert

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminplaner

Beispiele

const userContext = { value : 1 };
Office.context.mailbox.item.location.getAsync( { context: userContext}, callback);

function callback(asyncResult) {
    const context = asyncResult.context;
    const location = asyncResult.value;
}

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

Office.context.mailbox.item.location.getAsync((result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Action failed with message ${result.error.message}`);
    return;
  }
  console.log(`Appointment location: ${result.value}`);
});

...

const location = "my office";
Office.context.mailbox.item.location.setAsync(location, (result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Action failed with message ${result.error.message}`);
    return;
  }
  console.log(`Successfully set location to ${location}`);
});

Ruft die Benachrichtigungen für ein Element ab.

notificationMessages: NotificationMessages;

Eigenschaftswert

Hinweise

[ API-Satz: Postfach 1.3 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminplaner

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);

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 Recipients-Objekt zurück, das Methoden zum Abrufen oder Aktualisieren der optionalen Teilnehmer für eine Besprechung bereitstellt. Je nach Client/Plattform (z. B. Windows, Mac usw.) gelten jedoch Grenzwerte für die Anzahl der Empfänger, die Sie abrufen oder aktualisieren können. Weitere Informationen finden Sie im Recipients-Objekt .

optionalAttendees: Recipients;

Eigenschaftswert

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminplaner

Beispiele

Office.context.mailbox.item.optionalAttendees.setAsync( ['alice@contoso.com', 'bob@contoso.com'] );
Office.context.mailbox.item.optionalAttendees.addAsync( ['jason@contoso.com'] );
Office.context.mailbox.item.optionalAttendees.getAsync(callback);

function callback(asyncResult) {
    const arrayOfOptionalAttendeesRecipients = asyncResult.value;
}

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

Office.context.mailbox.item.optionalAttendees.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const apptOptionalAttendees = asyncResult.value;
    for (let i = 0; i < apptOptionalAttendees.length; i++) {
      console.log(
        "Optional attendees: " +
          apptOptionalAttendees[i].displayName +
          " (" +
          apptOptionalAttendees[i].emailAddress +
          ") - response: " +
          apptOptionalAttendees[i].appointmentResponse
      );
    }
  } else {
    console.error(asyncResult.error);
  }
});

...

const email = $("#emailOptional")
  .val()
  .toString();
const emailArray = [email];
Office.context.mailbox.item.optionalAttendees.setAsync(emailArray, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Succeeded in setting optional attendees field.");
  } else {
    console.error(asyncResult.error);
  }
});

Ruft den Organisator für die angegebene Besprechung ab.

Die organizer Eigenschaft gibt ein Organizer-Objekt zurück, das eine Methode zum Abrufen des Organisatorwerts bereitstellt.

organizer: Organizer;

Eigenschaftswert

Hinweise

[ API-Satz: Postfach 1.7 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Terminplaner

Beispiele

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

Office.context.mailbox.item.organizer.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const apptOrganizer = asyncResult.value;
    console.log("Organizer: " + apptOrganizer.displayName + " (" + apptOrganizer.emailAddress + ")");
  } else {
    console.error(asyncResult.error);
  }
});

Ruft das Serienmuster eines Termins ab oder legt es fest.

Die recurrence -Eigenschaft gibt ein Wiederholungsobjekt 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

Hinweise

[ API-Satz: Postfach 1.7 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminplaner

Beispiele

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

Office.context.mailbox.item.recurrence.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const recurrence = asyncResult.value;
    if (recurrence === null) {
      console.log("This is a single appointment.");
    } else {
      console.log(`Recurrence pattern: ${JSON.stringify(recurrence)}`);
    }
  } else {
    console.error(asyncResult.error);
  }
});

...

// Important: Can only set the recurrence pattern of an appointment series.

const currentDate = new Date();
let seriesTimeObject: Office.SeriesTime;
// Set series start date to tomorrow.
seriesTimeObject.setStartDate(currentDate.getFullYear(), currentDate.getMonth(), currentDate.getDay() + 1);
// Set series end date to one year from now.
seriesTimeObject.setEndDate(currentDate.getFullYear() + 1, currentDate.getMonth() + 1, currentDate.getDay());
// Set start time to 1:30 PM.
seriesTimeObject.setStartTime(13, 30);
// Set duration to 30 minutes.
seriesTimeObject.setDuration(30);

const pattern: Office.Recurrence = {
  seriesTime: seriesTimeObject,
  recurrenceType: Office.MailboxEnums.RecurrenceType.Yearly,
  recurrenceProperties: {
    interval: 1,
    dayOfWeek: Office.MailboxEnums.Days.Tue,
    weekNumber: Office.MailboxEnums.WeekNumber.Second,
    month: Office.MailboxEnums.Month.Sep
  },
  recurrenceTimeZone: { name: Office.MailboxEnums.RecurrenceTimeZone.PacificStandardTime }
};

Office.context.mailbox.item.recurrence.setAsync(pattern, (asyncResult) => {
  if (asyncResult.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Failed to set recurrence. Error: ${asyncResult.error.message}`);
    return;
  }
  console.log(`Succeeded in setting recurrence pattern ${JSON.stringify(pattern)}`);
});

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 Recipients-Objekt zurück, das Methoden zum Abrufen oder Aktualisieren der erforderlichen Teilnehmer für eine Besprechung bereitstellt. Je nach Client/Plattform (z. B. Windows, Mac usw.) gelten jedoch Grenzwerte für die Anzahl der Empfänger, die Sie abrufen oder aktualisieren können. Weitere Informationen finden Sie im Recipients-Objekt .

requiredAttendees: Recipients;

Eigenschaftswert

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminplaner

Beispiele

Office.context.mailbox.item.requiredAttendees.setAsync( ['alice@contoso.com', 'bob@contoso.com'] );
Office.context.mailbox.item.requiredAttendees.addAsync( ['jason@contoso.com'] );
Office.context.mailbox.item.requiredAttendees.getAsync(callback);

function callback(asyncResult) {
    const arrayOfRequiredAttendeesRecipients = asyncResult.value;
    console.log(JSON.stringify(arrayOfRequiredAttendeesRecipients));
}

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

Office.context.mailbox.item.requiredAttendees.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const apptRequiredAttendees = asyncResult.value;
    for (let i = 0; i < apptRequiredAttendees.length; i++) {
      console.log(
        "Required attendees: " +
          apptRequiredAttendees[i].displayName +
          " (" +
          apptRequiredAttendees[i].emailAddress +
          ") - response: " +
          apptRequiredAttendees[i].appointmentResponse
      );
    }
  } else {
    console.error(asyncResult.error);
  }
});

...

const email = $("#emailRequired")
  .val()
  .toString();
const emailArray = [email];
Office.context.mailbox.item.requiredAttendees.setAsync(emailArray, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Succeeded in setting required attendees field.");
  } else {
    console.error(asyncResult.error);
  }
});

Ruft die Vertraulichkeitsstufe eines Termins ab oder legt diese fest. Informationen zu Vertraulichkeitsstufen finden Sie unter Markieren Ihrer E-Mails als "Normal", "Persönlich", "Privat" oder "Vertraulich".

sensitivity: Sensitivity;

Eigenschaftswert

Hinweise

[ API-Satz: Postfach 1.14 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminplaner

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

Beispiele

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

Office.context.mailbox.item.sensitivity.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Sensitivity: " + asyncResult.value);
  } else {
    console.log("Failed to get sensitivity: " + JSON.stringify(asyncResult.error));
  }
});

...

Office.context.mailbox.item.sensitivity.setAsync(
  Office.MailboxEnums.AppointmentSensitivityType.Private,
  function callback(asyncResult) {
    if (asyncResult.status === Office.AsyncResultStatus.Failed) {
      console.log("Failed to set appointment sensitivity: " + JSON.stringify(asyncResult.error));
    } else {
      console.log("Successfully set appointment sensitivity.");
    }
  }
);

Ruft das -Objekt ab, um die Vertraulichkeitsbezeichnung eines Termins abzurufen oder festzulegen.

sensitivityLabel: SensitivityLabel;

Eigenschaftswert

Hinweise

[ API-Satz: Postfach 1.13 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Terminplaner

Wichtig: Um die Vertraulichkeitsbezeichnungsfunktion in Ihrem Add-In verwenden zu können, benötigen Sie ein Microsoft 365 E5-Abonnement.

Weitere Informationen zum Verwalten von Vertraulichkeitsbezeichnungen in Ihrem Add-In finden Sie unter Verwalten der Vertraulichkeitsbezeichnung Ihrer Nachricht oder Ihres Termins im Verfassenmodus.

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/60-sensitivity-label/sensitivity-label.yaml

// This snippet gets the current mail item's sensitivity label.
Office.context.sensitivityLabelsCatalog.getIsEnabledAsync((asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded && asyncResult.value == true) {
    Office.context.mailbox.item.sensitivityLabel.getAsync((asyncResult) => {
      if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
        console.log(asyncResult.value);
      } else {
        console.log("Action failed with error: " + asyncResult.error.message);
      }
    });
  } else {
    console.log("Action failed with error: " + asyncResult.error.message);
  }
});

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 Eigenschaft die seriesId EWS-ID (Exchange Web Services) des übergeordneten Elements (Serie) zurück, zu dem dieses Element gehört. In Outlook für Android und unter iOS seriesId gibt 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 identisch mit den Outlook-IDs, 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, Serienelemente oder Besprechungsanfragen, und gibt für alle anderen Elemente zurück undefined , die keine Besprechungsanfragen sind.

seriesId: string;

Eigenschaftswert

Hinweise

[ API-Satz: Postfach 1.7 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminplaner

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);
}

Verwaltet die SessionData eines Elements im Compose Modus.

Wichtig: Das gesamte SessionData-Objekt ist auf 50.000 Zeichen pro Add-In beschränkt.

sessionData: SessionData;

Eigenschaftswert

Hinweise

[ API-Satz: Postfach 1.11 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminplaner

Beispiele

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

Office.context.mailbox.item.sessionData.getAllAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("The sessionData is " + JSON.stringify(asyncResult.value));
  } else {
    console.log("Failed to get all sessionData. Error: " + JSON.stringify(asyncResult.error));
  }
});

Ruft Datum und Zeit für den Beginn des Termins ab oder legt Datum und Uhrzeit fest.

Die start -Eigenschaft ist ein Time-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.

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

Wichtig: Im Windows-Client können Sie diese Eigenschaft nicht verwenden, um den Beginn einer Wiederholung zu aktualisieren.

start: Time;

Eigenschaftswert

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminplaner

Beispiele

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

Office.context.mailbox.item.start.getAsync((result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Action failed with message ${result.error.message}`);
    return;
  }
  console.log(`Appointment starts: ${result.value}`);
});

...

const start = new Date(); // Represents current date and time.
start.setDate(start.getDate() + 2); // Add 2 days to current date.
Office.context.mailbox.item.start.setAsync(start, (result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Action failed with message ${result.error.message}`);
    return;
  }
  console.log(`Successfully set start date and time to ${start}`);
});

Ruft die Beschreibung ab, die im Betrefffeld eines Elements angezeigt wird, oder legt sie fest.

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 ein Subject-Objekt zurück, das Methoden zum Abrufen und Festlegen des Betreffs bereitstellt.

subject: Subject;

Eigenschaftswert

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminplaner

Beispiele

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

Office.context.mailbox.item.subject.getAsync((result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Action failed with message ${result.error.message}`);
    return;
  }
  console.log(`Subject: ${result.value}`);
});

...

let subject = "Hello World!";
Office.context.mailbox.item.subject.setAsync(subject, (result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Action failed with message ${result.error.message}`);
    return;
  }
  console.log(`Successfully set subject to ${subject}`);
});

Fügt eine Datei zu einer Nachricht oder einem Termin als Anlage hinzu.

Die addFileAttachmentAsync-Methode lädt die Datei am angegebenen URI hoch und fügt sie an das Element im Verfassenformular an.

addFileAttachmentAsync(uri: string, attachmentName: string, options: Office.AsyncContextOptions & { isInline: boolean }, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;

Parameter

Gibt zurück

Hinweise

[ API-Satz: Postfach 1.1 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Terminplaner

Wichtig:

• In den letzten Builds des klassischen Outlook unter Windows wurde ein Fehler eingeführt, der fälschlicherweise einen Authorization: Bearer Header an diese Aktion anhängt (unabhängig davon, ob diese API oder die Outlook-Benutzeroberfläche verwendet wird). Um dieses Problem zu umgehen, können Sie versuchen, die API zu verwenden, die addFileAttachmentFromBase64 mit dem Anforderungssatz 1.8 eingeführt wurde.

• Der URI der datei, die angefügt werden soll, muss die Zwischenspeicherung in der Produktion unterstützen. Der Server, auf dem das Image gehostet wird, sollte keinen Header zurückgebenCache-Control, der , no-storeoder ähnliche Optionen in der HTTP-Antwort angibtno-cache. Wenn Sie jedoch das Add-In entwickeln und Änderungen an Dateien vornehmen, kann das Zwischenspeichern verhindern, dass Sie Ihre Änderungen sehen. Es wird empfohlen, Header während der Entwicklung zu verwenden Cache-Control .

• Sie können denselben URI mit der removeAttachmentAsync -Methode verwenden, um die Anlage in derselben Sitzung zu entfernen.

Fehler:

• AttachmentSizeExceeded : Die Anlage ist größer als zulässig.

• FileTypeNotSupported : Die Anlage verfügt über eine Erweiterung, die nicht zulässig ist.

• NumberOfAttachmentsExceeded : Die Nachricht oder der Termin weist zu viele Anlagen auf.

Beispiele

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

const attachmentUrl = $("#attachmentUrl")
  .val()
  .toString();
Office.context.mailbox.item.addFileAttachmentAsync(
  attachmentUrl,
  getFileName(attachmentUrl),
  { isInline: false },
  (result) => {
    console.log(result);
  }
);

Fügt eine Datei zu einer Nachricht oder einem Termin als Anlage hinzu.

Die addFileAttachmentAsync-Methode lädt die Datei am angegebenen URI hoch und fügt sie an das Element im Verfassenformular an.

addFileAttachmentAsync(uri: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;

Parameter

Gibt zurück

Hinweise

[ API-Satz: Postfach 1.1 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Terminplaner

Wichtig:

• In den letzten Builds des klassischen Outlook unter Windows wurde ein Fehler eingeführt, der fälschlicherweise einen Authorization: Bearer Header an diese Aktion anhängt (unabhängig davon, ob diese API oder die Outlook-Benutzeroberfläche verwendet wird). Um dieses Problem zu umgehen, können Sie versuchen, die API zu verwenden, die addFileAttachmentFromBase64 mit dem Anforderungssatz 1.8 eingeführt wurde.

• Der URI der datei, die angefügt werden soll, muss die Zwischenspeicherung in der Produktion unterstützen. Der Server, auf dem das Image gehostet wird, sollte keinen Header zurückgebenCache-Control, der , no-storeoder ähnliche Optionen in der HTTP-Antwort angibtno-cache. Wenn Sie jedoch das Add-In entwickeln und Änderungen an Dateien vornehmen, kann das Zwischenspeichern verhindern, dass Sie Ihre Änderungen sehen. Es wird empfohlen, Header während der Entwicklung zu verwenden Cache-Control .

• Sie können denselben URI mit der removeAttachmentAsync -Methode verwenden, um die Anlage in derselben Sitzung zu entfernen.

Fehler:

• AttachmentSizeExceeded : Die Anlage ist größer als zulässig.

• FileTypeNotSupported : Die Anlage verfügt über eine Erweiterung, die nicht zulässig ist.

• NumberOfAttachmentsExceeded : Die Nachricht oder der Termin weist zu viele Anlagen auf.

Fügt eine Datei zu einer Nachricht oder einem Termin als Anlage hinzu.

Die addFileAttachmentFromBase64Async -Methode lädt die Datei aus der Base64-Codierung hoch und fügt sie an das Element im Erstellformular an. Diese Methode gibt den Anlagenbezeichner im asyncResult.value -Objekt zurück.

Anschließend können Sie den Bezeichner mit der removeAttachmentAsync-Methode in der gleichen Sitzung zum Entfernen der Anlage verwenden.

Hinweis: Wenn Sie eine Daten-URL-API (z. B. ) verwenden, readAsDataURLmüssen Sie das Präfix der Daten-URL entfernen und dann den Rest der Zeichenfolge an diese API senden. Wenn beispielsweise die vollständige Zeichenfolge durch data:image/svg+xml;base64,<rest of Base64 string>dargestellt wird, entfernen Sie data:image/svg+xml;base64,.

addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, options: Office.AsyncContextOptions &  { isInline: boolean }, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;

Parameter

Gibt zurück

Hinweise

[ API-Satz: Postfach 1.8 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Terminplaner

Fehler:

• AttachmentSizeExceeded : Die Anlage ist größer als zulässig.

• FileTypeNotSupported : Die Anlage verfügt über eine Erweiterung, die nicht zulässig ist.

• NumberOfAttachmentsExceeded : Die Nachricht oder der Termin weist zu viele Anlagen auf.

Hinweis: Wenn Sie ein Base64-Inlinebild zum Textkörper einer Nachricht oder eines Termins hinzufügen, der gerade erstellt wird, müssen Sie zuerst den aktuellen Elementtext mithilfe der Office.context.mailbox.item.body.getAsync-Methode abrufen, bevor Sie das Bild mit addFileAttachmentFromBase64Asynceinfügen. Andernfalls wird das Bild nicht im Text gerendert, nachdem es eingefügt wurde. Weitere Anleitungen finden Sie unter Anfügen einer Datei.

Beispiele

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

const base64String =
  "iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAACXBIWXMAAAsSAAALEgHS3X78AAACRUlEQVRYw82XzXHbMBCFP2F8tzsQc8Ixyh0zoiuIXIGdCsxUYKqC0B04FdiuwMoM7mGOOIXqQGoAymXhgSX+itJM9kIRFLAP+3YXD5Pdbscx5oxaAIW8Ztr6l2PWmQwF4IyaieP53qdfAqQ8CwBn1JU4vpWhrbxXQA5MZfynANmcDIAzKgcy4FKGXsVJFf3nLgKyBQptfT4KQMRz2N0fcbxqmRMDWXflx0VPnrdArq0vekQ1Dv0UeHZGNebHhwjU8AzwKM43RyZnbAf58Q6ghudeWd0Aus0+5EcMIIRi3beua0D3Nm39BEAx3i7HTK4DEBJn5YxKOnaRA5+ErpMBWMpzDvx1RuXCcxOISlufAjfC7zgAsqsvUvMAD0ApPaEtGi9AIlUzKgJo60tt/SyKRkzLrAXERluf7W1gOICWaMyB386oooOWsIHvXbSoHuUSFovtHqicUVnH3EJoeT0aQEf5/XBGlc6otIOWBXAtPeZkAIJ9Bt6cUU9tZautX2nrk3MACHYr1ZKProKRtDw4o8pzAPjWo+NtpXTTvoteDDg8noDAcwbcRedAkGdFXyk2GEDcegVAFp2gyVDHjRQ4o6q2smoqtR5Hd+qMqtoALCWUUymr1m43QMZfOaMK4C0SrMsDANJ2E5FNcbdbjHC+ENl+H0myJFbLtaq4Rt8dyPBYRQV1E40nMv9rl7xrOw3DGb+Whcqu3i/OM6CUOWvgRlufNmnLYy4m77uJI7AXtdNcTDrU71LEyv7v01/N/ovL6bmu5/8A1tNWZldH0W4AAAAASUVORK5CYII=";
Office.context.mailbox.item.addFileAttachmentFromBase64Async(
  base64String,
  "logo.png",
  { isInline: false },
  (result) => {
    console.log(result);
  }
);

...

// Set the signature for the current item with inline image.
const modIcon1Base64 = "iVBORw0KGgoAAAANSUhEUgAAABwAAAAcCAYAAAByDd+UAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAA2ZpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuMC1jMDYxIDY0LjE0MDk0OSwgMjAxMC8xMi8wNy0xMDo1NzowMSAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wTU09Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9tbS8iIHhtbG5zOnN0UmVmPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvc1R5cGUvUmVzb3VyY2VSZWYjIiB4bWxuczp4bXA9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC8iIHhtcE1NOk9yaWdpbmFsRG9jdW1lbnRJRD0ieG1wLmRpZDpDRDMxMDg1MjBCNDZFMTExODE2MkM1RUI2M0M4MDYxRCIgeG1wTU06RG9jdW1lbnRJRD0ieG1wLmRpZDpFMTUxQjgyRjQ2MEQxMUUxODlFMkQwNTYzQ0YwMTUxMiIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDpFMTUxQjgyRTQ2MEQxMUUxODlFMkQwNTYzQ0YwMTUxMiIgeG1wOkNyZWF0b3JUb29sPSJBZG9iZSBQaG90b3Nob3AgQ1M1LjEgV2luZG93cyI+IDx4bXBNTTpEZXJpdmVkRnJvbSBzdFJlZjppbnN0YW5jZUlEPSJ4bXAuaWlkOkQxMzEwODUyMEI0NkUxMTE4MTYyQzVFQjYzQzgwNjFEIiBzdFJlZjpkb2N1bWVudElEPSJ4bXAuZGlkOkNEMzEwODUyMEI0NkUxMTE4MTYyQzVFQjYzQzgwNjFEIi8+IDwvcmRmOkRlc2NyaXB0aW9uPiA8L3JkZjpSREY+IDwveDp4bXBtZXRhPiA8P3hwYWNrZXQgZW5kPSJyIj8+uC/WfAAAAehJREFUeNpilCzfwEAEkAbiECA2A2J1IOaHin8E4ptAfBaIVwLxU0IGMRKw0B6IW4DYhoE4cASIK6E0VsCEQ1wUiNcB8QESLGOAqj0MxBuhZhBloS4QnwHiQAbygR/UDF1CFupCXSjHQDmQg5qli8tCUBBsQUoQ1AD8UDNFsVk4n0o+w+bT+egWglKjNymmeGhLkqLcG2oHAwtUoIuQDj5OVgZPLUmwRe5aEmAxqYqNpFgKssOcCeplM0KqdST5GfpDDRm0JfkYrj3/SE7QguyQY4ImYYLgCtAS10kHGMw6dzNsv/qC7OwCClJXYlR++v6b4er3j5QmIFcmaNlIL6AOslCIjhYKMTHQGTBBqxh6gXcgC6/R0cKbIAv30dHCfaAKGJTxHxJSqS3Fz9DkowNmywpyMcgA8fF7b8D8VWcfM6w8+4gYC+VB+RCk8hSh0gaUD4/dewvlvUWRe/z+GzGWgex4BGtiOAHxXhoHpzMoSGHZAhSPW2lo2VZYWkHOh4nEtLrIAE+hZmNUwK+B2BOIv1PRsu9QM1/jatNcBtVZ0IREKXgENesyoVYbzNIdFFi2A5tl+NqlL6BB4QBNzsSCU1A9nlAzMAALAQMOQl0qB23qWwKxIlIrDBQ394H4OBCvISYqAAIMACVibHDqsO7zAAAAAElFTkSuQmCC";
Office.context.mailbox.item.addFileAttachmentFromBase64Async(
  modIcon1Base64,
  "myImage.png",
  { isInline: true },
  function(result) {
    if (result.status == Office.AsyncResultStatus.Succeeded) {
      const signature = $("#signature").val() + "<img src='cid:myImage.png'>";
      console.log(`Setting signature to "${signature}".`);
      Office.context.mailbox.item.body.setSignatureAsync(
        signature,
        { coercionType: "html" },
        function(asyncResult) {
          console.log(`setSignatureAsync: ${asyncResult.status}`);
        }
      );
    } else {
      console.error(`addFileAttachmentFromBase64Async: ${result.error}`);
    }
  }
);

Fügt eine Datei zu einer Nachricht oder einem Termin als Anlage hinzu.

Die addFileAttachmentFromBase64Async -Methode lädt die Datei aus der Base64-Codierung hoch und fügt sie an das Element im Erstellformular an. Diese Methode gibt den Anlagenbezeichner im asyncResult.value -Objekt zurück.

Anschließend können Sie den Bezeichner mit der removeAttachmentAsync-Methode in der gleichen Sitzung zum Entfernen der Anlage verwenden.

Hinweis: Wenn Sie eine Daten-URL-API (z. B. ) verwenden, readAsDataURLmüssen Sie das Präfix der Daten-URL entfernen und dann den Rest der Zeichenfolge an diese API senden. Wenn beispielsweise die vollständige Zeichenfolge durch data:image/svg+xml;base64,<rest of Base64 string>dargestellt wird, entfernen Sie data:image/svg+xml;base64,.

addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;

Parameter

Gibt zurück

Hinweise

[ API-Satz: Postfach 1.8 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Terminplaner

Fehler:

• AttachmentSizeExceeded : Die Anlage ist größer als zulässig.

• FileTypeNotSupported : Die Anlage verfügt über eine Erweiterung, die nicht zulässig ist.

• NumberOfAttachmentsExceeded : Die Nachricht oder der Termin weist zu viele Anlagen auf.

Hinweis: Wenn Sie ein Base64-Inlinebild zum Textkörper einer Nachricht oder eines Termins hinzufügen, der gerade erstellt wird, müssen Sie zuerst den aktuellen Elementtext mithilfe der Office.context.mailbox.item.body.getAsync-Methode abrufen, bevor Sie das Bild mit addFileAttachmentFromBase64Asynceinfügen. Andernfalls wird das Bild nicht im Text gerendert, nachdem es eingefügt wurde. Weitere Anleitungen finden Sie unter Anfügen einer Datei.

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

Gibt zurück

Hinweise

[ API-Satz: Postfach 1.7 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminplaner

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);

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

Gibt zurück

Hinweise

[ API-Satz: Postfach 1.7 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminplaner

Fügt der Nachricht oder dem Termin ein Exchange-Objekt, wie z. B. eine Nachricht, als Anhang hinzu.

Die addItemAttachmentAsync -Methode fügt das Element mit dem angegebenen Exchange-Bezeichner an das Element im Verfassenformular an. Wenn Sie eine Rückruffunktion angeben, wird die Methode mit einem Parameter aufgerufen, asyncResultder entweder den Anlagenbezeichner oder einen Code enthält, der einen Fehler angibt, der beim Anfügen des Elements aufgetreten ist. Sie können den options -Parameter verwenden, um bei Bedarf Zustandsinformationen an die Rückruffunktion zu übergeben.

Anschließend können Sie den Bezeichner mit der removeAttachmentAsync-Methode in der gleichen Sitzung zum Entfernen der Anlage verwenden.

Wenn Ihr Office-Add-In in Outlook im Web und in neuem Outlook unter Windows ausgeführt wird, kann die addItemAttachmentAsync Methode Elemente an andere Elemente als das element anfügen, das Sie gerade bearbeiten. Dies wird jedoch nicht unterstützt und nicht empfohlen.

addItemAttachmentAsync(itemId: any, attachmentName: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;

Parameter

Gibt zurück

Hinweise

[ API-Satz: Postfach 1.1 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Terminplaner

Fehler:

• NumberOfAttachmentsExceeded : Die Nachricht oder der Termin weist zu viele Anlagen auf.

Beispiele

// The following example adds an existing Outlook item as an attachment
// with the name "My Attachment".
function addAttachment() {
    // EWS ID of item to attach (shortened for readability).
    const itemId = "AAMkADI1...AAA=";

    // The values in asyncContext can be accessed in the callback.
    const options = { asyncContext: { var1: 1, var2: 2 } };

    Office.context.mailbox.item.addItemAttachmentAsync(itemId, "My Attachment", options, (result) => {
        if (result.status === Office.AsyncResultStatus.Failed) {
            console.error("Failed to add attachment: " + result.error.message);
            return;
        }

        console.log("Attachment added successfully.");
        console.log("var1: " + result.asyncContext.var1);
        console.log("var2: " + result.asyncContext.var2);
    });
}

Fügt der Nachricht oder dem Termin ein Exchange-Objekt, wie z. B. eine Nachricht, als Anhang hinzu.

Die addItemAttachmentAsync -Methode fügt das Element mit dem angegebenen Exchange-Bezeichner an das Element im Verfassenformular an. Wenn Sie eine Rückruffunktion angeben, wird die Methode mit einem Parameter aufgerufen, asyncResultder entweder den Anlagenbezeichner oder einen Code enthält, der einen Fehler angibt, der beim Anfügen des Elements aufgetreten ist. Sie können den options -Parameter verwenden, um bei Bedarf Zustandsinformationen an die Rückruffunktion zu übergeben.

Anschließend können Sie den Bezeichner mit der removeAttachmentAsync-Methode in der gleichen Sitzung zum Entfernen der Anlage verwenden.

Wenn Ihr Office-Add-In in Outlook im Web und in neuem Outlook unter Windows ausgeführt wird, kann die addItemAttachmentAsync Methode Elemente an andere Elemente als das element anfügen, das Sie gerade bearbeiten. Dies wird jedoch nicht unterstützt und nicht empfohlen.

addItemAttachmentAsync(itemId: any, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;

Parameter

Gibt zurück

Hinweise

[ API-Satz: Postfach 1.1 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Terminplaner

Fehler:

• NumberOfAttachmentsExceeded : Die Nachricht oder der Termin weist zu viele Anlagen auf.

Schließt das aktuelle Element, das gerade verfasst wird.

Das Verhalten der close-Methode hängt vom aktuellen Status des verfassten Elements ab. Wenn das Element nicht gespeicherte Änderungen aufweist, fordert der Client den Benutzer auf, die Aktion zu speichern, zu verwerfen oder zu schließen.

In Outlook unter Windows (klassisch) und auf Mac hat die close Methode keine Auswirkungen auf eine Antwort im Lesebereich.

close(): void;

Gibt zurück

Hinweise

[ API-Satz: Postfach 1.3 ]

Mindestberechtigungsstufe: eingeschränkt

Anwendbarer Outlook-Modus: Terminplaner

Wichtig: Wenn es sich bei Outlook im Web und dem neuen Outlook unter Windows um einen Termin handelt und es zuvor mit saveAsyncgespeichert wurde, wird der Benutzer aufgefordert, zu speichern, zu verwerfen oder abzubrechen, auch wenn seit dem letzten Speichern des Elements keine Änderungen vorgenommen wurden.

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/25-item-save-and-close/close.yaml

Office.context.mailbox.item.close();

Deaktiviert die Outlook-Clientsignatur.

In Outlook unter Windows (klassisch) und auf Mac legt diese API die Signatur unter den Abschnitten "Neue Nachricht" und "Antworten/Weiterleitungen" für das sendende Konto auf "(none)" fest, wodurch die Signatur effektiv deaktiviert wird. In Outlook im Web und neuen Outlook unter Windows deaktiviert die API die Signaturoption für neue E-Mails, Antworten und Weiterleitungen. Wenn die Signatur ausgewählt ist, wird sie durch diesen API-Aufruf deaktiviert.

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

Parameter

Gibt zurück

Hinweise

[ API-Satz: Postfach 1.10 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Terminplaner

Beispiele

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

// Disable the client signature.
Office.context.mailbox.item.disableClientSignatureAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("disableClientSignatureAsync succeeded");
  } else {
    console.error(asyncResult.error);
  }
});

Deaktiviert die Outlook-Clientsignatur.

In Outlook unter Windows (klassisch) und auf Mac legt diese API die Signatur unter den Abschnitten "Neue Nachricht" und "Antworten/Weiterleitungen" für das sendende Konto auf "(none)" fest, wodurch die Signatur effektiv deaktiviert wird. In Outlook im Web und neuen Outlook unter Windows deaktiviert die API die Signaturoption für neue E-Mails, Antworten und Weiterleitungen. Wenn die Signatur ausgewählt ist, wird sie durch diesen API-Aufruf deaktiviert.

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

Parameter

Gibt zurück

Hinweise

[ API-Satz: Postfach 1.10 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Terminplaner

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 getAttachmentsAsync 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

Gibt zurück

Hinweise

[ API-Satz: Postfach 1.8 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminplaner

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 compose mode.
const options = { asyncContext: { currentItem: item } };
// The getAttachmentsAsync call can only be used in compose mode.
item.getAttachmentsAsync(options, callback);

function callback(result) {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.log(result.error.message);
    return;
  }

  if (result.value.length <= 0) {
    console.log("Mail item has no attachments.");
    return;
  }

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

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 getAttachmentsAsync 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, callback?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void): void;

Parameter

Gibt zurück

Hinweise

[ API-Satz: Postfach 1.8 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminplaner

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.

Ruft die Anlagen des Elements als Array ab.

getAttachmentsAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<AttachmentDetailsCompose[]>) => void): void;

Parameter

Gibt zurück

Hinweise

[ API-Satz: Postfach 1.8 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminplaner

Beispiele

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

Office.context.mailbox.item.getAttachmentsAsync((result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.error(result.error.message);
    return;
  }

  if (result.value.length > 0) {
    for (let i = 0; i < result.value.length; i++) {
      const attachment = result.value[i];
      let attachmentType;
      switch (attachment.attachmentType) {
        case Office.MailboxEnums.AttachmentType.Cloud:
          attachmentType = "Attachment is stored in a cloud location";
          break;
        case Office.MailboxEnums.AttachmentType.File:
          attachmentType = "Attachment is a file";
          break;
        case Office.MailboxEnums.AttachmentType.Item:
          attachmentType = "Attachment is an Exchange item";
          break;
      }
      console.log(
        "ID: " +
          attachment.id +
          "\n" +
          "Type: " +
          attachmentType +
          "\n" +
          "Name: " +
          attachment.name +
          "\n" +
          "Size: " +
          attachment.size +
          "\n" +
          "isInline: " +
          attachment.isInline
      );
    }
  } else {
    console.log("No attachments on this message.");
  }
});

Ruft die Anlagen des Elements als Array ab.

getAttachmentsAsync(callback?: (asyncResult: Office.AsyncResult<AttachmentDetailsCompose[]>) => void): void;

Parameter

Gibt zurück

Hinweise

[ API-Satz: Postfach 1.8 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminplaner

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

Gibt zurück

Hinweise

[ API-Satz: Postfach 1.8 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminplaner

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.
    }
});

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

Gibt zurück

Hinweise

[ API-Satz: Postfach 1.8 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminplaner

Ruft asynchron den EWS-Elementbezeichner (Exchange Web Services) eines gespeicherten Elements ab.

Beim Aufruf gibt diese Methode die Element-ID über die Rückruffunktion zurück.

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

Parameter

Gibt zurück

Hinweise

[ API-Satz: Postfach 1.8 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminplaner

Wichtig:

• 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.

• Wenn Ihr Add-In aufruft getItemIdAsync (z. B. zum Abrufen einer Element-ID, die mit EWS oder der REST-API verwendet werden soll), beachten Sie, dass es im Zwischenspeichermodus einige Zeit dauern kann, bis das Element mit dem Server synchronisiert wird. Bis das Element synchronisiert ist, wird die Element-ID nicht erkannt, und die Verwendung gibt einen Fehler zurück.

Fehler:

• ItemNotSaved : Die ID kann erst abgerufen werden, wenn das Element gespeichert wurde.

Ruft asynchron den EWS-Elementbezeichner (Exchange Web Services) eines gespeicherten Elements ab.

Beim Aufruf gibt diese Methode die Element-ID über die Rückruffunktion zurück.

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

Parameter

Gibt zurück

Hinweise

[ API-Satz: Postfach 1.8 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminplaner

Wichtig:

• 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.

• Wenn Ihr Add-In aufruft getItemIdAsync (z. B. zum Abrufen einer Element-ID, die mit EWS oder der REST-API verwendet werden soll), beachten Sie, dass es im Zwischenspeichermodus einige Zeit dauern kann, bis das Element mit dem Server synchronisiert wird. Bis das Element synchronisiert ist, wird die Element-ID nicht erkannt, und die Verwendung gibt einen Fehler zurück.

Fehler:

• ItemNotSaved : Die ID kann erst abgerufen werden, wenn das Element gespeichert wurde.

Beispiele

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

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

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

Gibt asynchron ausgewählte Daten aus dem Betreff oder Textkörper einer Nachricht zurück.

Wenn keine Auswahl vorhanden ist, sich aber der Cursor im Text oder Betreff befindet, gibt die Methode eine leere Zeichenfolge für die ausgewählten Daten zurück. Wenn ein anderes Feld als der Textkörper oder Betreff ausgewählt ist, gibt die Methode den InvalidSelection-Fehler zurück.

Rufen asyncResult.value.dataSie auf, um über die Rückruffunktion auf die ausgewählten Daten zuzugreifen. Um auf die source Eigenschaft zuzugreifen, von der die Auswahl stammt, rufen Sie asyncResult.value.sourcePropertyauf, wobei entweder body oder ist subject.

getSelectedDataAsync(coercionType: Office.CoercionType | string, options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<any>) => void): void;

Parameter

Gibt zurück

Die ausgewählten Daten als Zeichenfolge, deren Format durch bestimmt wird coercionType.

Hinweise

[ API-Satz: Postfach 1.2 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminplaner

Beispiele

// Get selected data.
Office.context.mailbox.item.getSelectedDataAsync(Office.CoercionType.Text, { option1: "option1"}, getCallback);

function getCallback(asyncResult) {
    const text = asyncResult.value.data;
    const prop = asyncResult.value.sourceProperty;

    console.log(`Selected text in ${prop}: ${text}`);
}

Gibt asynchron ausgewählte Daten aus dem Betreff oder Textkörper einer Nachricht zurück.

Wenn keine Auswahl vorhanden ist, sich aber der Cursor im Text oder Betreff befindet, gibt die Methode eine leere Zeichenfolge für die ausgewählten Daten zurück. Wenn ein anderes Feld als der Textkörper oder Betreff ausgewählt ist, gibt die Methode den InvalidSelection-Fehler zurück.

Rufen asyncResult.value.dataSie auf, um über die Rückruffunktion auf die ausgewählten Daten zuzugreifen. Um auf die source Eigenschaft zuzugreifen, von der die Auswahl stammt, rufen Sie asyncResult.value.sourcePropertyauf, wobei entweder body oder ist subject.

getSelectedDataAsync(coercionType: Office.CoercionType | string, callback: (asyncResult: Office.AsyncResult<string>) => void): void;

Parameter

Gibt zurück

Die ausgewählten Daten als Zeichenfolge, deren Format durch bestimmt wird coercionType.

Hinweise

[ API-Satz: Postfach 1.2 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminplaner

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/20-item-body/get-selected-data.yaml

Office.context.mailbox.item.getSelectedDataAsync(Office.CoercionType.Text, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const text = asyncResult.value.data;
    const prop = asyncResult.value.sourceProperty;
    console.log("Selected text in " + prop + ": " + text);
  } else {
    console.error(asyncResult.error);
  }
});

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

Gibt zurück

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: Terminplaner

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

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

Gibt zurück

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: Terminplaner

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}`);
});

Ruft ab, ob die Clientsignatur aktiviert ist.

In Outlook im Web und neuen Outlook unter Windows gibt zurücktrue, wenn die Signatur für VerfassentypennewMail , replyoder forwardaktiviert ist. Wenn die Einstellungen in Outlook unter Windows (klassisch) oder auf Mac auf "(none)" festgelegt oder in Outlook im Web oder neuem Outlook unter Windows deaktiviert sind, wird zurückgegebenfalse.

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

Parameter

Gibt zurück

Hinweise

[ API-Satz: Postfach 1.10 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminplaner

Beispiele

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

// Check if the client signature is currently enabled.
Office.context.mailbox.item.isClientSignatureEnabledAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("isClientSignatureEnabledAsync succeeded with result: " + asyncResult.value);
  } else {
    console.error(asyncResult.error);
  }
});

Ruft ab, ob die Clientsignatur aktiviert ist.

In Outlook im Web und neuen Outlook unter Windows gibt zurücktrue, wenn die Signatur für VerfassentypennewMail , replyoder forwardaktiviert ist. Wenn die Einstellungen in Outlook unter Windows (klassisch) oder auf Mac auf "(none)" festgelegt oder in Outlook im Web oder neuem Outlook unter Windows deaktiviert sind, wird zurückgegebenfalse.

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

Parameter

Gibt zurück

Hinweise

[ API-Satz: Postfach 1.10 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminplaner

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

Gibt zurück

Hinweise

[ API-Satz: Postfach 1.1 ]

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: Terminplaner

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.");
});

Entfernt eine Anlage aus einer Nachricht oder einem Termin.

Die removeAttachmentAsync-Methode entfernt die Anlage mit dem angegebenen Bezeichner aus dem Element. Als bewährte Vorgehensweise sollten Sie den Anlagenbezeichner nur dann zum Entfernen einer Anlage verwenden, wenn die gleiche Mail-App die Anlage in der gleichen Sitzung hinzugefügt hat. 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.

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

Parameter

Gibt zurück

Hinweise

[ API-Satz: Postfach 1.1 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Terminplaner

Wichtig*: Die removeAttachmentAsync -Methode entfernt keine Inlineanlagen aus einem E-Mail-Element. Um eine Inlineanlage zu entfernen, rufen Sie zuerst den Text des Elements ab, und entfernen Sie dann alle Verweise der Anlage aus ihrem Inhalt. Verwenden Sie die Office.Body-APIs , um den Text eines Elements abzurufen und festzulegen.

Fehler:

• InvalidAttachmentId : Der Anlagenbezeichner ist nicht vorhanden.

Beispiele

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

Office.context.mailbox.item.removeAttachmentAsync(
  $("#attachmentId")
    .val()
    .toString(),
  (result) => {
    if (result.status === Office.AsyncResultStatus.Failed) {
      console.error(result.error.message);
      return;
    }

    console.log(`Attachment removed successfully.`);
  }
);

Entfernt eine Anlage aus einer Nachricht oder einem Termin.

Die removeAttachmentAsync-Methode entfernt die Anlage mit dem angegebenen Bezeichner aus dem Element. Als bewährte Vorgehensweise sollten Sie den Anlagenbezeichner nur dann zum Entfernen einer Anlage verwenden, wenn die gleiche Mail-App die Anlage in der gleichen Sitzung hinzugefügt hat. 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.

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

Parameter

Gibt zurück

Hinweise

[ API-Satz: Postfach 1.1 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Terminplaner

Wichtig*: Die removeAttachmentAsync -Methode entfernt keine Inlineanlagen aus einem E-Mail-Element. Um eine Inlineanlage zu entfernen, rufen Sie zuerst den Text des Elements ab, und entfernen Sie dann alle Verweise der Anlage aus ihrem Inhalt. Verwenden Sie die Office.Body-APIs , um den Text eines Elements abzurufen und festzulegen.

Fehler:

• InvalidAttachmentId : Der Anlagenbezeichner ist nicht vorhanden.

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

Gibt zurück

Hinweise

[ API-Satz: Postfach 1.7 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminplaner

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

Gibt zurück

Hinweise

[ API-Satz: Postfach 1.7 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminplaner

Beispiele

Office.context.mailbox.item.removeHandlerAsync(Office.EventType.InfobarClicked, (asyncResult) => {
    if (asyncResult.status === Office.AsyncResultStatus.Failed) {
        console.error("Failed to remove event handler: " + asyncResult.error.message);
        return;
    }

    console.log("Event handler removed successfully.");
});

Speicher asynchron ein Element. .

Da Termine keinen Entwurfszustand haben, wird das Element als normaler Termin im Kalender des Benutzers gespeichert, wenn saveAsync für einen Termin im Verfassenmodus aufgerufen wird. Für neue Termine, die noch nicht gespeichert wurden, wird keine Einladung gesendet. Bei vorhandenen Terminen wird ein Update an hinzugefügte oder entfernte Teilnehmer gesendet.

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

Parameter

Gibt zurück

Hinweise

[ API-Satz: Postfach 1.3 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Terminplaner

Wichtig:

• In Outlook im Web, dem neuen Outlook unter Windows oder dem klassischen Outlook unter Windows im Onlinemodus (nicht zwischengespeicherter Modus) wird das Element auf dem Server gespeichert. In Outlook im Cache-Modus wird das Element im lokalen Cache gespeichert.

• Bei der Arbeit mit HTML-formatierten Inhalten ist es wichtig zu beachten, dass der Outlook-Client den Inhalt ändern kann. Dies bedeutet, dass nachfolgende Aufrufe von Methoden wie Body.getAsync, Body.setAsyncund sogar saveAsync möglicherweise nicht zum gleichen Inhalt führen.

• Der zurückgegebene Bezeichner entspricht dem EwS-Elementbezeichner (Exchange Web Services). 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.

• Wenn Ihr Add-In aufruft saveAsync , um eine Element-ID für die Verwendung mit EWS oder der REST-API abzurufen, beachten Sie, dass es im Zwischenspeichermodus einige Zeit dauern kann, bis das Element tatsächlich mit dem Server synchronisiert wird. Bis das Element synchronisiert ist, gibt die Verwendung der Element-ID einen Fehler zurück.

• In Outlook für Mac unterstützt nur Version 16.35 (20030802) und höher das Speichern einer Besprechung. Andernfalls schlägt die saveAsync Methode fehl, wenn sie aus einer Besprechung im Verfassenmodus aufgerufen wird. Eine Problemumgehung finden Sie unter Kann eine Besprechung nicht als Entwurf in Outlook für Mac mithilfe der Office JS-API speichern.

Fehler:

• InvalidAttachmentId : Der Anlagenbezeichner ist nicht vorhanden.

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/25-item-save-and-close/save.yaml

Office.context.mailbox.item.saveAsync(function (result) {
  if (result.status === Office.AsyncResultStatus.Succeeded) {
    console.log(`saveAsync succeeded, itemId is ${result.value}`);
  }
  else {
    console.error(`saveAsync failed with message ${result.error.message}`);
  }
});

Speicher asynchron ein Element. .

Da Termine keinen Entwurfszustand haben, wird das Element als normaler Termin im Kalender des Benutzers gespeichert, wenn saveAsync für einen Termin im Verfassenmodus aufgerufen wird. Für neue Termine, die noch nicht gespeichert wurden, wird keine Einladung gesendet. Bei vorhandenen Terminen wird ein Update an hinzugefügte oder entfernte Teilnehmer gesendet.

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

Parameter

Gibt zurück

Hinweise

[ API-Satz: Postfach 1.3 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Terminplaner

Wichtig:

• In Outlook im Web, dem neuen Outlook unter Windows oder dem klassischen Outlook unter Windows im Onlinemodus (nicht zwischengespeicherter Modus) wird das Element auf dem Server gespeichert. In Outlook im Cache-Modus wird das Element im lokalen Cache gespeichert.

• Bei der Arbeit mit HTML-formatierten Inhalten ist es wichtig zu beachten, dass der Outlook-Client den Inhalt ändern kann. Dies bedeutet, dass nachfolgende Aufrufe von Methoden wie Body.getAsync, Body.setAsyncund sogar saveAsync möglicherweise nicht zum gleichen Inhalt führen.

• Der zurückgegebene Bezeichner entspricht dem EwS-Elementbezeichner (Exchange Web Services). 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.

• Wenn Ihr Add-In aufruft saveAsync , um eine Element-ID für die Verwendung mit EWS oder der REST-API abzurufen, beachten Sie, dass es im Zwischenspeichermodus einige Zeit dauern kann, bis das Element tatsächlich mit dem Server synchronisiert wird. Bis das Element synchronisiert ist, gibt die Verwendung der Element-ID einen Fehler zurück.

• In Outlook für Mac unterstützt nur Version 16.35 (20030802) und höher das Speichern einer Besprechung. Andernfalls schlägt die saveAsync Methode fehl, wenn sie aus einer Besprechung im Verfassenmodus aufgerufen wird. Eine Problemumgehung finden Sie unter Kann eine Besprechung nicht als Entwurf in Outlook für Mac mithilfe der Office JS-API speichern.

Fehler:

• InvalidAttachmentId : Der Anlagenbezeichner ist nicht vorhanden.

Beispiele

Office.context.mailbox.item.saveAsync(
    function callback(result) {
        // Process the result.
    });

// The following is an example of the
// `result` parameter passed to the
// callback function. The `value`
// property contains the item ID of
// the item.
{
    "value": "AAMkADI5...AAA=",
    "status": "succeeded"
}

Fügt asynchron Daten in den Textkörper oder Betreff einer Nachricht ein.

Die setSelectedDataAsync -Methode fügt die angegebene Zeichenfolge an der Cursorposition im Betreff oder Textkörper des Elements ein oder ersetzt, wenn Text im Editor ausgewählt ist, den markierten Text. Wenn sich der Cursor nicht im Text- oder Betrefffeld befindet, wird ein Fehler zurückgegeben. Nach dem Einfügen wird der Cursor am Ende des eingefügten Inhalts platziert.

setSelectedDataAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parameter

Gibt zurück

Hinweise

[ API-Satz: Postfach 1.2 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Terminplaner

Fehler:

• InvalidAttachmentId : Der Anlagenbezeichner ist nicht vorhanden.

Beispiele

Office.context.mailbox.item.setSelectedDataAsync("<b>Hello World!</b>", { coercionType : "html" });

Office.context.mailbox.item.setSelectedDataAsync("Hello World!");

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

Office.context.mailbox.item.setSelectedDataAsync("Replaced", function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Selected text has been updated successfully.");
  } else {
    console.error(asyncResult.error);
  }
});

Fügt asynchron Daten in den Textkörper oder Betreff einer Nachricht ein.

Die setSelectedDataAsync -Methode fügt die angegebene Zeichenfolge an der Cursorposition im Betreff oder Textkörper des Elements ein oder ersetzt, wenn Text im Editor ausgewählt ist, den markierten Text. Wenn sich der Cursor nicht im Text- oder Betrefffeld befindet, wird ein Fehler zurückgegeben. Nach dem Einfügen wird der Cursor am Ende des eingefügten Inhalts platziert.

setSelectedDataAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parameter

Gibt zurück

Hinweise

[ API-Satz: Postfach 1.2 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Terminplaner

Fehler:

• InvalidAttachmentId : Der Anlagenbezeichner ist nicht vorhanden.