Office.AppointmentCompose interface

Obtient un objet qui fournit des méthodes permettant de manipuler le corps d’un élément.

body: Body;

Valeur de propriété

Remarques

[ Ensemble d’API : Boîte aux lettres 1.1 ]

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : Organisateur de rendez-vous

Exemples

// 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"
}

Obtient un objet qui fournit des méthodes pour gérer les catégories de l’élément.

categories: Categories;

Valeur de propriété

Remarques

[ Ensemble d’API : Boîte aux lettres 1.8 ]

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : Organisateur de rendez-vous

Exemples

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

Obtient ou définit la date et l’heure de fin du rendez-vous.

La end propriété est un objet Time exprimé sous la forme d’une valeur de date et d’heure UTC (Coordinated Universal Time). Vous pouvez utiliser la convertToLocalClientTime méthode pour convertir la valeur de la end propriété en date et heure locales du client.

Quand vous utilisez la méthode Time.setAsync pour définir l’heure de fin, nous vous recommandons d’utiliser la méthode convertToUtcClientTime pour convertir l’heure locale du client au format UTC pour le serveur.

Important : dans le client Windows, vous ne pouvez pas utiliser cette propriété pour mettre à jour la fin d’une périodicité.

end: Time;

Valeur de propriété

Remarques

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : Organisateur de rendez-vous

Exemples

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

Obtient ou définit les emplacements du rendez-vous. La enhancedLocation propriété renvoie un objet EnhancedLocation qui fournit des méthodes pour obtenir, supprimer ou ajouter des emplacements sur un élément.

enhancedLocation: EnhancedLocation;

Valeur de propriété

Remarques

[ Ensemble d’API : Boîte aux lettres 1.8 ]

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : Organisateur de rendez-vous

Exemples

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

Obtient ou définit la propriété Office.IsAllDayEvent d’un rendez-vous.

isAllDayEvent: IsAllDayEvent;

Valeur de propriété

Remarques

[ Ensemble d’API : préversion de boîte aux lettres ]

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : Organisateur de rendez-vous

Exemples

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

Obtient le type d’élément représenté par une instance.

La propriété itemType renvoie une des valeurs d’énumération ItemType indiquant si l’instance d’objet item est un message ou un rendez-vous.

itemType: MailboxEnums.ItemType | string;

Valeur de propriété

Remarques

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : Organisateur de rendez-vous

Exemples

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

Obtient ou définit le lieu d’un rendez-vous. La location propriété renvoie un objet Location qui fournit des méthodes utilisées pour obtenir et définir l’emplacement du rendez-vous.

location: Location;

Valeur de propriété

Remarques

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : Organisateur de rendez-vous

Exemples

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

Obtient les messages de notification pour un élément.

notificationMessages: NotificationMessages;

Valeur de propriété

Remarques

[ Ensemble d’API : Boîte aux lettres 1.3 ]

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : Organisateur de rendez-vous

Exemples

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

Permet d’accéder aux participants facultatifs d’un événement. Le type d’objet et le niveau d’accès dépendent du mode de l’élément actif.

La propriété optionalAttendees renvoie un objet Recipients qui fournit des méthodes permettant d’obtenir ou de mettre à jour les participants facultatifs d’une réunion. Toutefois, en fonction du client/plateforme (par exemple, Windows, Mac, etc.), des limites peuvent s’appliquer au nombre de destinataires que vous pouvez obtenir ou mettre à jour. Pour plus d’informations, consultez l’objet Recipients .

optionalAttendees: Recipients;

Valeur de propriété

Remarques

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : Organisateur de rendez-vous

Exemples

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

Obtient l’organisateur de la réunion spécifiée.

La organizer propriété renvoie un objet Organizer qui fournit une méthode pour obtenir la valeur de l’organisateur.

organizer: Organizer;

Valeur de propriété

Remarques

[ Ensemble d’API : Boîte aux lettres 1.7 ]

Niveau d’autorisation minimal : élément en lecture/écriture

Mode Outlook applicable : Organisateur de rendez-vous

Exemples

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

Obtient ou définit le modèle de périodicité d’un rendez-vous.

La recurrence propriété renvoie un objet de périodicité pour les rendez-vous périodiques ou les demandes de réunions si un élément est une série ou un instance dans une série. null est retourné pour les rendez-vous uniques et les demandes de réunion de rendez-vous uniques.

Remarque : les demandes de réunion ont une itemClass valeur de IPM.Schedule.Meeting.Request.

Remarque : si l’objet de périodicité est null, cela indique que l’objet est un seul rendez-vous ou une demande de réunion d’un seul rendez-vous et non une partie d’une série.

recurrence: Recurrence;

Valeur de propriété

Remarques

[ Ensemble d’API : Boîte aux lettres 1.7 ]

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : Organisateur de rendez-vous

Exemples

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

Permet d’accéder aux participants requis à un événement. Le type d’objet et le niveau d’accès dépendent du mode de l’élément actif.

La propriété requiredAttendees renvoie un objet Recipients qui fournit des méthodes permettant d’obtenir ou de mettre à jour les participants requis à une réunion. Toutefois, en fonction du client/plateforme (par exemple, Windows, Mac, etc.), des limites peuvent s’appliquer au nombre de destinataires que vous pouvez obtenir ou mettre à jour. Pour plus d’informations, consultez l’objet Recipients .

requiredAttendees: Recipients;

Valeur de propriété

Remarques

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : Organisateur de rendez-vous

Exemples

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

Obtient ou définit le niveau de confidentialité d’un rendez-vous. Pour plus d’informations sur les niveaux de confidentialité, consultez Marquer votre e-mail comme normal, personnel, privé ou confidentiel.

sensitivity: Sensitivity;

Valeur de propriété

Remarques

[ Ensemble d’API : Boîte aux lettres 1.14 ]

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : Organisateur de rendez-vous

Important : Outlook sur le web, les nouveaux outlook sur Windows et Outlook sur Mac prennent uniquement en charge les niveaux de confidentialité Normal et Privé.

Exemples

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

Obtient l’objet pour obtenir ou définir l’étiquette de confidentialité d’un rendez-vous.

sensitivityLabel: SensitivityLabel;

Valeur de propriété

Remarques

[ Ensemble d’API : Boîte aux lettres 1.13 ]

Niveau d’autorisation minimal : élément en lecture/écriture

Mode Outlook applicable : Organisateur de rendez-vous

Important : Pour utiliser la fonctionnalité d’étiquette de confidentialité dans votre complément, vous devez disposer d’un abonnement Microsoft 365 E5.

Pour en savoir plus sur la gestion des étiquettes de confidentialité dans votre complément, consultez Gérer l’étiquette de confidentialité de votre message ou rendez-vous en mode composition.

Exemples

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

Obtient l’ID de la série à laquelle appartient un instance.

Dans Outlook sur le web, sur Windows (nouveau et classique) et sur Mac, la seriesId propriété renvoie l’ID des services web Exchange (EWS) de l’élément parent (série) auquel cet élément appartient. Toutefois, dans Outlook sur Android et sur iOS, seriesId retourne l’ID REST de l’élément parent.

Remarque : l’identificateur retourné par la seriesId propriété est le même que l’identificateur d’élément des services Web Exchange. La seriesId propriété n’est pas identique aux ID Outlook utilisés par l’API REST Outlook. Avant d’effectuer des appels d’API REST à l’aide de cette valeur, vous devez la convertir à l’aide Office.context.mailbox.convertToRestIdde . Pour plus d’informations, voir Utiliser les API REST Outlook à partir d’un complément Outlook.

La seriesId propriété retourne null pour les éléments qui n’ont pas d’éléments parents tels que des rendez-vous uniques, des éléments de série ou des demandes de réunion, et retourne undefined pour tous les autres éléments qui ne sont pas des demandes de réunion.

seriesId: string;

Valeur de propriété

Remarques

[ Ensemble d’API : Boîte aux lettres 1.7 ]

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : Organisateur de rendez-vous

Exemples

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

Gère sessionData d’un élément en mode Compose.

Important : l’objet SessionData entier est limité à 50 000 caractères par complément.

sessionData: SessionData;

Valeur de propriété

Remarques

[ Ensemble d’API : Boîte aux lettres 1.11 ]

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : Organisateur de rendez-vous

Exemples

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

Obtient ou définit la date et l’heure de début du rendez-vous.

La start propriété est un objet Time exprimé sous la forme d’une valeur de date et d’heure UTC (Coordinated Universal Time). Vous pouvez utiliser la convertToLocalClientTime méthode pour convertir la valeur en date et heure locales du client.

Quand vous utilisez la méthode Time.setAsync pour définir l’heure de début, nous vous recommandons d’utiliser la méthode convertToUtcClientTime pour convertir l’heure locale du client au format UTC pour le serveur.

Important : Dans le client Windows, vous ne pouvez pas utiliser cette propriété pour mettre à jour le début d’une périodicité.

start: Time;

Valeur de propriété

Remarques

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : Organisateur de rendez-vous

Exemples

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

Obtient ou définit la description qui apparaît dans le champ d’objet d’un élément.

La propriété subject obtient ou définit l’intégralité de l’objet de l’élément, tel qu’il est envoyé par le serveur de messagerie.

La propriété subject renvoie un objet Subject qui fournit des méthodes pour obtenir et définir l’objet.

subject: Subject;

Valeur de propriété

Remarques

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : Organisateur de rendez-vous

Exemples

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

Ajoute un fichier à un message ou un rendez-vous en pièce jointe.

La méthode addFileAttachmentAsync charge le fichier depuis l’URI spécifié et le joint à l’élément dans le formulaire de composition.

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

Paramètres

Retours

Remarques

[ Ensemble d’API : Boîte aux lettres 1.1 pour Outlook sur Windows (classique) et sur Mac, Boîte aux lettres 1.8 pour Outlook sur le web et nouveau Outlook sur Windows ]

Niveau d’autorisation minimal : élément en lecture/écriture

Mode Outlook applicable : Organisateur de rendez-vous

Important:

• Cette méthode n’est pas prise en charge dans Outlook sur iOS ou Android. Pour plus d’informations sur les API prises en charge dans Outlook Mobile, consultez API JavaScript Outlook prises en charge dans Outlook sur les appareils mobiles.

• Dans les versions récentes d’Outlook classique sur Windows, un bogue a été introduit qui ajoute incorrectement un Authorization: Bearer en-tête à cette action (que ce soit à l’aide de cette API ou de l’interface utilisateur Outlook). Pour contourner ce problème, utilisez l’API introduite avec l’ensemble addFileAttachmentFromBase64 de conditions requises 1.8.

• L’URI du fichier à joindre doit prendre en charge la mise en cache en production. Le serveur hébergeant l’image ne doit pas retourner d’en-tête Cache-Control qui spécifie no-cache, no-storeou des options similaires dans la réponse HTTP. Toutefois, lorsque vous développez le complément et apportez des modifications aux fichiers, la mise en cache peut vous empêcher de voir vos modifications. Nous vous recommandons d’utiliser Cache-Control des en-têtes pendant le développement.

• Vous pouvez utiliser le même URI avec la removeAttachmentAsync méthode pour supprimer la pièce jointe dans la même session.

Erreurs :

• AttachmentSizeExceeded : la pièce jointe est plus grande que ce qui est autorisé.

• FileTypeNotSupported : la pièce jointe a une extension qui n’est pas autorisée.

• NumberOfAttachmentsExceeded : le message ou le rendez-vous contient trop de pièces jointes.

Exemples

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

Ajoute un fichier à un message ou un rendez-vous en pièce jointe.

La méthode addFileAttachmentAsync charge le fichier depuis l’URI spécifié et le joint à l’élément dans le formulaire de composition.

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

Paramètres

Retours

Remarques

[ Ensemble d’API : Boîte aux lettres 1.1 pour Outlook sur Windows (classique) et sur Mac, Boîte aux lettres 1.8 pour Outlook sur le web et nouveau Outlook sur Windows ]

Niveau d’autorisation minimal : élément en lecture/écriture

Mode Outlook applicable : Organisateur de rendez-vous

Important:

• Cette méthode n’est pas prise en charge dans Outlook sur iOS ou Android. Pour plus d’informations sur les API prises en charge dans Outlook Mobile, consultez API JavaScript Outlook prises en charge dans Outlook sur les appareils mobiles.

• Dans les versions récentes d’Outlook classique sur Windows, un bogue a été introduit qui ajoute incorrectement un Authorization: Bearer en-tête à cette action (que ce soit à l’aide de cette API ou de l’interface utilisateur Outlook). Pour contourner ce problème, utilisez l’API introduite avec l’ensemble addFileAttachmentFromBase64 de conditions requises 1.8.

• L’URI du fichier à joindre doit prendre en charge la mise en cache en production. Le serveur hébergeant l’image ne doit pas retourner d’en-tête Cache-Control qui spécifie no-cache, no-storeou des options similaires dans la réponse HTTP. Toutefois, lorsque vous développez le complément et apportez des modifications aux fichiers, la mise en cache peut vous empêcher de voir vos modifications. Nous vous recommandons d’utiliser Cache-Control des en-têtes pendant le développement.

• Vous pouvez utiliser le même URI avec la removeAttachmentAsync méthode pour supprimer la pièce jointe dans la même session.

Erreurs :

• AttachmentSizeExceeded : la pièce jointe est plus grande que ce qui est autorisé.

• FileTypeNotSupported : la pièce jointe a une extension qui n’est pas autorisée.

• NumberOfAttachmentsExceeded : le message ou le rendez-vous contient trop de pièces jointes.

Ajoute un fichier à un message ou un rendez-vous en pièce jointe.

La addFileAttachmentFromBase64Async méthode charge le fichier à partir de l’encodage Base64 et l’attache à l’élément dans le formulaire de composition. Cette méthode retourne l’identificateur de pièce jointe dans l’objet asyncResult.value .

L’identificateur peut être utilisé avec la méthode removeAttachmentAsync pour supprimer la pièce jointe dans la même session.

Remarque : Si vous utilisez une API d’URL de données (par exemple, ), vous devez supprimer le préfixe d’URL de données, readAsDataURLpuis envoyer le reste de la chaîne à cette API. Par exemple, si la chaîne complète est représentée par data:image/svg+xml;base64,<rest of Base64 string>, supprimez data:image/svg+xml;base64,.

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

Paramètres

Retours

Remarques

[ Ensemble d’API : Boîte aux lettres 1.8 ]

Niveau d’autorisation minimal : élément en lecture/écriture

Mode Outlook applicable : Organisateur de rendez-vous

Erreurs :

• AttachmentSizeExceeded : la pièce jointe est plus grande que ce qui est autorisé.

• FileTypeNotSupported : la pièce jointe a une extension qui n’est pas autorisée.

• NumberOfAttachmentsExceeded : le message ou le rendez-vous contient trop de pièces jointes.

Remarque : Si vous ajoutez une image Base64 inline au corps d’un message ou d’un rendez-vous en cours de composition, vous devez d’abord obtenir le corps de l’élément actuel à l’aide de la méthode Office.context.mailbox.item.body.getAsync avant d’insérer l’image à l’aide addFileAttachmentFromBase64Asyncde . Sinon, l’image ne s’affichera pas dans le corps une fois insérée. Pour plus d’informations, consultez Joindre un fichier.

Exemples

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

Ajoute un fichier à un message ou un rendez-vous en pièce jointe.

La addFileAttachmentFromBase64Async méthode charge le fichier à partir de l’encodage Base64 et l’attache à l’élément dans le formulaire de composition. Cette méthode retourne l’identificateur de pièce jointe dans l’objet asyncResult.value .

L’identificateur peut être utilisé avec la méthode removeAttachmentAsync pour supprimer la pièce jointe dans la même session.

Remarque : Si vous utilisez une API d’URL de données (par exemple, ), vous devez supprimer le préfixe d’URL de données, readAsDataURLpuis envoyer le reste de la chaîne à cette API. Par exemple, si la chaîne complète est représentée par data:image/svg+xml;base64,<rest of Base64 string>, supprimez data:image/svg+xml;base64,.

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

Paramètres

Retours

Remarques

[ Ensemble d’API : Boîte aux lettres 1.8 ]

Niveau d’autorisation minimal : élément en lecture/écriture

Mode Outlook applicable : Organisateur de rendez-vous

Erreurs :

• AttachmentSizeExceeded : la pièce jointe est plus grande que ce qui est autorisé.

• FileTypeNotSupported : la pièce jointe a une extension qui n’est pas autorisée.

• NumberOfAttachmentsExceeded : le message ou le rendez-vous contient trop de pièces jointes.

Remarque : Si vous ajoutez une image Base64 inline au corps d’un message ou d’un rendez-vous en cours de composition, vous devez d’abord obtenir le corps de l’élément actuel à l’aide de la méthode Office.context.mailbox.item.body.getAsync avant d’insérer l’image à l’aide addFileAttachmentFromBase64Asyncde . Sinon, l’image ne s’affichera pas dans le corps une fois insérée. Pour plus d’informations, consultez Joindre un fichier.

ajoute un gestionnaire d’événements pour un événement pris en charge. Remarque : les événements sont disponibles uniquement avec l’implémentation du volet Office.

Pour les événements pris en charge, reportez-vous à la section Événements du modèle objet Item.

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

Paramètres

Retours

Remarques

[ Ensemble d’API : Boîte aux lettres 1.7 ]

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : Organisateur de rendez-vous

Exemples

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

ajoute un gestionnaire d’événements pour un événement pris en charge. Remarque : les événements sont disponibles uniquement avec l’implémentation du volet Office.

Pour les événements pris en charge, reportez-vous à la section Événements du modèle objet Item.

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

Paramètres

Retours

Remarques

[ Ensemble d’API : Boîte aux lettres 1.7 ]

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : Organisateur de rendez-vous

Ajoute un élément Exchange, comme un message, en pièce jointe au message ou au rendez-vous.

La méthode addItemAttachmentAsync joint l’élément avec l’identificateur Exchange spécifié à l’élément du formulaire de composition. Si vous spécifiez une fonction de rappel, la méthode est appelée avec un paramètre, asyncResult, qui contient l’identificateur de pièce jointe ou un code qui indique toute erreur qui s’est produite lors de l’attachement de l’élément. Vous pouvez utiliser le options paramètre pour transmettre des informations d’état à la fonction de rappel, si nécessaire.

L’identificateur peut être utilisé avec la méthode removeAttachmentAsync pour supprimer la pièce jointe dans la même session.

Si votre complément Office s’exécute dans Outlook sur le web et outlook sur Windows, la addItemAttachmentAsync méthode peut attacher des éléments à des éléments autres que l’élément que vous modifiez. Toutefois, cela n’est pas pris en charge et n’est pas recommandé.

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

Paramètres

Retours

Remarques

[ Ensemble d’API : Boîte aux lettres 1.1 ]

Niveau d’autorisation minimal : élément en lecture/écriture

Mode Outlook applicable : Organisateur de rendez-vous

Erreurs :

• NumberOfAttachmentsExceeded : le message ou le rendez-vous contient trop de pièces jointes.

Exemples

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

Ajoute un élément Exchange, comme un message, en pièce jointe au message ou au rendez-vous.

La méthode addItemAttachmentAsync joint l’élément avec l’identificateur Exchange spécifié à l’élément du formulaire de composition. Si vous spécifiez une fonction de rappel, la méthode est appelée avec un paramètre, asyncResult, qui contient l’identificateur de pièce jointe ou un code qui indique toute erreur qui s’est produite lors de l’attachement de l’élément. Vous pouvez utiliser le options paramètre pour transmettre des informations d’état à la fonction de rappel, si nécessaire.

L’identificateur peut être utilisé avec la méthode removeAttachmentAsync pour supprimer la pièce jointe dans la même session.

Si votre complément Office s’exécute dans Outlook sur le web et outlook sur Windows, la addItemAttachmentAsync méthode peut attacher des éléments à des éléments autres que l’élément que vous modifiez. Toutefois, cela n’est pas pris en charge et n’est pas recommandé.

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

Paramètres

Retours

Remarques

[ Ensemble d’API : Boîte aux lettres 1.1 ]

Niveau d’autorisation minimal : élément en lecture/écriture

Mode Outlook applicable : Organisateur de rendez-vous

Erreurs :

• NumberOfAttachmentsExceeded : le message ou le rendez-vous contient trop de pièces jointes.

Ferme l’élément en cours qui est composé.

Le comportement de la méthode close dépend de l’état actuel de l’élément en cours de composition. Si l’élément a des modifications non enregistrées, le client invite l’utilisateur à enregistrer, à ignorer ou à fermer l’action.

Dans Outlook sur Windows (classique) et sur Mac, la close méthode n’a aucun effet sur une réponse dans le volet de lecture.

close(): void;

Retours

Remarques

[ Ensemble d’API : Boîte aux lettres 1.3 ]

Niveau d’autorisation minimal : restreint

Mode Outlook applicable : Organisateur de rendez-vous

Important : dans Outlook sur le web et outlook sur Windows, si l’élément est un rendez-vous et qu’il a déjà été enregistré à l’aide saveAsyncde , l’utilisateur est invité à enregistrer, à ignorer ou à annuler même si aucune modification n’a eu lieu depuis le dernier enregistrement de l’élément.

Exemples

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

Désactive la signature du client Outlook.

Dans Outlook sur Windows (classique) et sur Mac, cette API définit la signature sous les sections « Nouveau message » et « Réponses/Transfert » du compte d’envoi sur « (aucun) », désactivant ainsi la signature. Dans Outlook sur le web et outlook sur Windows, l’API désactive l’option de signature pour les nouveaux messages, réponses et transfert. Si la signature est sélectionnée, cet appel d’API la désactive.

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

Paramètres

Retours

Remarques

[ Ensemble d’API : Boîte aux lettres 1.10 ]

Niveau d’autorisation minimal : élément en lecture/écriture

Mode Outlook applicable : Organisateur de rendez-vous

Exemples

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

Désactive la signature du client Outlook.

Dans Outlook sur Windows (classique) et sur Mac, cette API définit la signature sous les sections « Nouveau message » et « Réponses/Transfert » du compte d’envoi sur « (aucun) », désactivant ainsi la signature. Dans Outlook sur le web et outlook sur Windows, l’API désactive l’option de signature pour les nouveaux messages, réponses et transfert. Si la signature est sélectionnée, cet appel d’API la désactive.

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

Paramètres

Retours

Remarques

[ Ensemble d’API : Boîte aux lettres 1.10 ]

Niveau d’autorisation minimal : élément en lecture/écriture

Mode Outlook applicable : Organisateur de rendez-vous

Obtient une pièce jointe à partir d’un message ou d’un rendez-vous et la renvoie en tant qu’objet AttachmentContent .

La getAttachmentContentAsync méthode obtient la pièce jointe avec l’identificateur spécifié à partir de l’élément. Il est recommandé d’obtenir l’identificateur de la pièce jointe à partir d’un getAttachmentsAsync appel, puis, dans la même session, d’utiliser cet identificateur pour récupérer la pièce jointe. Dans Outlook sur le web, sur les appareils mobiles et dans le nouvel Outlook sur Windows, l’identificateur de pièce jointe n’est valide que dans la même session. Une session est terminée lorsque l’utilisateur ferme l’application, ou si l’utilisateur commence à composer un formulaire inline, puis affiche ensuite le formulaire pour continuer dans une fenêtre distincte.

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

Paramètres

Retours

Remarques

[ Ensemble d’API : Boîte aux lettres 1.8 ]

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : Organisateur de rendez-vous

Erreurs :

• AttachmentTypeNotSupported : le type de pièce jointe n’est pas pris en charge. Les types non pris en charge incluent des images incorporées au format TEXTE enrichi ou des types de pièces jointes autres que les éléments de courrier électronique ou de calendrier (par exemple, un contact ou un élément de tâche).

• InvalidAttachmentId : l’identificateur de pièce jointe n’existe pas.

Exemples

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

Obtient une pièce jointe à partir d’un message ou d’un rendez-vous et la renvoie en tant qu’objet AttachmentContent .

La getAttachmentContentAsync méthode obtient la pièce jointe avec l’identificateur spécifié à partir de l’élément. Il est recommandé d’obtenir l’identificateur de la pièce jointe à partir d’un getAttachmentsAsync appel, puis, dans la même session, d’utiliser cet identificateur pour récupérer la pièce jointe. Dans Outlook sur le web, sur les appareils mobiles et dans le nouvel Outlook sur Windows, l’identificateur de pièce jointe n’est valide que dans la même session. Une session est terminée lorsque l’utilisateur ferme l’application, ou si l’utilisateur commence à composer un formulaire inline, puis affiche ensuite le formulaire pour continuer dans une fenêtre distincte.

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

Paramètres

Retours

Remarques

[ Ensemble d’API : Boîte aux lettres 1.8 ]

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : Organisateur de rendez-vous

Erreurs :

• AttachmentTypeNotSupported : le type de pièce jointe n’est pas pris en charge. Les types non pris en charge incluent des images incorporées au format TEXTE enrichi ou des types de pièces jointes autres que les éléments de courrier électronique ou de calendrier (par exemple, un contact ou un élément de tâche).

• InvalidAttachmentId : l’identificateur de pièce jointe n’existe pas.

Obtient les pièces jointes de l’élément sous forme de tableau.

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

Paramètres

Retours

Remarques

[ Ensemble d’API : Boîte aux lettres 1.8 ]

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : Organisateur de rendez-vous

Exemples

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

Obtient les pièces jointes de l’élément sous forme de tableau.

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

Paramètres

Retours

Remarques

[ Ensemble d’API : Boîte aux lettres 1.8 ]

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : Organisateur de rendez-vous

Obtient les données d’initialisation transmises lorsque le complément est activé par un message actionnable.

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

Paramètres

Retours

Remarques

[ Ensemble d’API : Boîte aux lettres 1.8 ]

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : Organisateur de rendez-vous

Exemples

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

Obtient les données d’initialisation transmises lorsque le complément est activé par un message actionnable.

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

Paramètres

Retours

Remarques

[ Ensemble d’API : Boîte aux lettres 1.8 ]

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : Organisateur de rendez-vous

Obtient de façon asynchrone l’identificateur d’élément EWS (Exchange Web Services) d’un élément enregistré.

Lorsqu’elle est appelée, cette méthode retourne l’ID d’élément via la fonction de rappel.

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

Paramètres

Retours

Remarques

[ Ensemble d’API : Boîte aux lettres 1.8 ]

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : Organisateur de rendez-vous

Important:

• L’ID d’élément retourné n’est pas identique à l’ID d’entrée Outlook ou à l’ID utilisé par l’API REST Outlook. Avant d’effectuer des appels d’API REST à l’aide de cette valeur, vous devez la convertir à l’aide Office.context.mailbox.convertToRestIdde .

• Si votre complément appelle getItemIdAsync (par exemple, pour obtenir un ID d’élément à utiliser avec EWS ou l’API REST), sachez que lorsque Outlook est en mode mis en cache, la synchronisation de l’élément avec le serveur peut prendre un certain temps. Tant que l’élément n’est pas synchronisé, l’ID d’élément n’est pas reconnu et son utilisation retourne une erreur.

Erreurs :

• ItemNotSaved : l’ID ne peut pas être récupéré tant que l’élément n’est pas enregistré.

Obtient de façon asynchrone l’identificateur d’élément EWS (Exchange Web Services) d’un élément enregistré.

Lorsqu’elle est appelée, cette méthode retourne l’ID d’élément via la fonction de rappel.

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

Paramètres

Retours

Remarques

[ Ensemble d’API : Boîte aux lettres 1.8 ]

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : Organisateur de rendez-vous

Important:

• L’ID d’élément retourné n’est pas identique à l’ID d’entrée Outlook ou à l’ID utilisé par l’API REST Outlook. Avant d’effectuer des appels d’API REST à l’aide de cette valeur, vous devez la convertir à l’aide Office.context.mailbox.convertToRestIdde .

• Si votre complément appelle getItemIdAsync (par exemple, pour obtenir un ID d’élément à utiliser avec EWS ou l’API REST), sachez que lorsque Outlook est en mode mis en cache, la synchronisation de l’élément avec le serveur peut prendre un certain temps. Tant que l’élément n’est pas synchronisé, l’ID d’élément n’est pas reconnu et son utilisation retourne une erreur.

Erreurs :

• ItemNotSaved : l’ID ne peut pas être récupéré tant que l’élément n’est pas enregistré.

Exemples

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

Renvoie de manière asynchrone les données sélectionnées à partir de l’objet ou du corps d’un message.

S’il n’y a pas de sélection mais que le curseur se trouve dans le corps ou l’objet, la méthode retourne une chaîne vide pour les données sélectionnées. Si un champ autre que le corps ou l’objet est sélectionné, la méthode renvoie l’erreur InvalidSelection.

Pour accéder aux données sélectionnées à partir de la fonction de rappel, appelez asyncResult.value.data. Pour accéder à la source propriété d’où provient la sélection, appelezasyncResult.value.sourceProperty , qui sera ou bodysubject.

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

Paramètres

Retours

Données sélectionnées sous forme de chaîne dont le format est déterminé par coercionType.

Remarques

[ Ensemble d’API : Boîte aux lettres 1.2 ]

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : Organisateur de rendez-vous

Exemples

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

Renvoie de manière asynchrone les données sélectionnées à partir de l’objet ou du corps d’un message.

S’il n’y a pas de sélection mais que le curseur se trouve dans le corps ou l’objet, la méthode retourne une chaîne vide pour les données sélectionnées. Si un champ autre que le corps ou l’objet est sélectionné, la méthode renvoie l’erreur InvalidSelection.

Pour accéder aux données sélectionnées à partir de la fonction de rappel, appelez asyncResult.value.data. Pour accéder à la source propriété d’où provient la sélection, appelezasyncResult.value.sourceProperty , qui sera ou bodysubject.

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

Paramètres

Retours

Données sélectionnées sous forme de chaîne dont le format est déterminé par coercionType.

Remarques

[ Ensemble d’API : Boîte aux lettres 1.2 ]

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : Organisateur de rendez-vous

Exemples

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

Obtient les propriétés d’un rendez-vous ou d’un message dans un dossier partagé ou une boîte aux lettres partagée.

Pour plus d’informations sur l’utilisation de cette API, voir Activer les dossiers partagés et les scénarios de boîte aux lettres partagées dans un complément Outlook.

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

Paramètres

Retours

Remarques

[ Ensemble d’API : Boîte aux lettres 1.8 pour la prise en charge des dossiers partagés, Boîte aux lettres 1.13 pour la prise en charge des boîtes aux lettres partagées ]

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : Organisateur de rendez-vous

Remarque : cette méthode n’est pas prise en charge dans Outlook sur iOS ou sur Android.

Obtient les propriétés d’un rendez-vous ou d’un message dans un dossier partagé ou une boîte aux lettres partagée.

Pour plus d’informations sur l’utilisation de cette API, voir Activer les dossiers partagés et les scénarios de boîte aux lettres partagées dans un complément Outlook.

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

Paramètres

Retours

Remarques

[ Ensemble d’API : Boîte aux lettres 1.8 pour la prise en charge des dossiers partagés, Boîte aux lettres 1.13 pour la prise en charge des boîtes aux lettres partagées ]

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : Organisateur de rendez-vous

Remarque : cette méthode n’est pas prise en charge dans Outlook sur iOS ou sur Android.

Exemples

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

Obtient si la signature du client est activée.

Dans Outlook sur le web et outlook sur Windows, retourne true si la signature est activée pour les typesnewMail de composition , replyou forward. Si les paramètres sont définis sur « (aucun) » dans Outlook sur Windows (classique) ou sur Mac, ou désactivés dans Outlook sur le web ou nouveau Outlook sur Windows, retourne false.

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

Paramètres

Retours

Remarques

[ Ensemble d’API : Boîte aux lettres 1.10 ]

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : Organisateur de rendez-vous

Exemples

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

Obtient si la signature du client est activée.

Dans Outlook sur le web et outlook sur Windows, retourne true si la signature est activée pour les typesnewMail de composition , replyou forward. Si les paramètres sont définis sur « (aucun) » dans Outlook sur Windows (classique) ou sur Mac, ou désactivés dans Outlook sur le web ou nouveau Outlook sur Windows, retourne false.

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

Paramètres

Retours

Remarques

[ Ensemble d’API : Boîte aux lettres 1.10 ]

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : Organisateur de rendez-vous

Charge de manière asynchrone les propriétés personnalisées de ce complément vers l’élément sélectionné.

Les propriétés personnalisées sont stockées sous forme de paires clé-valeur par application et par élément. Cette méthode renvoie un objet CustomProperties dans le rappel, qui fournit des méthodes pour accéder aux propriétés personnalisées spécifiques à l’élément actuel et au complément actuel. Les propriétés personnalisées ne sont pas chiffrées sur l’élément. Il ne doit donc pas être utilisé comme stockage sécurisé.

Les propriétés personnalisées sont fournies sous la forme d’un objet CustomProperties dans la propriété asyncResult.value. Cet objet peut être utilisé pour obtenir, définir, enregistrer et supprimer des propriétés personnalisées de l’élément de courrier.

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

Paramètres

Retours

Remarques

[ Ensemble d’API : Boîte aux lettres 1.1 ]

Pour en savoir plus sur les propriétés personnalisées, voir Obtenir et définir des métadonnées de complément pour un complément Outlook.

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : Organisateur de rendez-vous

Exemples

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

Supprime une pièce jointe d’un message ou d’un rendez-vous.

La méthode removeAttachmentAsync supprime la pièce jointe avec l’identificateur spécifié de l’élément. Nous vous recommandons vivement de supprimer une pièce jointe à l’aide de son identificateur uniquement si la même application de messagerie a ajouté cette pièce jointe au cours de la même session. Dans Outlook sur le web, sur les appareils mobiles et dans le nouvel Outlook sur Windows, l’identificateur de pièce jointe n’est valide que dans la même session. Une session est terminée lorsque l’utilisateur ferme l’application, ou si l’utilisateur commence à composer un formulaire inline, puis affiche ensuite le formulaire pour continuer dans une fenêtre distincte.

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

Paramètres

Retours

Remarques

[ Ensemble d’API : Boîte aux lettres 1.1 ]

Niveau d’autorisation minimal : élément en lecture/écriture

Mode Outlook applicable : Organisateur de rendez-vous

Important* : la removeAttachmentAsync méthode ne supprime pas les pièces jointes inline d’un élément de courrier. Pour supprimer une pièce jointe inline, commencez par obtenir le corps de l’élément, puis supprimez toutes les références de la pièce jointe de son contenu. Utilisez les API Office.Body pour obtenir et définir le corps d’un élément.

Erreurs :

• InvalidAttachmentId : l’identificateur de pièce jointe n’existe pas.

Exemples

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

Supprime une pièce jointe d’un message ou d’un rendez-vous.

La méthode removeAttachmentAsync supprime la pièce jointe avec l’identificateur spécifié de l’élément. Nous vous recommandons vivement de supprimer une pièce jointe à l’aide de son identificateur uniquement si la même application de messagerie a ajouté cette pièce jointe au cours de la même session. Dans Outlook sur le web, sur les appareils mobiles et dans le nouvel Outlook sur Windows, l’identificateur de pièce jointe n’est valide que dans la même session. Une session est terminée lorsque l’utilisateur ferme l’application, ou si l’utilisateur commence à composer un formulaire inline, puis affiche ensuite le formulaire pour continuer dans une fenêtre distincte.

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

Paramètres

Retours

Remarques

[ Ensemble d’API : Boîte aux lettres 1.1 ]

Niveau d’autorisation minimal : élément en lecture/écriture

Mode Outlook applicable : Organisateur de rendez-vous

Important* : la removeAttachmentAsync méthode ne supprime pas les pièces jointes inline d’un élément de courrier. Pour supprimer une pièce jointe inline, commencez par obtenir le corps de l’élément, puis supprimez toutes les références de la pièce jointe de son contenu. Utilisez les API Office.Body pour obtenir et définir le corps d’un élément.

Erreurs :

• InvalidAttachmentId : l’identificateur de pièce jointe n’existe pas.

Supprime les gestionnaires d’événements pour un type d’événement pris en charge. Remarque : les événements sont disponibles uniquement avec l’implémentation du volet Office.

Pour les événements pris en charge, reportez-vous à la section Événements du modèle objet Item.

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

Paramètres

Retours

Remarques

[ Ensemble d’API : Boîte aux lettres 1.7 ]

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : Organisateur de rendez-vous

Supprime les gestionnaires d’événements pour un type d’événement pris en charge. Remarque : les événements sont disponibles uniquement avec l’implémentation du volet Office.

Pour les événements pris en charge, reportez-vous à la section Événements du modèle objet Item.

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

Paramètres

Retours

Remarques

[ Ensemble d’API : Boîte aux lettres 1.7 ]

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : Organisateur de rendez-vous

Exemples

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

Enregistre un élément de manière asynchrone.

Étant donné que les rendez-vous n’ont pas d’état brouillon, si saveAsync est appelé sur un rendez-vous en mode composition, l’élément est enregistré en tant que rendez-vous normal dans le calendrier de l’utilisateur. Pour les nouveaux rendez-vous qui n’ont pas été enregistrés auparavant, aucune invitation n’est envoyée. Pour les rendez-vous existants, une mise à jour est envoyée aux participants ajoutés ou supprimés.

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

Paramètres

Retours

Remarques

[ Ensemble d’API : Boîte aux lettres 1.3 ]

Niveau d’autorisation minimal : élément en lecture/écriture

Mode Outlook applicable : Organisateur de rendez-vous

Important:

• Dans Outlook sur le web, nouvel Outlook sur Windows ou Outlook classique sur Windows en mode en ligne (mode non mis en cache), l’élément est enregistré sur le serveur. Dans Outlook en mode mis en cache, l’élément est enregistré dans le cache local.

• Lorsque vous utilisez du contenu au format HTML, il est important de noter que le client Outlook peut modifier le contenu. Cela signifie que les appels ultérieurs à des méthodes comme Body.getAsync, Body.setAsyncet saveAsync même peuvent ne pas aboutir au même contenu.

• L’identificateur retourné est identique à l’identificateur d’élément EWS (Exchange Web Services). L’ID d’élément retourné n’est pas identique à l’ID d’entrée Outlook ou à l’ID utilisé par l’API REST Outlook. Avant d’effectuer des appels d’API REST à l’aide de cette valeur, vous devez la convertir à l’aide Office.context.mailbox.convertToRestIdde .

• Si votre complément appelle saveAsync pour obtenir un ID d’élément à utiliser avec EWS ou l’API REST, sachez que lorsque Outlook est en mode mis en cache, la synchronisation de l’élément sur le serveur peut prendre un certain temps. Tant que l’élément n’est pas synchronisé, l’utilisation de l’ID d’élément renvoie une erreur.

• Dans Outlook sur Mac, seule la version 16.35 (20030802) et les versions ultérieures prennent en charge l’enregistrement d’une réunion. Sinon, la méthode échoue lorsqu’elle saveAsync est appelée à partir d’une réunion en mode composition. Pour une solution de contournement, voir Impossible d’enregistrer une réunion en tant que brouillon dans Outlook pour Mac à l’aide de l’API Office JS.

Erreurs :

• InvalidAttachmentId : l’identificateur de pièce jointe n’existe pas.

Exemples

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

Enregistre un élément de manière asynchrone.

Étant donné que les rendez-vous n’ont pas d’état brouillon, si saveAsync est appelé sur un rendez-vous en mode composition, l’élément est enregistré en tant que rendez-vous normal dans le calendrier de l’utilisateur. Pour les nouveaux rendez-vous qui n’ont pas été enregistrés auparavant, aucune invitation n’est envoyée. Pour les rendez-vous existants, une mise à jour est envoyée aux participants ajoutés ou supprimés.

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

Paramètres

Retours

Remarques

[ Ensemble d’API : Boîte aux lettres 1.3 ]

Niveau d’autorisation minimal : élément en lecture/écriture

Mode Outlook applicable : Organisateur de rendez-vous

Important:

• Dans Outlook sur le web, nouvel Outlook sur Windows ou Outlook classique sur Windows en mode en ligne (mode non mis en cache), l’élément est enregistré sur le serveur. Dans Outlook en mode mis en cache, l’élément est enregistré dans le cache local.

• Lorsque vous utilisez du contenu au format HTML, il est important de noter que le client Outlook peut modifier le contenu. Cela signifie que les appels ultérieurs à des méthodes comme Body.getAsync, Body.setAsyncet saveAsync même peuvent ne pas aboutir au même contenu.

• L’identificateur retourné est identique à l’identificateur d’élément EWS (Exchange Web Services). L’ID d’élément retourné n’est pas identique à l’ID d’entrée Outlook ou à l’ID utilisé par l’API REST Outlook. Avant d’effectuer des appels d’API REST à l’aide de cette valeur, vous devez la convertir à l’aide Office.context.mailbox.convertToRestIdde .

• Si votre complément appelle saveAsync pour obtenir un ID d’élément à utiliser avec EWS ou l’API REST, sachez que lorsque Outlook est en mode mis en cache, la synchronisation de l’élément sur le serveur peut prendre un certain temps. Tant que l’élément n’est pas synchronisé, l’utilisation de l’ID d’élément renvoie une erreur.

• Dans Outlook sur Mac, seule la version 16.35 (20030802) et les versions ultérieures prennent en charge l’enregistrement d’une réunion. Sinon, la méthode échoue lorsqu’elle saveAsync est appelée à partir d’une réunion en mode composition. Pour une solution de contournement, voir Impossible d’enregistrer une réunion en tant que brouillon dans Outlook pour Mac à l’aide de l’API Office JS.

Erreurs :

• InvalidAttachmentId : l’identificateur de pièce jointe n’existe pas.

Exemples

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

Insère les données dans le corps ou l’objet d’un message de manière asynchrone.

La setSelectedDataAsync méthode insère la chaîne spécifiée à l’emplacement du curseur dans l’objet ou le corps de l’élément, ou, si du texte est sélectionné dans l’éditeur, elle remplace le texte sélectionné. Si le curseur ne se trouve pas dans le champ body ou subject, une erreur est retournée. Après l’insertion, le curseur est placé à la fin du contenu inséré.

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

Paramètres

Retours

Remarques

[ Ensemble d’API : Boîte aux lettres 1.2 ]

Niveau d’autorisation minimal : élément en lecture/écriture

Mode Outlook applicable : Organisateur de rendez-vous

Erreurs :

• InvalidAttachmentId : l’identificateur de pièce jointe n’existe pas.

Exemples

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

Insère les données dans le corps ou l’objet d’un message de manière asynchrone.

La setSelectedDataAsync méthode insère la chaîne spécifiée à l’emplacement du curseur dans l’objet ou le corps de l’élément, ou, si du texte est sélectionné dans l’éditeur, elle remplace le texte sélectionné. Si le curseur ne se trouve pas dans le champ body ou subject, une erreur est retournée. Après l’insertion, le curseur est placé à la fin du contenu inséré.

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

Paramètres

Retours

Remarques

[ Ensemble d’API : Boîte aux lettres 1.2 ]

Niveau d’autorisation minimal : élément en lecture/écriture

Mode Outlook applicable : Organisateur de rendez-vous

Erreurs :

• InvalidAttachmentId : l’identificateur de pièce jointe n’existe pas.