itemitem

Office.context.mailbox.itemOffice.context.mailbox.item

Utiliser l’espace-nom item pour accéder a votre message, réunion, demande de réunion ou rendez-vous actuellement sélectionné. Vous pouvez déterminer le type de l’élément item à l’aide de la propriété itemType.The item namespace is used to access the currently selected message, meeting request, or appointment. You can determine the type of the item by using the itemType property.

Conditions requisesRequirements
Condition requiseRequirement ValeurValue
Version minimale de l’ensemble des conditions requises de boîte aux lettresMinimum mailbox requirement set version 1.01.0
Niveau minimal d’autorisationMinimum permission level RestreintRestricted
Mode Outlook applicableApplicable Outlook mode Composition ou lectureCompose or read
Membres et méthodesMembers and methods
MembreMember TypeType
attachmentsattachments MembreMember
bccbcc MembreMember
bodybody MembreMember
cccc MembreMember
conversationIdconversationId MembreMember
dateTimeCreateddateTimeCreated MembreMember
dateTimeModifieddateTimeModified MembreMember
endend MembreMember
fromfrom MembreMember
internetMessageIdinternetMessageId MembreMember
itemClassitemClass MembreMember
itemIditemId MembreMember
itemTypeitemType MembreMember
locationlocation MembreMember
normalizedSubjectnormalizedSubject MembreMember
notificationMessagesnotificationMessages MembreMember
optionalAttendeesoptionalAttendees MembreMember
organizerorganizer MembreMember
récurrencerecurrence MembreMember
requiredAttendeesrequiredAttendees MembreMember
sendersender MembreMember
seriesIdseriesId MembreMember
startstart MembreMember
subjectsubject MembreMember
toto MembreMember
addFileAttachmentAsyncaddFileAttachmentAsync MéthodeMethod
addHandlerAsyncaddHandlerAsync MéthodeMethod
addItemAttachmentAsyncaddItemAttachmentAsync MéthodeMethod
closeclose MéthodeMethod
displayReplyAllFormdisplayReplyAllForm MéthodeMethod
displayReplyFormdisplayReplyForm MéthodeMethod
getEntitiesgetEntities MéthodeMethod
getEntitiesByTypegetEntitiesByType MéthodeMethod
getFilteredEntitiesByNamegetFilteredEntitiesByName MéthodeMethod
getRegExMatchesgetRegExMatches MéthodeMethod
getRegExMatchesByNamegetRegExMatchesByName MéthodeMethod
getSelectedDataAsyncgetSelectedDataAsync MéthodeMethod
getSelectedEntitiesgetSelectedEntities MéthodeMethod
getSelectedRegExMatchesgetSelectedRegExMatches MéthodeMethod
loadCustomPropertiesAsyncloadCustomPropertiesAsync MéthodeMethod
removeAttachmentAsyncremoveAttachmentAsync MéthodeMethod
removeHandlerAsyncremoveHandlerAsync MéthodeMethod
saveAsyncsaveAsync MéthodeMethod
setSelectedDataAsyncsetSelectedDataAsync MéthodeMethod

ExempleExample

Cet exemple de code JavaScript montre comment accéder à la propriété subject de l’élément actif dans Outlook.The following JavaScript code example shows how to access the subject property of the current item in Outlook.

// The initialize function is required for all apps.
Office.initialize = function () {
    // Checks for the DOM to load using the jQuery ready function.
    $(document).ready(function () {
    // After the DOM is loaded, app-specific code can run.
    var item = Office.context.mailbox.item;
    var subject = item.subject;
    // Continue with processing the subject of the current item,
    // which can be a message or appointment.
    });
}

MembresMembers

attachments :Array.<AttachmentDetails>attachments :Array.<AttachmentDetails>

Obtient un tableau des pièces jointes de l’élément. Mode lecture uniquement.Gets an array of attachments for the item. Read mode only.

Note

Certains types de fichiers sont bloqués par Outlook en raison de problèmes de sécurité potentiels et ne sont donc pas rendus.Certain types of files are blocked by Outlook due to potential security issues and are therefore not returned. Pour plus d’information, voir les pièces jointes bloquées par Outlook.For more information see Payments in Outlook.

Type :Type:
Conditions requisesRequirements
Condition requiseRequirement ValeurValue
Version minimale de l’ensemble des conditions requises de boîte aux lettresMinimum mailbox requirement set version 1.01.0
Niveau minimal d’autorisationMinimum permission level ReadItemReadItem
Mode Outlook applicableApplicable Outlook mode LectureRead
ExempleExample

Le code suivant génère une chaîne HTML avec les détails de toutes les pièces jointes de l’élément actif.The following code builds an HTML string with details of all attachments on the current item.

var _Item = Office.context.mailbox.item;
var outputString = "";

if (_Item.attachments.length > 0) {
  for (i = 0 ; i < _Item.attachments.length ; i++) {
    var _att = _Item.attachments[i];
    outputString += "<BR>" + i + ". Name: ";
    outputString += _att.name;
    outputString += "<BR>ID: " + _att.id;
    outputString += "<BR>contentType: " + _att.contentType;
    outputString += "<BR>size: " + _att.size;
    outputString += "<BR>attachmentType: " + _att.attachmentType;
    outputString += "<BR>isInline: " + _att.isInline;
  }
}

// Do something with outputString

bcc :Recipientsbcc :Recipients

Obtient un objet qui fournit les méthodes permettant d’obtenir ou de mettre à jour les destinataires des Cci (copie carbone invisible) d’un message.Gets an object that provides methods to get or update the recipients on the Bcc (blind carbon copy) line of a message. Mode composition uniquement.Compose mode only.

Type :Type:
Conditions requisesRequirements
Condition requiseRequirement ValeurValue
Version minimale de l’ensemble des conditions requises de boîte aux lettresMinimum mailbox requirement set version 1.11.1
Niveau minimal d’autorisationMinimum permission level ReadItemReadItem
Mode Outlook applicableApplicable Outlook mode CompositionCompose
ExempleExample
Office.context.mailbox.item.bcc.setAsync( ['alice@contoso.com', 'bob@contoso.com'] );
Office.context.mailbox.item.bcc.addAsync( ['jason@contoso.com'] );
Office.context.mailbox.item.bcc.getAsync(callback);

function callback(asyncResult) {
  var arrayOfBccRecipients = asyncResult.value;
}

body :Bodybody :Body

Obtient un objet qui fournit des méthodes permettant de manipuler le texte d’un élément.Gets an object that provides methods for manipulating the body of an item.

Type :Type:
Conditions requisesRequirements
Condition requiseRequirement ValeurValue
Version minimale de l’ensemble des conditions requises de boîte aux lettresMinimum mailbox requirement set version 1.11.1
Niveau minimal d’autorisationMinimum permission level ReadItemReadItem
Mode Outlook applicableApplicable Outlook mode Composition ou lectureCompose or read

cc :Array.<EmailAddressDetails>|Recipientscc :Array.<EmailAddressDetails>|Recipients

Permet d’accéder aux destinataires Cc (copie carbone) d’un message.Provides access to the Cc (carbon copy) recipients of a message. La nature d’un objet et son niveau d’accès dépendent du mode de l’élément actuel.The type of object and level of access depends on the mode of the current item.

Mode lectureRead mode

La propriété cc renvoie un tableau contenant un objet EmailAddressDetails pour chaque destinataire répertorié sur la ligne Cc du message. La collection est limitée à 100 membres.The cc property returns an array that contains an EmailAddressDetails object for each recipient listed on the Cc line of the message. The collection is limited to a maximum of 100 members.

Mode compositionCompose mode

La propriété cc renvoie un objet Recipients qui fournit des méthodes permettant d’obtenir ou de mettre à jour les destinataires sur la ligne Cc du message.The cc property returns a Recipients object that provides methods for manipulating the recipients on the Cc line of the message.

Type :Type:
Conditions requisesRequirements
Condition requiseRequirement ValeurValue
Version minimale de l’ensemble des conditions requises de boîte aux lettresMinimum mailbox requirement set version 1.01.0
Niveau minimal d’autorisationMinimum permission level ReadItemReadItem
Mode Outlook applicableApplicable Outlook mode Composition ou lectureCompose or read
ExempleExample
Office.context.mailbox.item.cc.setAsync( ['alice@contoso.com', 'bob@contoso.com'] );
Office.context.mailbox.item.cc.addAsync( ['jason@contoso.com'] );
Office.context.mailbox.item.cc.getAsync(callback);

function callback(asyncResult) {
  var arrayOfCcRecipients = asyncResult.value;
}

(nullable) conversationId :String(nullable) conversationId :String

Obtient l’identificateur de la conversation qui contient un message particulier.Gets an identifier for the email conversation that contains a particular message.

Vous pouvez obtenir un nombre entier de cette propriété si votre application de messagerie est activée dans les formulaires de lecture ou les réponses des formulaires de composition. Si, par la suite, l’utilisateur modifie l’objet du message de réponse, lors de l’envoi de la réponse, l’identificateur de conversation de ce message changera et la valeur que vous aurez obtenue plus tôt ne sera plus applicable.You can get an integer for this property if your mail app is activated in read forms or responses in compose forms. If subsequently the user changes the subject of the reply message, upon sending the reply, the conversation ID for that message will change and that value you obtained earlier will no longer apply.

Cette propriété obtient une valeur null lorsqu’un élément est ajouté à un formulaire de composition. Si l’utilisateur définit la ligne Objet et enregistre l’élément, la propriété conversationId renverra une valeur.You get null for this property for a new item in a compose form. If the user sets a subject and saves the item, the conversationId property will return a value.

Type :Type:
  • StringString
Conditions requisesRequirements
Condition requiseRequirement ValeurValue
Version minimale de l’ensemble des conditions requises de boîte aux lettresMinimum mailbox requirement set version 1.01.0
Niveau minimal d’autorisationMinimum permission level ReadItemReadItem
Mode Outlook applicableApplicable Outlook mode Composition ou lectureCompose or read

dateTimeCreated :DatedateTimeCreated :Date

Obtient la date et l’heure de création d’un élément. Mode lecture uniquement.Gets the date and time that an item was created. Read mode only.

Type :Type:
  • DateDate
Conditions requisesRequirements
Condition requiseRequirement ValeurValue
Version minimale de l’ensemble des conditions requises de boîte aux lettresMinimum mailbox requirement set version 1.01.0
Niveau minimal d’autorisationMinimum permission level ReadItemReadItem
Mode Outlook applicableApplicable Outlook mode LectureRead
ExempleExample
var created = Office.context.mailbox.item.dateTimeCreated;

dateTimeModified :DatedateTimeModified :Date

Obtient la date et l’heure de la dernière modification d’un élément. Mode lecture uniquement.Gets the date and time that an item was last modified. Read mode only.

Note

Ce membre n’est pas pris en charge par Outlook pour iOS ou Outlook pour Android.Note: This member is not supported in Outlook for iOS or Outlook for Android.

Type :Type:
  • DateDate
Conditions requisesRequirements
Condition requiseRequirement ValeurValue
Version minimale de l’ensemble des conditions requises de boîte aux lettresMinimum mailbox requirement set version 1.01.0
Niveau minimal d’autorisationMinimum permission level ReadItemReadItem
Mode Outlook applicableApplicable Outlook mode LectureRead
ExempleExample
var modified = Office.context.mailbox.item.dateTimeModified;

end :Date|Timeend :Date|Time

Obtient ou définit la date et l’heure de fin du rendez-vous.Gets or sets the date and time that the appointment is to end.

La propriété end est exprimée en date et heure U.T.C. (temps universel coordonné). Vous pouvez utiliser la méthode convertToLocalClientTime pour convertir la valeur de fin de la propriété à la date et à l’heure locale du client.The end property is expressed as a Coordinated Universal Time (UTC) date and time value. You can use the convertToLocalClientTime method to convert the end property value to the client’s local date and time.

Mode lectureRead mode

La propriété end renvoie un objet Date.The end property returns a Date object.

Mode compositionCompose mode

La propriété end renvoie un objet Time.The end property returns a Time object.

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.When you use the Time.setAsync method to set the end time, you should use the convertToUtcClientTime method to convert the local time on the client to UTC for the server.

Type :Type:
Conditions requisesRequirements
Condition requiseRequirement ValeurValue
Version minimale de l’ensemble des conditions requises de boîte aux lettresMinimum mailbox requirement set version 1.01.0
Niveau minimal d’autorisationMinimum permission level ReadItemReadItem
Mode Outlook applicableApplicable Outlook mode Composition ou lectureCompose or read
ExempleExample

L’exemple suivant définit l’heure de fin d’un rendez-vous en mode composition à l’aide de la méthode setAsync de l’objet Time.The following example sets the end time of an appointment in compose mode by using the setAsync method of the Time object.

var endTime = new Date("3/14/2015");
var 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 function
    console.debug("End Time " + result.asyncContext.verb);
  }
});

à partir de :EmailAddressDetails|à partir defrom :EmailAddressDetails|From

Obtient l’adresse e-mail de l’expéditeur d’un message.Gets the email address of the sender of a message.

Les propriétés from et sender représentent la même personne, sauf si le message est envoyé par un délégué. Dans ce cas, la propriété from représente le délégant et la propriété expéditeur représente le délégué.The from and sender properties represent the same person unless the message is sent by a delegate. In that case, the from property represents the delegator, and the sender property represents the delegate.

Note

Le recipientType propriété de la EmailAddressDetails objet dans le from propriété est undefined.Note: The recipientType property of the EmailAddressDetails object in the from property is undefined.

Mode lectureRead mode

La propriété from renvoie un objet EmailAddressDetails.The from property returns a EmailAddressDetails object.

var subject = Office.context.mailbox.item.from;
Mode compositionCompose mode

La propriété from renvoie un objet From qui fournit une méthode pour obtenir la valeur de la part deThe from property returns a From object that provides a method to get the from value.

Office.context.mailbox.item.from.getAsync(callback);

function callback(asyncResult) {
  var from = asyncResult.value;
}
Type :Type:
Conditions requisesRequirements
Condition requiseRequirement
Version minimale de l’ensemble des conditions requises de boîte aux lettresMinimum mailbox requirement set version 1.01.0 1.7-17
Niveau minimal d’autorisationMinimum permission level ReadItemReadItem ReadWriteItemReadWriteItem
Mode Outlook applicableApplicable Outlook mode LectureRead CompositionCompose

internetMessageId :StringinternetMessageId :String

Obtient l’identificateur de message Internet d’un e-mail. Mode lecture uniquement.Gets the Internet message identifier for an email message. Read mode only.

Type :Type:
  • StringString
Conditions requisesRequirements
Condition requiseRequirement ValeurValue
Version minimale de l’ensemble des conditions requises de boîte aux lettresMinimum mailbox requirement set version 1.01.0
Niveau minimal d’autorisationMinimum permission level ReadItemReadItem
Mode Outlook applicableApplicable Outlook mode LectureRead
ExempleExample
var internetMessageId = Office.context.mailbox.item.internetMessageId;

itemClass :StringitemClass :String

Obtient la classe de l’élément des services web Exchange de l’élément sélectionné. Mode lecture uniquement.Gets the Exchange Web Services item class of the selected item. Read mode only.

La propriété itemClass spécifie la classe de message de l’élément sélectionné. Les éléments suivants sont les classes de message par défaut du message ou de l’élément de rendez-vous.The itemClass property specifies the message class of the selected item. The following are the default message classes for the message or appointment item.

TypeType DescriptionDescription Classe d’élémentitem class
Éléments de rendez-vousAppointment items Ce sont les éléments de calendrier de la classe de l’élément IPM.Appointment ou IPM.Appointment.Occurence.These are calendar items of the item class IPM.Appointment or IPM.Appointment.Occurence. IPM.Appointment
IPM.Appointment.Occurence
Éléments de messageMessage items Ces éléments incluent les e-mails dont la classe de message par défaut est IPM.Note, ainsi que les demandes de réunion, les réponses et les annulations qui utilisent IPM.Schedule.Meeting comme classe de message de base.These include email messages that have the default message class IPM.Note, and meeting requests, responses, and cancellations, that use IPM.Schedule.Meeting as the base message class. IPM.Note
IPM.Schedule.Meeting.Request
IPM.Schedule.Meeting.Neg
IPM.Schedule.Meeting.Pos
IPM.Schedule.Meeting.Tent
IPM.Schedule.Meeting.Canceled

Vous pouvez créer des classes de message personnalisées qui étendent une classe de message par défaut, par exemple, une classe de message de rendez-vous personnalisée IPM.Appointment.Contoso.You can create custom message classes that extends a default message class, for example, a custom appointment message class IPM.Appointment.Contoso.

Type :Type:
  • StringString
Conditions requisesRequirements
Condition requiseRequirement ValeurValue
Version minimale de l’ensemble des conditions requises de boîte aux lettresMinimum mailbox requirement set version 1.01.0
Niveau minimal d’autorisationMinimum permission level ReadItemReadItem
Mode Outlook applicableApplicable Outlook mode LectureRead
ExempleExample
var itemClass = Office.context.mailbox.item.itemClass;

(nullable) itemId :String(nullable) itemId :String

Obtient l’identificateur de l’élément des services web Exchange pour l’élément actif. Mode lecture uniquement.Gets the Exchange Web Services item identifier for the current item. Read mode only.

Note

L’identificateur renvoyé par la propriété itemId est identique à celui de l’élément des services web Exchange.The identifier returned by the itemId property is the same as the Exchange Web Services item identifier. La propriété itemId n’est pas identique à l’ID d’entrée Outlook ou l’ID utilisé par l’API REST de Outlook.The itemId property is not identical to the Outlook Entry ID or the ID used by the Outlook REST API. Avant d’effectuer des appels d’API REST à l’aide de cette valeur, elle doit être convertie à l’aide de Office.context.mailbox.convertToRestId.Before making REST API calls using this value, it should be converted using Office.context.mailbox.convertToRestId. Pour plus d’informations, voir Utiliser les API REST d’Outlook à partir d’un complément Outlook.For more details, see Use the Outlook REST APIs from an Outlook add-in.

La propriété itemId n’est pas disponible en mode composition. Si l’identificateur d’un élément doit être indiqué, la méthode saveAsync peut être utilisée pour enregistrer l’élément sur le magasin, lequel renvoie l’identificateur de l’élément dans le paramètre AsyncResult.value dans la fonction de rappel.The itemId property is not available in compose mode. If an item identifier is required, the saveAsync method can be used to save the item to the store, which will return the item identifier in the AsyncResult.value parameter in the callback function.

Type :Type:
  • StringString
Conditions requisesRequirements
Condition requiseRequirement ValeurValue
Version minimale de l’ensemble des conditions requises de boîte aux lettresMinimum mailbox requirement set version 1.01.0
Niveau minimal d’autorisationMinimum permission level ReadItemReadItem
Mode Outlook applicableApplicable Outlook mode LectureRead
ExempleExample

Le code suivant vérifie la présence d’un identificateur d’élément. Si la propriété itemId renvoie null ou undefined, il enregistre l’élément sur le magasin et obtient l’identificateur de l’élément à partir du résultat asynchrone.The following code checks for the presence of an item identifier. If the itemId property returns null or undefined, it saves the item to the store and gets the item identifier from the asynchronous result.

var itemId = Office.context.mailbox.item.itemId;
if (itemId === null || itemId == undefined) {
  Office.context.mailbox.item.saveAsync(function(result){
    itemId = result.value;
  });
}

itemType :Office.MailboxEnums.ItemTypeitemType :Office.MailboxEnums.ItemType

Obtient le type d’élément représenté par une instance.Gets the type of item that an instance represents.

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.The itemType property returns one of the ItemType enumeration values, indicating whether the item object instance is a message or an appointment.

Type :Type:
Conditions requisesRequirements
Condition requiseRequirement ValeurValue
Version minimale de l’ensemble des conditions requises de boîte aux lettresMinimum mailbox requirement set version 1.01.0
Niveau minimal d’autorisationMinimum permission level ReadItemReadItem
Mode Outlook applicableApplicable Outlook mode Composition ou lectureCompose or read
ExempleExample
if (Office.context.mailbox.item.itemType == Office.MailboxEnums.ItemType.Message)
  // do something
else
  // do something else

location :String|Locationlocation :String|Location

Obtient ou définit le lieu d’un rendez-vous.Gets or sets the location of an appointment.

Mode lectureRead mode

La propriété location renvoie une chaîne contenant le lieu du rendez-vous.The location property returns a string that contains the location of the appointment.

Mode compositionCompose mode

La propriété location renvoie un objet Location qui fournit les méthodes utilisées pour obtenir et définir le lieu du rendez-vous.The location property returns a Location object that provides methods that are used to get and set the location of the appointment.

Type :Type:
Conditions requisesRequirements
Condition requiseRequirement ValeurValue
Version minimale de l’ensemble des conditions requises de boîte aux lettresMinimum mailbox requirement set version 1.01.0
Niveau minimal d’autorisationMinimum permission level ReadItemReadItem
Mode Outlook applicableApplicable Outlook mode Composition ou lectureCompose or read
ExempleExample
var userContext = { value : 1 };
Office.context.mailbox.item.location.getAsync( { context: userContext}, callback);

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

normalizedSubject :StringnormalizedSubject :String

Obtient l’objet d’un élément, sans les préfixes (y compris RE: et FWD:). Mode lecture uniquement.Gets the subject of an item, with all prefixes removed (including RE: and FWD:). Read mode only.

La propriété normalizedSubject obtient l’objet de l’élément, sans les préfixes standard (par exemple, RE: et FW:) qui sont ajoutés par les programmes de messagerie électronique. Pour obtenir l’objet de l’élément avec les préfixes intacts, utilisez la propriété subject.The normalizedSubject property gets the subject of the item, with any standard prefixes (such as RE: and FW:) that are added by email programs. To get the subject of the item with the prefixes intact, use the subject property.

Type :Type:
  • StringString
Conditions requisesRequirements
Condition requiseRequirement ValeurValue
Version minimale de l’ensemble des conditions requises de boîte aux lettresMinimum mailbox requirement set version 1.01.0
Niveau minimal d’autorisationMinimum permission level ReadItemReadItem
Mode Outlook applicableApplicable Outlook mode LectureRead
ExempleExample
var normalizedSubject = Office.context.mailbox.item.normalizedSubject;

notificationMessages :NotificationMessagesnotificationMessages :NotificationMessages

Obtient les messages de notification pour un élément.Gets the notification messages for an item.

Type :Type:
Conditions requisesRequirements
Condition requiseRequirement ValeurValue
Version minimale de l’ensemble des conditions requises de boîte aux lettresMinimum mailbox requirement set version 1.31.3
Niveau minimal d’autorisationMinimum permission level ReadItemReadItem
Mode Outlook applicableApplicable Outlook mode Composition ou lectureCompose or read

optionalAttendees :Array.<EmailAddressDetails>|RecipientsoptionalAttendees :Array.<EmailAddressDetails>|Recipients

Fournit l’accès aux participants facultatifs d’un événement.Provides access to the optional attendees of an event. La nature d’un objet et son niveau d’accès dépendent du mode de l’élément actuel.The type of object and level of access depends on the mode of the current item.

Mode lectureRead mode

La propriété optionalAttendees renvoie un tableau contenant un objet EmailAddressDetails pour chaque participant facultatif à la réunion.The optionalAttendees property returns an array that contains an EmailAddressDetails object for each optional attendee to the meeting.

Mode compositionCompose mode

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.The optionalAttendees property returns a Recipients object that provides methods to get and set the optional attendees for a meeting.

Type :Type:
Conditions requisesRequirements
Condition requiseRequirement ValeurValue
Version minimale de l’ensemble des conditions requises de boîte aux lettresMinimum mailbox requirement set version 1.01.0
Niveau minimal d’autorisationMinimum permission level ReadItemReadItem
Mode Outlook applicableApplicable Outlook mode Composition ou lectureCompose or read
ExempleExample
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) {
  var arrayOfOptionalAttendeesRecipients = asyncResult.value;
}

organisateur :EmailAddressDetails|organisateurorganizer :EmailAddressDetails|Organizer

Obtient l’adresse de messagerie de l’organisateur de la réunion spécifiée.Gets the email address of the meeting organizer for a specified meeting.

Mode lectureRead mode

La propriété organizer renvoie un objet EmailAddressDetails qui représente l’organisateur de la réunion.The organizer property returns an EmailAddressDetails object that represents the meeting organizer.

Mode compositionCompose mode

La propriété organizer retourne un objet organisateur qui fournit une méthode pour obtenir la valeur organisateur.The organizer property returns an Organizer object that provides a method to get the organizer value.

Type :Type:
Conditions requisesRequirements
Condition requiseRequirement
Version minimale de l’ensemble des conditions requises de boîte aux lettresMinimum mailbox requirement set version 1.01.0 1.7-17
Niveau minimal d’autorisationMinimum permission level ReadItemReadItem ReadWriteItemReadWriteItem
Mode Outlook applicableApplicable Outlook mode LectureRead CompositionCompose
ExempleExample
var organizerName = Office.context.mailbox.item.organizer.displayName;
var organizerAddress = Office.context.mailbox.item.organizer.emailAddress;

(nul) récurrence :Récurrence(nullable) recurrence :Recurrence

Obtient ou définit la périodicité d’un rendez-vous.Gets or sets the location of an appointment. Obtient la périodicité d’une demande de réunion.Gets the recurrence pattern of a meeting request. Mode lecture et composition pour les éléments de rendez-vousRead and compose modes for appointment items. Mode lecture pour les éléments de demande de réunion.Read mode for meeting request items.

La propriété recurrence renvoie un objet récurrence pour les rendez-vous réguliers ou les demandes de réunion si l’élément fait partie d'une série ou constitue une série.The recurrence property returns a recurrence object for recurring appointments or meetings requests if an item is a series or an instance in a series. null est envoyée pour les rendez-vous uniques ou les demandes de réunion pour une rendez-vous unique.null is returned for single appointments and meeting requests of single appointments. undefined est envoyée pour les messages qui ne sont pas des demandes de réunion.undefined is returned for messages that are not meeting requests.

Remarque : Les demandes de réunion ont une itemClass valeur IPM. Schedule.Meeting.Request.Note: Meeting requests have an itemClass value of IPM.Schedule.Meeting.Request.

Remarque : Si la récurrence d'un objet est null, cela signifie que cet objet représente un rendez-vous unique ou une demande de réunion pour un rendez-vous unique qui ne fait PAS partie d'une série.Note: If the recurrence object is null, this indicates that the object is a single appointment or a meeting request of a single appointment and NOT a part of a series.

Type :Type:
Condition requiseRequirement ValeurValue
Version minimale de l’ensemble des conditions requises de boîte aux lettresMinimum mailbox requirement set version 1.7-17
Niveau minimal d’autorisationMinimum permission level ReadItemReadItem
Mode Outlook applicableApplicable Outlook mode Composition ou lectureCompose or read

requiredAttendees : tableau. <EmailAddressDetails>|destinatairesrequiredAttendees :Array.<EmailAddressDetails>|Recipients

Fournit l’accès aux participants obligatoires d'un événement.Provides access to the required attendees of an event. La nature d’un objet et son niveau d’accès dépendent du mode de l’élément actuel.The type of object and level of access depends on the mode of the current item.

Mode lectureRead mode

La propriété requiredAttendees renvoie un tableau contenant un objet EmailAddressDetails pour chaque participant obligatoires de la réunion.The requiredAttendees property returns an array that contains an EmailAddressDetails object for each required attendee to the meeting.

Mode compositionCompose mode

La propriété requiredAttendees renvoie un objet Recipients qui fournit des méthodes permettant d’obtenir ou de mettre à jour les participants facultatifs d’une réunion.The requiredAttendees property returns a Recipients object that provides methods to get and set the required attendees for a meeting.

Type :Type:
Conditions requisesRequirements
Condition requiseRequirement ValeurValue
Version minimale de l’ensemble des conditions requises de boîte aux lettresMinimum mailbox requirement set version 1.01.0
Niveau minimal d’autorisationMinimum permission level ReadItemReadItem
Mode Outlook applicableApplicable Outlook mode Composition ou lectureCompose or read
ExempleExample
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) {
  var arrayOfRequiredAttendeesRecipients = asyncResult.value;
}

sender :EmailAddressDetailssender :EmailAddressDetails

Obtient l’adresse de messagerie de l’expéditeur d’un e-mail. Mode lecture uniquement.Gets the email address of the sender of an email message. Read mode only.

Les propriétés from et sender représentent la même personne, sauf si le message est envoyé par un délégué. Dans ce cas, la propriété from représente le délégant et la propriété expéditeur représente le délégué.The from and sender properties represent the same person unless the message is sent by a delegate. In that case, the from property represents the delegator, and the sender property represents the delegate.

Note

La propriété recipientType de l'objet EmailAddressDetails dans la propriété sender est undefined.Note: The recipientType property of the EmailAddressDetails object in the sender property is undefined.

Type :Type:
Conditions requisesRequirements
Condition requiseRequirement ValeurValue
Version minimale de l’ensemble des conditions requises de boîte aux lettresMinimum mailbox requirement set version 1.01.0
Niveau minimal d’autorisationMinimum permission level ReadItemReadItem
Mode Outlook applicableApplicable Outlook mode LectureRead
ExempleExample
var senderName = Office.context.mailbox.item.sender.displayName;
var senderAddress = Office.context.mailbox.item.sender.emailAddress;

(nullable) seriesId :String(nullable) seriesId :String

Obtient l’identificateur de la série appartenant à une instance.Gets the id of the series that an instance belongs to.

Sur Outlook Web Access et Outlook, le seriesId renvoie l'identificateur des services web Exchange de l'objet parent (la série) de l’élément en question.In OWA and Outlook, the seriesId returns the Exchange Web Services (EWS) ID of the parent (series) item that this item belongs to. Toutefois, sur iOS et Android, le seriesId renvoie l'identificateur REST de l’élément parent.However, in iOS and Android, the seriesId returns the REST ID of the parent item.

Note

L’identificateur renvoyé par la propriété seriesId est identique à celui de l’élément des services web Exchange.The identifier returned by the seriesId property is the same as the Exchange Web Services item identifier. La propriété seriesId n’est pas identique à l’identificateur Outlook utilisé par l’API REST de Outlook.The seriesId property is not identical to the Outlook IDs used by the Outlook REST API. Avant d’effectuer des appels d’API REST à l’aide de cette valeur, elle doit être convertie à l’aide de Office.context.mailbox.convertToRestId.Before making REST API calls using this value, it should be converted using Office.context.mailbox.convertToRestId. Pour plus d’informations, voir Utiliser les API REST d’Outlook à partir d’un complément Outlook.For more details, see Use the Outlook REST APIs from an Outlook add-in.

La propriété seriesId renvoie null pour les éléments qui n'ont pas d'objet parent, tel que les rendez-vous uniques, les composants d'une série ou une demande de réunion et renvoie undefined pour tout les autres éléments qui ne constituent pas une demande de réunion.The seriesId property returns null for items that do not have parent items such as single appointments, series items, or meeting requests and returns undefined for any other items that are not meeting requests.

Type :Type:
  • StringString
Conditions requisesRequirements
Condition requiseRequirement ValeurValue
Version minimale de l’ensemble des conditions requises de boîte aux lettresMinimum mailbox requirement set version 1.7-17
Niveau minimal d’autorisationMinimum permission level ReadItemReadItem
Mode Outlook applicableApplicable Outlook mode Composition ou lectureCompose or read
ExempleExample
var seriesId = Office.context.mailbox.item.seriesId; 
var isSeries = (seriesId == null);

start :Date|Timestart :Date|Time

Obtient ou définit la date et l’heure de début du rendez-vous.Gets or sets the date and time that the appointment is to begin.

La propriété start est exprimée en date et heure U.T.C. (temps universel coordonné). Vous pouvez utiliser la méthode convertToLocalClientTime pour convertir la valeur à la date et à l’heure du client.The start property is expressed as a Coordinated Universal Time (UTC) date and time value. You can use the convertToLocalClientTime method to convert the value to the client’s local date and time.

Mode lectureRead mode

La propriété start renvoie un objet Date.The start property returns a Date object.

Mode compositionCompose mode

La propriété start renvoie un objet Time.The start property returns a Time object.

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 U.T.C. pour le serveur.When you use the Time.setAsync method to set the start time, you should use the convertToUtcClientTime method to convert the local time on the client to UTC for the server.

Type :Type:
Conditions requisesRequirements
Condition requiseRequirement ValeurValue
Version minimale de l’ensemble des conditions requises de boîte aux lettresMinimum mailbox requirement set version 1.01.0
Niveau minimal d’autorisationMinimum permission level ReadItemReadItem
Mode Outlook applicableApplicable Outlook mode Composition ou lectureCompose or read
ExempleExample

L’exemple suivant définit l’heure de début d’un rendez-vous en mode composition à l’aide de la méthode setAsync de l’objet Time.The following example sets the start time of an appointment in compose mode by using the setAsync method of the Time object.

var startTime = new Date("3/14/2015");
var options = {
  // Pass information that can be used
  // in the callback
     asyncContext: {verb:"Set"}
}
Office.context.mailbox.item.start.setAsync(startTime, options, function(result) {
  if (result.error) {
    console.debug(result.error);
  } else {
    // Access the asyncContext that was passed to the setAsync function
    console.debug("Start Time " + result.asyncContext.verb);
  }
});

subject :String|Subjectsubject :String|Subject

Obtient ou définit la description qui apparaît dans le champ d’objet d’un élément.Gets or sets the description that appears in the subject field of an item.

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.The subject property gets or sets the entire subject of the item, as sent by the email server.

Mode lectureRead mode

La propriété subject renvoie une chaîne. Utilisez la propriété normalizedSubject pour obtenir l’objet sans les préfixes tels que RE: et FW:.The subject property returns a string. Use the normalizedSubject property to get the subject minus any leading prefixes such as RE: and FW:.

var subject = Office.context.mailbox.item.subject;
Mode compositionCompose mode

La propriété subject renvoie un objet Subject qui fournit des méthodes pour obtenir et définir l’objet.The subject property returns a Subject object that provides methods to get and set the subject.

Office.context.mailbox.item.subject.getAsync(callback);

function callback(asyncResult) {
  var subject = asyncResult.value;
}
Type :Type:
Conditions requisesRequirements
Condition requiseRequirement ValeurValue
Version minimale de l’ensemble des conditions requises de boîte aux lettresMinimum mailbox requirement set version 1.01.0
Niveau minimal d’autorisationMinimum permission level ReadItemReadItem
Mode Outlook applicableApplicable Outlook mode Composition ou lectureCompose or read

to :Array.<EmailAddressDetails>|Recipientsto :Array.<EmailAddressDetails>|Recipients

Permet d’accéder aux destinataires de la ligne à du message.Provides access to the recipients on the To line of a message. La nature d’un objet et son niveau d’accès dépendent du mode de l’élément actuel.The type of object and level of access depends on the mode of the current item.

Mode lectureRead mode

La propriété to renvoie un tableau contenant un objet EmailAddressDetails pour chaque destinataire répertorié sur la ligne À du message. La collection est limitée à 100 membres.The to property returns an array that contains an EmailAddressDetails object for each recipient listed on the To line of the message. The collection is limited to a maximum of 100 members.

Mode compositionCompose mode

La propriété to renvoie un objet Recipients qui fournit des méthodes permettant d’obtenir ou de mettre à jour les destinataires sur la ligne À du message.The toto property returns a RecipientsRecipients object that provides methods for manipulating the recipients on the To line of the message.

Type :Type:
Conditions requisesRequirements
Condition requiseRequirement ValeurValue
Version minimale de l’ensemble des conditions requises de boîte aux lettresMinimum mailbox requirement set version 1.01.0
Niveau minimal d’autorisationMinimum permission level ReadItemReadItem
Mode Outlook applicableApplicable Outlook mode Composition ou lectureCompose or read
ExempleExample
Office.context.mailbox.item.to.setAsync( ['alice@contoso.com', 'bob@contoso.com'] );
Office.context.mailbox.item.to.addAsync( ['jason@contoso.com'] );
Office.context.mailbox.item.to.getAsync(callback);

function callback(asyncResult) {
  var arrayOfToRecipients = asyncResult.value;
}

MéthodesMethods

addFileAttachmentAsync(uri, attachmentName, [options], [callback])addFileAttachmentAsync(uri, attachmentName, [options], [callback])

Ajoute un fichier à un message ou un rendez-vous en pièce jointe.Adds a file to a message or appointment as an attachment.

La méthode addFileAttachmentAsync charge le fichier depuis l’URI spécifié et le joint à l’élément dans le formulaire de composition.The addFileAttachmentAsync method uploads the file at the specified URI and attaches it to the item in the compose form.

L’identificateur peut être utilisé avec la méthode removeAttachmentAsync pour supprimer la pièce jointe dans la même session.You can subsequently use the identifier with the removeAttachmentAsync method to remove the attachment in the same session.

Paramètres :Parameters:
NomName TypeType AttributsAttributes DescriptionDescription
uri StringString L’URI indiquant l’emplacement du fichier à joindre au message ou au rendez-vous. La longueur maximale est de 2 048 caractères.The URI that provides the location of the file to attach to the message or appointment. The maximum length is 2048 characters.
attachmentName StringString Nom de la pièce jointe affiché lors de son chargement. La longueur maximale est de 255 caractères.The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters.
options ObjetObject <facultatif><optional> Littéral d’objet contenant une ou plusieurs des propriétés suivantes.An object literal that contains one or more of the following properties.
options.asyncContext ObjetObject <facultatif><optional> Les développeurs peuvent indiquer un objet auquel ils souhaitent accéder dans la méthode de rappel.Developers can provide any object they wish to access in the callback method.
options.isInline BooléenBoolean <facultatif><optional> Si elle est définie sur true, cette valeur indique que la pièce jointe est incorporée dans le texte du message et qu’elle ne doit pas figurer dans la liste des pièces jointes.If true, indicates that the attachment will be shown inline in the message body, and should not be displayed in the attachment list.
callback fonctionfunction <facultatif><optional> Quand la méthode se termine, la fonction passée dans le paramètre callback est appelée avec un seul paramètre, asyncResult, qui est un objet AsyncResult.When the method completes, the function passed in the callback parameter is called with a single parameter, asyncResult, which is an AsyncResult object.
En cas de réussite, l’identificateur de pièce jointe est fourni dans la propriété asyncResult.value.On success, the attachment identifier will be provided in the asyncResult.value property.
En cas d’échec du téléchargement de la pièce jointe, l’objet asyncResult contient un objet Error indiquant une description de l’erreur.If uploading the attachment fails, the asyncResult object will contain an Error object that provides a description of the error.
ErreursErrors
Code d’erreurError code DescriptionDescription
AttachmentSizeExceeded La pièce jointe dépasse la taille autorisée.The attachment is larger than allowed.
FileTypeNotSupported La pièce jointe comporte une extension qui n’est pas autorisée.The attachment has an extension that is not allowed.
NumberOfAttachmentsExceeded Le message ou le rendez-vous comporte un trop grand nombre de pièces jointes.The message or appointment has too many attachments.
Conditions requisesRequirements
Condition requiseRequirement ValeurValue
Version minimale de l’ensemble des conditions requises de boîte aux lettresMinimum mailbox requirement set version 1.11.1
Niveau minimal d’autorisationMinimum permission level ReadWriteItemReadWriteItem
Mode Outlook applicableApplicable Outlook mode CompositionCompose
ExemplesExamples
function callback(result) {
  if (result.error) {
    showMessage(result.error);
  } else {
    showMessage("Attachment added");
  }
}

function addAttachment() {
  // The values in asyncContext can be accessed in the callback
  var options = { 'asyncContext': { var1: 1, var2: 2 } };

  var attachmentURL = "https://contoso.com/rtm/icon.png";
  Office.context.mailbox.item.addFileAttachmentAsync(attachmentURL, attachmentURL, options, callback);
}

L’exemple suivant montre comment ajouter un fichier image comme pièce jointe incorporée et comment la pièce jointe est affichée dans le texte du message.The following example adds an image file as an inline attachment and references the attachment in the message body.

Office.context.mailbox.item.addFileAttachmentAsync
(
  "http://i.imgur.com/WJXklif.png",
  "cute_bird.png",
  {
    isInline: true
  },
  function (asyncResult) {
    Office.context.mailbox.item.body.setAsync(
      "<p>Here's a cute bird!</p><img src='cid:cute_bird.png'>",
      {
        "coercionType": "html"
      },
      function (asyncResult) {

      }
    );
  }
);

addHandlerAsync(eventType, handler, [options], [callback])addHandlerAsync(eventType, handler, [options], [callback])

ajoute un gestionnaire d’événements pour un événement pris en charge.Adds an event handler for a supported event.

Pour le moment, les types d’événements pris en charge sont Office.EventType.AppointmentTimeChanged, Office.EventType.RecipientsChanged, et Office.EventType.RecurrenceChangedCurrently the supported event types are Office.EventType.AppointmentTimeChanged, Office.EventType.RecipientsChanged, and Office.EventType.RecurrenceChanged

Paramètres :Parameters:
NomName TypeType AttributsAttributes DescriptionDescription
eventType Office.EventTypeOffice.EventType L’événement qui doit invoquer le gestionnaire.The event that should invoke the handler.
handler FonctionFunction La fonction permettant de gérer l’événement. Cette fonction doit accepter un seul paramètre, qui est un littéral d'objet. La propriété type sur le paramètre correspond au paramètre eventType transmis à addHandlerAsync.The function to handle the event. The function must accept a single parameter, which is an object literal. The type property on the parameter will match the eventType parameter passed to addHandlerAsync.
options ObjetObject <facultatif><optional> Littéral d’objet contenant une ou plusieurs des propriétés suivantes.An object literal that contains one or more of the following properties.
options.asyncContext ObjetObject <facultatif><optional> Les développeurs peuvent indiquer un objet auquel ils souhaitent accéder dans la méthode de rappel.Developers can provide any object they wish to access in the callback method.
callback fonctionfunction <facultatif><optional> Quand la méthode se termine, la fonction passée dans le paramètre callback est appelée avec un seul paramètre, asyncResult, qui est un objet AsyncResult.When the method completes, the function passed in the callback parameter is called with a single parameter, asyncResult, which is an AsyncResult object.
Conditions requisesRequirements
Condition requiseRequirement ValeurValue
Version minimale de l’ensemble des conditions requises de boîte aux lettresMinimum mailbox requirement set version 1.7-17
Niveau minimal d’autorisationMinimum permission level ReadItemReadItem
Mode Outlook applicableApplicable Outlook mode Composition ou lectureCompose or read
ExempleExample
Office.initialize = function (reason) {
  $(document).ready(function () {
    Office.context.mailbox.item.addHandlerAsync(Office.EventType.RecurrenceChanged, loadNewItem, function (result) {
      if (result.status === Office.AsyncResultStatus.Failed) {
        // Handle error
      }
    });
  });
};

function loadNewItem(eventArgs) {
  // Load the properties of the newly selected item
  loadProps(Office.context.mailbox.item);
};

addItemAttachmentAsync(itemId, attachmentName, [options], [callback])addItemAttachmentAsync(itemId, attachmentName, [options], [callback])

Ajoute un élément Exchange, comme un message, en pièce jointe au message ou au rendez-vous.Adds an Exchange item, such as a message, as an attachment to the message or appointment.

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 méthode de rappel, la méthode est appelée avec un paramètre, asyncResult, qui contient l’identificateur de pièce jointe ou un code indiquant toute erreur survenue lors de l’ajout de l’élément en tant que pièce jointe. Si nécessaire, vous pouvez utiliser le paramètre options pour transmettre des informations d’état à la méthode de rappel.The addItemAttachmentAsync method attaches the item with the specified Exchange identifier to the item in the compose form. If you specify a callback method, the method is called with one parameter, asyncResult, which contains either the attachment identifier or a code that indicates any error that occurred while attaching the item. You can use the options parameter to pass state information to the callback method, if needed.

L’identificateur peut être utilisé avec la méthode removeAttachmentAsync pour supprimer la pièce jointe dans la même session.You can subsequently use the identifier with the removeAttachmentAsync method to remove the attachment in the same session.

Si votre complément Office est exécuté dans la Outlook Web App , la méthode addItemAttachmentAsync peut joindre des éléments à des éléments autres que ceux que vous modifiez, mais cette action n’est pas prise en charge et est déconseillée.If your Office add-in is running in Outlook Web App, the addItemAttachmentAsync method can attach items to items other than the item that you are editing; however, this is not supported and is not recommended.

Paramètres :Parameters:
NomName TypeType AttributsAttributes DescriptionDescription
itemId StringString Identificateur Exchange de l’élément à joindre. La taille maximale est de 100 caractères.The Exchange identifier of the item to attach. The maximum length is 100 characters.
attachmentName StringString Objet de l’élément à joindre. La longueur maximale est de 255 caractères.The sujbect of the item to be attached. The maximum length is 255 characters.
options ObjetObject <facultatif><optional> Littéral d’objet contenant une ou plusieurs des propriétés suivantes.An object literal that contains one or more of the following properties.
options.asyncContext ObjetObject <facultatif><optional> Les développeurs peuvent indiquer un objet auquel ils souhaitent accéder dans la méthode de rappel.Developers can provide any object they wish to access in the callback method.
callback fonctionfunction <facultatif><optional> Quand la méthode se termine, la fonction passée dans le paramètre callback est appelée avec un seul paramètre, asyncResult, qui est un objet AsyncResult.When the method completes, the function passed in the callback parameter is called with a single parameter, asyncResult, which is an AsyncResult object.
En cas de réussite, l’identificateur de pièce jointe est fourni dans la propriété asyncResult.value.On success, the attachment identifier will be provided in the asyncResult.value property.
En cas d’échec de l’ajout de la pièce jointe, l’objet asyncResult contient un objet Error indiquant une description de l’erreur.If adding the attachment fails, the asyncResult object will contain an Error object that provides a description of the error.
ErreursErrors
Code d’erreurError code DescriptionDescription
NumberOfAttachmentsExceeded Le message ou le rendez-vous comporte un trop grand nombre de pièces jointes.The message or appointment has too many attachments.
Conditions requisesRequirements
Condition requiseRequirement ValeurValue
Version minimale de l’ensemble des conditions requises de boîte aux lettresMinimum mailbox requirement set version 1.11.1
Niveau minimal d’autorisationMinimum permission level ReadWriteItemReadWriteItem
Mode Outlook applicableApplicable Outlook mode CompositionCompose
ExempleExample

L’exemple suivant ajoute un élément Outlook existant en tant que pièce jointe avec le nom My Attachment.The following example adds an existing Outlook item as an attachment with the name My Attachment.

function callback(result) {
  if (result.error) {
    showMessage(result.error);
  } else {
    showMessage("Attachment added");
  }
}

function addAttachment() {
  // EWS ID of item to attach
  // (Shortened for readability)
  var itemId = "AAMkADI1...AAA=";

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

  Office.context.mailbox.item.addItemAttachmentAsync(itemId, "My Attachment", options, callback);
}

close()close()

Ferme l’élément actuel qui est en train d’être composé.Closes the current item that is being composed.

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 comprend des modifications non enregistrées, le client invite l’utilisateur à enregistrer les modifications, à les ignorer ou à annuler l’action fermer.The behavior of the close method depends on the current state of the item being composed. If the item has unsaved changes, the client prompts the user to save, discard, or cancel the close action.

Note

Sur Outlook Web Access, si l’élément est un rendez-vous qui a déjà été sauvegardé en utilisant la méthode saveAsync , l'utilisateur sera inviter à sauvegarder, abandonner ou annuler même si l’élément n'a subi aucun changement depuis sa dernière sauvegarde.In Outlook on the web, if the item is an appointment and it has previously been saved using saveAsync, the user is prompted to save, discard, or cancel even if no changes have occurred since the item was last saved.

Dans Outlook pour ordinateur de bureau, si le message est une réponse instantanée, la méthode close n’a aucun effet.In the Outlook desktop client, if the message is an inline reply, the close method has no effect.

Conditions requisesRequirements
Condition requiseRequirement ValeurValue
Version minimale de l’ensemble des conditions requises de boîte aux lettresMinimum mailbox requirement set version 1.31.3
Niveau minimal d’autorisationMinimum permission level RestreintRestricted
Mode Outlook applicableApplicable Outlook mode CompositionCompose

displayReplyAllForm(formData)displayReplyAllForm(formData)

Affiche un formulaire de réponse qui inclut, soit l’expéditeur et tous les destinataires du message sélectionné, soit l’organisateur et tous les participants du rendez-vous sélectionné.Displays a reply form that includes the sender and all recipients of the selected message or the organizer and all attendees of the selected appointment.

Note

Cette méthode n’est pas prise en charge dans Outlook pour iOS ou Outlook pour Android.Note: This method is not supported in Outlook for iOS or Outlook for Android.

Sur Outlook Web App, le formulaire de réponse s’affiche sous forme de formulaire isolé dans l’affichage à 3 colonnes et sous forme de formulaire contextuel dans l’affichage à 1 ou 2 colonnes.In Outlook Web App, the reply form is displayed as a pop-out form in the 3-column view and a pop-up form in the 2- or 1-column view.

Si un des paramètres de chaîne dépasse la limite, displayReplyAllForm génère une exception.If any of the string parameters exceed their limits, displayReplyAllForm throws an exception.

Lorsque des pièces jointes sont spécifiées dans le paramètre formData.attachments, Outlook et Outlook Web App tentent de télécharger toutes les pièces jointes et de les joindre au formulaire de réponse. Si aucune pièce jointe n’est ajoutée, une erreur s’affiche dans l’interface utilisateur du formulaire. Si ce n’est pas possible, alors aucun message d’erreur n’est généré.When attachments are specified in the formData.attachments parameter, Outlook and Outlook Web App attempt to download all attachments and attach them to the reply form. If any attachments fail to be added, an error is shown in the form UI. If this isn't possible, then no error message is thrown.

Paramètres :Parameters:
NomName TypeType AttributsAttributes DescriptionDescription
formData String ObjectString | Object
formData.htmlBody StringString <facultatif><optional> Chaîne qui contient du texte et des éléments HTML et qui représente le texte du formulaire de réponse. La chaîne est limitée à 32 Ko.A string that contains text and HTML and that represents the body of the reply form. The string is limited to 32 KB.
formData.attachments Array.<Object>Array.<Object> <facultatif><optional> Tableau d’objets JSON qui sont des pièces jointes de fichier ou d’élément.An array of JSON objects that are either file or item attachments.
formData.attachments.type StringString Indique le type de pièce jointe. Doit être file pour une pièce jointe de fichier ou item pour une pièce jointe d’élément.Indicates the type of attachment. Must be file for a file attachment or item for an item attachment.
formData.attachments.name StringString Chaîne qui contient le nom de la pièce jointe, d’une longueur maximale de 255 caractères.A string that contains the name of the attachment, up to 255 characters in length.
formData.attachments.url StringString Utilisé uniquement si type est défini sur file. Il s’agit de l’URI de l’emplacement du fichier.Only used if type is set to file. The URI of the location for the file.
formData.attachments.isInline BooléenBoolean Utilisé uniquement si type est défini sur file. Si elle est définie sur true, cette valeur indique que la pièce jointe est incluse dans le corps du message et qu’elle ne doit pas figurer dans la liste des pièces jointes.Only used if type is set to file. If true, indicates that the attachment will be shown inline in the message body, and should not be displayed in the attachment list.
formData.attachments.itemId StringString Utilisé uniquement si type est défini sur item. Il s’agit de l’identificateur de l’élément EWS de la pièce jointe. Cette chaîne doit être d’une longueur maximale de 100 caractères.Only used if type is set to item. The EWS item id of the attachment. This is a string up to 100 characters.
callback fonctionfunction <facultatif><optional> Une fois la méthode exécutée, la fonction transmise au paramètre callback est appelée avec un seul paramètre, asyncResult, qui est un objet AsyncResult.When the method completes, the function passed in the callback parameter is called with a single parameter, asyncResult, which is an AsyncResult object.
Conditions requisesRequirements
Condition requiseRequirement ValeurValue
Version minimale de l’ensemble des conditions requises de boîte aux lettresMinimum mailbox requirement set version 1.01.0
Niveau minimal d’autorisationMinimum permission level ReadItemReadItem
Mode Outlook applicableApplicable Outlook mode LectureRead
ExemplesExamples

Le code suivant transmet une chaîne à la fonction displayReplyAllForm.The following code passes a string to the displayReplyAllForm function.

Office.context.mailbox.item.displayReplyAllForm('hello there');
Office.context.mailbox.item.displayReplyAllForm('<b>hello there</b>');

Réponse sans texte.Reply with an empty body.

Office.context.mailbox.item.displayReplyAllForm({});

Réponse avec seulement une corps de message.Reply with just a body.

Office.context.mailbox.item.displayReplyAllForm(
{
  'htmlBody' : 'hi'
});

Réponse avec un texte et un fichier comme pièce jointe.Reply with a body and a file attachment.

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

Réponse avec un corps de message et un élément en pièce jointe.Reply with a body and an item attachment.

Office.context.mailbox.item.displayReplyAllForm(
{
  'htmlBody' : 'hi',
  'attachments' :
  [
    {
      'type' : 'item',
      'name' : 'rand',
      'itemId' : Office.context.mailbox.item.itemId
    }
  ]
});

Réponse avec un texte, un fichier comme pièce jointe, un élément comme pièce jointe et un rappel.Reply with a body, file attachment, item attachment, and a callback.

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

displayReplyForm(formData)displayReplyForm(formData)

Affiche un formulaire de réponse qui comprend uniquement l’expéditeur du message sélectionné ou l’organisateur du rendez-vous sélectionné.Displays a reply form that includes only the sender of the selected message or the organizer of the selected appointment.

Note

Cette méthode n’est pas prise en charge dans Outlook pour iOS ou Outlook pour Android.Note: This method is not supported in Outlook for iOS or Outlook for Android.

Sur Outlook Web App, le formulaire de réponse s’affiche sous forme de formulaire isolé dans l’affichage à 3 colonnes et sous forme de formulaire contextuel dans l’affichage à 1 ou 2 colonnes.In Outlook Web App, the reply form is displayed as a pop-out form in the 3-column view and a pop-up form in the 2- or 1-column view.

Si un des paramètres de chaîne dépasse la limite, displayReplyForm génère une exception.If any of the string parameters exceed their limits, displayReplyForm throws an exception.

Lorsque des pièces jointes sont spécifiées dans le paramètre formData.attachments, Outlook et Outlook Web App tentent de télécharger toutes les pièces jointes et de les joindre au formulaire de réponse. Si aucune pièce jointe n’est ajoutée, une erreur s’affiche dans l’interface utilisateur du formulaire. Si ce n’est pas possible, alors aucun message d’erreur n’est généré.When attachments are specified in the formData.attachments parameter, Outlook and Outlook Web App attempt to download all attachments and attach them to the reply form. If any attachments fail to be added, an error is shown in the form UI. If this isn't possible, then no error message is thrown.

Paramètres :Parameters:
NomName TypeType AttributsAttributes DescriptionDescription
formData String ObjectString | Object
formData.htmlBody StringString <facultatif><optional> Chaîne qui contient du texte et des éléments HTML et qui représente le texte du formulaire de réponse. La chaîne est limitée à 32 Ko.A string that contains text and HTML and that represents the body of the reply form. The string is limited to 32 KB.
formData.attachments Array.<Object>Array.<Object> <facultatif><optional> Tableau d’objets JSON qui sont des pièces jointes de fichier ou d’élément.An array of JSON objects that are either file or item attachments.
formData.attachments.type StringString Indique le type de pièce jointe. Doit être file pour une pièce jointe de fichier ou item pour une pièce jointe d’élément.Indicates the type of attachment. Must be file for a file attachment or item for an item attachment.
formData.attachments.name StringString Chaîne qui contient le nom de la pièce jointe, d’une longueur maximale de 255 caractères.A string that contains the name of the attachment, up to 255 characters in length.
formData.attachments.url StringString Utilisé uniquement si type est défini sur file. Il s’agit de l’URI de l’emplacement du fichier.Only used if type is set to file. The URI of the location for the file.
formData.attachments.isInline BooléenBoolean Utilisé uniquement si type est défini sur file. Si elle est définie sur true, cette valeur indique que la pièce jointe est incluse dans le corps du message et qu’elle ne doit pas figurer dans la liste des pièces jointes.Only used if type is set to file. If true, indicates that the attachment will be shown inline in the message body, and should not be displayed in the attachment list.
formData.attachments.itemId StringString Utilisé uniquement si type est défini sur item. Il s’agit de l’identificateur de l’élément EWS de la pièce jointe. Cette chaîne doit être d’une longueur maximale de 100 caractères.Only used if type is set to item. The EWS item id of the attachment. This is a string up to 100 characters.
callback fonctionfunction <facultatif><optional> Une fois la méthode exécutée, la fonction transmise au paramètre callback est appelée avec un seul paramètre, asyncResult, qui est un objet AsyncResult.When the method completes, the function passed in the callback parameter is called with a single parameter, asyncResult, which is an AsyncResult object.
Conditions requisesRequirements
Condition requiseRequirement ValeurValue
Version minimale de l’ensemble des conditions requises de boîte aux lettresMinimum mailbox requirement set version 1.01.0
Niveau minimal d’autorisationMinimum permission level ReadItemReadItem
Mode Outlook applicableApplicable Outlook mode LectureRead
ExemplesExamples

Le code suivant transmet une chaîne à la fonction displayReplyForm.The following code passes a string to the displayReplyForm function.

Office.context.mailbox.item.displayReplyForm('hello there');
Office.context.mailbox.item.displayReplyForm('<b>hello there</b>');

Réponse sans texte.Reply with an empty body.

Office.context.mailbox.item.displayReplyForm({});

Réponse avec seulement une corps de message.Reply with just a body.

Office.context.mailbox.item.displayReplyForm(
{
  'htmlBody' : 'hi'
});

Réponse avec un texte et un fichier comme pièce jointe.Reply with a body and a file attachment.

Office.context.mailbox.item.displayReplyForm(
{
  'htmlBody' : 'hi',
  'attachments' :
  [
    {
      'type' : Office.MailboxEnums.AttachmentType.File,
      'name' : 'squirrel.png',
      'url' : 'http://i.imgur.com/sRgTlGR.jpg'
    }
  ]
});

Réponse avec un corps de message et un élément en pièce jointe.Reply with a body and an item attachment.

Office.context.mailbox.item.displayReplyForm(
{
  'htmlBody' : 'hi',
  'attachments' :
  [
    {
      'type' : 'item',
      'name' : 'rand',
      'itemId' : Office.context.mailbox.item.itemId
    }
  ]
});

Réponse avec un texte, un fichier comme pièce jointe, un élément comme pièce jointe et un rappel.Reply with a body, file attachment, item attachment, and a callback.

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

getEntities() → {Entities}getEntities() → {Entities}

Obtient les entités figurant dans le texte de l’élément sélectionné.Gets the entities found in the selected item.

Note

Cette méthode n’est pas prise en charge dans Outlook pour iOS ou Outlook pour Android.Note: This method is not supported in Outlook for iOS or Outlook for Android.

Conditions requisesRequirements
Condition requiseRequirement ValeurValue
Version minimale de l’ensemble des conditions requises de boîte aux lettresMinimum mailbox requirement set version 1.01.0
Niveau minimal d’autorisationMinimum permission level ReadItemReadItem
Mode Outlook applicableApplicable Outlook mode LectureRead
Renvoie :Returns:

Type : EntitésType: Entities

ExempleExample

L’exemple suivant accède aux entités de contacts dans l’élément actif.The following example accesses the contacts entities on the current item.

var contacts = Office.context.mailbox.item.getEntities().contacts;

getEntitiesByType(entityType) → (nullable) {Array.<(String|Contact|MeetingSuggestion|PhoneNumber|TaskSuggestion)>}getEntitiesByType(entityType) → (nullable) {Array.<(String|Contact|MeetingSuggestion|PhoneNumber|TaskSuggestion)>}

Obtient un tableau de toutes les entités du type spécifié trouvées dans le texte de l’élément sélectionné.Gets an array of all the entities of the specified entity type found in the selected item.

Note

Cette méthode n’est pas prise en charge dans Outlook pour iOS ou Outlook pour Android.Note: This method is not supported in Outlook for iOS or Outlook for Android.

Paramètres :Parameters:
NomName TypeType DescriptionDescription
entityType Office.MailboxEnums.EntityTypeOffice.MailboxEnums.EntityType Une des valeurs d’énumération EntityType.One of the EntityType enumeration values.
Conditions requisesRequirements
Condition requiseRequirement ValeurValue
Version minimale de l’ensemble des conditions requises de boîte aux lettresMinimum mailbox requirement set version 1.01.0
Niveau minimal d’autorisationMinimum permission level RestreintRestricted
Mode Outlook applicableApplicable Outlook mode LectureRead
Renvoie :Returns:

Si la valeur transmise à entityType n’est pas un membre valide de l’énumération EntityType, la méthode renvoie la valeur null.If the value passed in entityType is not a valid member of the EntityType enumeration, the method returns null. Si aucune entité du type spécifié n’est présente dans le texte de l’élément, la méthode renvoie un tableau vide.If no entities of the specified type are present on the item, the method returns an empty array. Sinon, le type des objets dans le tableau renvoyé dépend du type d’entité demandé dans le paramètre entityType.Otherwise, the type of the objects in the returned array depends on the type of entity requested in the entityType parameter.

Alors que le niveau d’autorisation minimal Restricted suffit pour utiliser cette méthode, certains types d’entité nécessitent le niveau ReadItem pour pouvoir y accéder, comme indiqué dans le tableau suivant.While the minimum permission level to use this method is Restricted, some entity types require ReadItem to access, as specified in the following table.

Valeur de entityTypeValue of entityType Type des objets dans le tableau renvoyéType of objects in returned array Niveau d’autorisation requisRequired Permission Level
Address StringString RestreintRestricted
Contact ContactContact ReadItemReadItem
EmailAddress StringString ReadItemReadItem
MeetingSuggestion MeetingSuggestionMeetingSuggestion ReadItemReadItem
PhoneNumber PhoneNumberPhoneNumber RestreintRestricted
TaskSuggestion TaskSuggestionTaskSuggestion ReadItemReadItem
URL StringString RestreintRestricted

Type : Array.<(String|Contact|MeetingSuggestion|PhoneNumber|TaskSuggestion)>Type: Array.<(String|Contact|MeetingSuggestion|PhoneNumber|TaskSuggestion)>

ExempleExample

L’exemple suivant montre comment accéder à un tableau de chaînes qui représente des adresses postales dans le texte de l’élément actif.The following example shows how to access an array of strings that represent postal addresses in the subject or body of the current item.

// The initialize function is required for all apps.
Office.initialize = function () {
  // Checks for the DOM to load using the jQuery ready function.
  $(document).ready(function () {
    // After the DOM is loaded, app-specific code can run.
    var item = Office.context.mailbox.item;
    // Get an array of strings that represent postal addresses in the current item's body.
    var addresses = item.getEntitiesByType(Office.MailboxEnums.EntityType.Address);
    // Continue processing the array of addresses.
  });
}

getFilteredEntitiesByName(name) → (nullable) {Array.<(String|Contact|MeetingSuggestion|PhoneNumber|TaskSuggestion)>}getFilteredEntitiesByName(name) → (nullable) {Array.<(String|Contact|MeetingSuggestion|PhoneNumber|TaskSuggestion)>}

Renvoie des entités reconnues dans l’élément sélectionné, qui transmettent le filtre nommé défini au fichier manifeste XML.Returns well-known entities in the selected item that pass the named filter defined in the manifest XML file.

Note

Cette méthode n’est pas prise en charge dans Outlook pour iOS ou Outlook pour Android.Note: This method is not supported in Outlook for iOS or Outlook for Android.

La méthode getFilteredEntitiesByName renvoie les entités qui correspondent à l’expression régulière définie dans l’élément de règle ItemHasKnownEntity du fichier manifeste XML ayant la valeur de l’élément FilterName spécifié.The getFilteredEntitiesByName method returns the entities that match the regular expression defined in the ItemHasKnownEntity rule element in the manifest XML file with the specified FilterName element value.

Paramètres :Parameters:
NomName TypeType DescriptionDescription
name StringString Nom de l’élément de règle ItemHasKnownEntity qui définit le filtre à respecter.The name of the ItemHasKnownEntity rule element that defines the filter to match.
Conditions requisesRequirements
Condition requiseRequirement ValeurValue
Version minimale de l’ensemble des conditions requises de boîte aux lettresMinimum mailbox requirement set version 1.01.0
Niveau minimal d’autorisationMinimum permission level ReadItemReadItem
Mode Outlook applicableApplicable Outlook mode LectureRead
Renvoie :Returns:

Si aucun élément ItemHasKnownEntity dans le manifeste n’a une valeur d’élément FilterName qui correspond au paramètre name, la méthode renvoie null. Si le paramètre name correspond à un élément ItemHasKnownEntity dans le manifeste, mais qu’aucune entité dans l’élément actif ne correspond, la méthode renvoie un tableau vide.If there is no ItemHasKnownEntity element in the manifest with a FilterName element value that matches the name parameter, the method returns null. If the name parameter does match an ItemHasKnownEntity element in the manifest, but there are no entities in the current item that match, the method return an empty array.

Type : Array.<(String|Contact|MeetingSuggestion|PhoneNumber|TaskSuggestion)>Type: Array.<(String|Contact|MeetingSuggestion|PhoneNumber|TaskSuggestion)>

getRegExMatches() → {Object}getRegExMatches() → {Object}

Renvoie des valeurs de chaîne dans l’élément sélectionné, qui correspondent aux expressions régulières définies dans le fichier manifeste XML.Returns string values in the selected item that match the regular expressions defined in the manifest XML file.

Note

Cette méthode n’est pas prise en charge dans Outlook pour iOS ou Outlook pour Android.Note: This method is not supported in Outlook for iOS or Outlook for Android.

La méthode getRegExMatches renvoie les chaînes qui correspondent à l’expression régulière définie dans chaque élément de règle ItemHasRegularExpressionMatch ou ItemHasKnownEntity du fichier XML de manifeste. Pour une règle ItemHasRegularExpressionMatch, une chaîne correspondante doit être présente dans la propriété de l’élément spécifié par cette règle. Le type simple PropertyName définit les propriétés prises en charge.The getRegExMatches method returns the strings that match the regular expression defined in each ItemHasRegularExpressionMatch or ItemHasKnownEntity rule element in the manifest XML file. For an ItemHasRegularExpressionMatch rule, a matching string has to occur in the property of the item that is specified by that rule. The PropertyName simple type defines the supported properties.

Par exemple, supposons qu’un manifeste de complément contienne l’élément Rule suivant :For example, consider an add-in manifest has the following Rule element:

<Rule xsi:type="RuleCollection" Mode="And">
  <Rule xsi:type="ItemIs" FormType="Read" ItemType="Message" />
  <Rule xsi:type="RuleCollection" Mode="Or">
    <Rule xsi:type="ItemHasRegularExpressionMatch" RegExName="fruits" RegExValue="apple|banana|coconut" PropertyName="BodyAsPlaintext" IgnoreCase="true" />
    <Rule xsi:type="ItemHasRegularExpressionMatch" RegExName="veggies" RegExValue="tomato|onion|spinach|broccoli" PropertyName="BodyAsPlaintext" IgnoreCase="true" />
  </Rule>
</Rule>

L’objet renvoyé depuis getRegExMatches aurait deux propriétés : fruits et veggies.The object returned from getRegExMatches would have two properties: fruits and veggies.

{
  'fruits': ['apple','banana','Banana','coconut'],
  'veggies': ['tomato','onion','spinach','broccoli']
}

Si vous spécifiez une règle ItemHasRegularExpressionMatch pour la propriété de corps d’un élément, l’expression régulière doit filtrer davantage le texte. Par ailleurs, elle ne doit pas tenter de renvoyer l’intégralité du texte de l’élément. L’utilisation d’une expression régulière telle que .* pour obtenir l’intégralité du texte d’un élément ne renvoie pas toujours les résultats attendus. Utilisez plutôt la méthode Body.getAsync pour récupérer l’intégralité du texte de l’élément.If you specify an ItemHasRegularExpressionMatch rule on the body property of an item, the regular expression should further filter the body and should not attempt to return the entire body of the item. Using a regular expression such as .* to obtain the entire body of an item does not always return the expected results. Instead, use the Body.getAsync method to retrieve the entire body.

Conditions requisesRequirements
Condition requiseRequirement ValeurValue
Version minimale de l’ensemble des conditions requises de boîte aux lettresMinimum mailbox requirement set version 1.01.0
Niveau minimal d’autorisationMinimum permission level ReadItemReadItem
Mode Outlook applicableApplicable Outlook mode LectureRead
Renvoie :Returns:

Un objet qui contient les tableaux des chaînes correspondant aux expressions régulières définies dans le fichier XML de manifeste. Le nom de chaque tableau est égal à la valeur correspondante de l’attribut RegExName de la règle ItemHasRegularExpressionMatch correspondante ou de l’attribut FilterName de la règle ItemHasKnownEntity correspondante.An object that contains arrays of strings that match the regular expressions defined in the manifest XML file. The name of each array is equal to the corresponding value of the RegExName attribute of the matching ItemHasRegularExpressionMatch rule or the FilterName attribute of the matching ItemHasKnownEntity rule.

Type
Type
ObjetObject
ExempleExample

L’exemple suivant montre comment accéder au tableau de correspondances pour les éléments de règle d’expression régulière fruits et veggies, spécifiés dans le manifeste.The following example shows how to access the array of matches for the regular expression rule elements fruits and veggies, which are specified in the manifest.

var allMatches = Office.context.mailbox.item.getRegExMatches();
var fruits = allMatches.fruits;
var veges = allMatches.veggies;

getRegExMatchesByName(name) → (nullable) {Array.< String >}getRegExMatchesByName(name) → (nullable) {Array.< String >}

Renvoie des valeurs de chaîne dans l’élément sélectionné, qui correspondent aux expressions régulières nommées définies dans le fichier XML de manifeste.Returns string values in the selected item that match the named regular expression defined in the manifest XML file.

Note

Cette méthode n’est pas prise en charge dans Outlook pour iOS ou Outlook pour Android.Note: This method is not supported in Outlook for iOS or Outlook for Android.

La méthode getRegExMatchesByName renvoie les chaînes qui correspondent à l’expression régulière définie dans l’élément de règle ItemHasRegularExpressionMatch du fichier XML de manifeste ayant la valeur de l’élément RegExName spécifié.The getRegExMatchesByName method returns the strings that match the regular expression defined in the ItemHasRegularExpressionMatch rule element in the manifest XML file with the specified RegExName element value.

Si vous spécifiez une règle ItemHasRegularExpressionMatch pour la propriété de texte d’un élément, l’expression régulière doit filtrer davantage le texte. Par ailleurs, elle ne doit pas tenter de renvoyer l’intégralité du texte de l’élément. L’utilisation d’une expression régulière telle que .* pour obtenir l’intégralité du texte d’un élément ne renvoie pas toujours les résultats attendus.If you specify an ItemHasRegularExpressionMatch rule on the body property of an item, the regular expression should further filter the body and should not attempt to return the entire body of the item. Using a regular expression such as .* to obtain the entire body of an item does not always return the expected results.

Paramètres :Parameters:
NomName TypeType DescriptionDescription
name StringString Nom de l’élément de règle ItemHasRegularExpressionMatch qui définit le filtre à respecter.The name of the ItemHasRegularExpressionMatch rule element that defines the filter to match.
Conditions requisesRequirements
Condition requiseRequirement ValeurValue
Version minimale de l’ensemble des conditions requises de boîte aux lettresMinimum mailbox requirement set version 1.01.0
Niveau minimal d’autorisationMinimum permission level ReadItemReadItem
Mode Outlook applicableApplicable Outlook mode LectureRead
Renvoie :Returns:

Un tableau qui contient les chaînes correspondant à l’expression régulière définie dans le fichier manifeste XML.An array that contains the strings that match the regular expression defined in the manifest XML file.

Type
Type
Array.< String >Array.< String >
ExempleExample
var fruits = Office.context.mailbox.item.getRegExMatchesByName("fruits");
var veggies = Office.context.mailbox.item.getRegExMatchesByName("veggies");

getSelectedDataAsync(coercionType, [options], callback) → {String}getSelectedDataAsync(coercionType, [options], callback) → {String}

Renvoie de manière asynchrone les données sélectionnées à partir de l’objet ou du corps d’un message.Asynchronously returns selected data from the subject or body of a message.

Si aucune sélection n’est effectuée, mais que le curseur est placé dans le corps ou l’objet, la méthode renvoie la valeur null 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.If there is no selection but the cursor is in the body or subject, the method returns null for the selected data. If a field other than the body or subject is selected, the method returns the InvalidSelection error.

Paramètres :Parameters:
NomName TypeType AttributsAttributes DescriptionDescription
coercionType Office.CoercionTypeOffice.CoercionType Demande un format à attribuer aux données. S’il s’agit de Text, la méthode renvoie le texte brut en tant que chaîne, en retirant toutes les balises HTML présentes. S’il s’agit de HTML, la méthode renvoie le texte sélectionné, qu’il s’agisse de texte brut ou de langage HTML.Requests a format for the data. If Text, the method returns the plain text as a string , removing any HTML tags present. If HTML, the method returns the selected text, whether it is plaintext or HTML.
options ObjetObject <facultatif><optional> Littéral d’objet contenant une ou plusieurs des propriétés suivantes.An object literal that contains one or more of the following properties.
options.asyncContext ObjetObject <facultatif><optional> Les développeurs peuvent indiquer un objet auquel ils souhaitent accéder dans la méthode de rappel.Developers can provide any object they wish to access in the callback method.
callback fonctionfunction Quand la méthode se termine, la fonction passée dans le paramètre callback est appelée avec un seul paramètre, asyncResult, qui est un objet AsyncResult.When the method completes, the function passed in the callback parameter is called with a single parameter, asyncResult, which is an AsyncResult object.

Pour accéder aux données sélectionnées via la méthode de rappel, appelez la méthode asyncResult.value.data.To access the selected data from the callback method, call asyncResult.value.data. Pour accéder à la propriété source dont la sélection est issue, appelez la méthode asyncResult.value.sourceProperty, qui correspond à body ou subject.To access the source property that the selection comes from, call , which will be either or .
Conditions requisesRequirements
Condition requiseRequirement ValeurValue
Version minimale de l’ensemble des conditions requises de boîte aux lettresMinimum mailbox requirement set version 1.21.2
Niveau minimal d’autorisationMinimum permission level ReadWriteItemReadWriteItem
Mode Outlook applicableApplicable Outlook mode CompositionCompose
Renvoie :Returns:

Les données sélectionnées en tant que chaîne dont le format est déterminé par coercionType.The selected data as a string with format determined by coercionType.

Type
Type
StringString
ExempleExample
// getting selected data
Office.initialize = function () {
    Office.context.mailbox.item.getSelectedDataAsync(Office.CoercionType.Text, {}, getCallback);
}

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

    Office.context.mailbox.item.setSelectedDataAsync('Setting ' + prop + ': ' + text, {}, setCallback);
}

function setCallback(asyncResult) {
    // check for errors
}

getSelectedEntities() → {Entities}getSelectedEntities() → {Entities}

Obtient les entités figurant dans une correspondance en surbrillance qu’un utilisateur a sélectionné. Les correspondances en surbrillance s’appliquent aux compléments contextuels.Gets the entities found in a highlighted match a user has selected. Highlighted matches apply to contextual add-ins.

Note

Cette méthode n’est pas prise en charge dans Outlook pour iOS ou Outlook pour Android.Note: This method is not supported in Outlook for iOS or Outlook for Android.

Conditions requisesRequirements
Condition requiseRequirement ValeurValue
Version minimale de l’ensemble des conditions requises de boîte aux lettresMinimum mailbox requirement set version 1.6-16
Niveau minimal d’autorisationMinimum permission level ReadItemReadItem
Mode Outlook applicableApplicable Outlook mode LectureRead
Renvoie :Returns:

Type : EntitésType: Entities

ExempleExample

L’exemple suivant accède aux entités d’adresses dans la correspondance en surbrillance sélectionnée par l’utilisateur.The following example accesses the addresses entities in the highlighted match selected by the user.

var contacts = Office.context.mailbox.item.getSelectedEntities().addresses;

getSelectedRegExMatches() → {Object}getSelectedRegExMatches() → {Object}

Renvoie des valeurs de chaîne dans une correspondance en surbrillance, qui correspondent aux expressions régulières définies dans le fichier manifeste XML. Les correspondances en surbrillance s’appliquent aux compléments contextuels.Returns string values in a highlighted match that match the regular expressions defined in the manifest XML file. Highlighted matches apply to contextual add-ins.

Note

Cette méthode n’est pas prise en charge dans Outlook pour iOS ou Outlook pour Android.Note: This method is not supported in Outlook for iOS or Outlook for Android.

La méthode getSelectedRegExMatches renvoie les chaînes qui correspondent à l’expression régulière définie dans chaque élément de règle ItemHasRegularExpressionMatch ou ItemHasKnownEntity du fichier XML de manifeste. Pour une règle ItemHasRegularExpressionMatch, une chaîne correspondante doit être présente dans la propriété de l’élément spécifié par cette règle. Le type simple PropertyName définit les propriétés prises en charge.The getSelectedRegExMatches method returns the strings that match the regular expression defined in each ItemHasRegularExpressionMatch or ItemHasKnownEntity rule element in the manifest XML file. For an ItemHasRegularExpressionMatch rule, a matching string has to occur in the property of the item that is specified by that rule. The PropertyName simple type defines the supported properties.

Par exemple, supposons qu’un manifeste de complément contienne l’élément Rule suivant :For example, consider an add-in manifest has the following Rule element:

<Rule xsi:type="RuleCollection" Mode="And">
  <Rule xsi:type="ItemIs" FormType="Read" ItemType="Message" />
  <Rule xsi:type="RuleCollection" Mode="Or">
    <Rule xsi:type="ItemHasRegularExpressionMatch" RegExName="fruits" RegExValue="apple|banana|coconut" PropertyName="BodyAsPlaintext" IgnoreCase="true" />
    <Rule xsi:type="ItemHasRegularExpressionMatch" RegExName="veggies" RegExValue="tomato|onion|spinach|broccoli" PropertyName="BodyAsPlaintext" IgnoreCase="true" />
  </Rule>
</Rule>

L’objet renvoyé depuis getRegExMatches aurait deux propriétés : fruits et veggies.The object returned from getRegExMatches would have two properties: fruits and veggies.

{
  'fruits': ['apple','banana','Banana','coconut'],
  'veggies': ['tomato','onion','spinach','broccoli']
}

Si vous spécifiez une règle ItemHasRegularExpressionMatch pour la propriété de corps d’un élément, l’expression régulière doit filtrer davantage le texte. Par ailleurs, elle ne doit pas tenter de renvoyer l’intégralité du texte de l’élément. L’utilisation d’une expression régulière telle que .* pour obtenir l’intégralité du texte d’un élément ne renvoie pas toujours les résultats attendus. Utilisez plutôt la méthode Body.getAsync pour récupérer l’intégralité du texte de l’élément.If you specify an ItemHasRegularExpressionMatch rule on the body property of an item, the regular expression should further filter the body and should not attempt to return the entire body of the item. Using a regular expression such as .* to obtain the entire body of an item does not always return the expected results. Instead, use the Body.getAsync method to retrieve the entire body.

Conditions requisesRequirements
Condition requiseRequirement ValeurValue
Version minimale de l’ensemble des conditions requises de boîte aux lettresMinimum mailbox requirement set version 1.6-16
Niveau minimal d’autorisationMinimum permission level ReadItemReadItem
Mode Outlook applicableApplicable Outlook mode LectureRead
Renvoie :Returns:

Un objet qui contient les tableaux des chaînes correspondant aux expressions régulières définies dans le fichier manifeste XML. Le nom de chaque tableau est égal à la valeur correspondante de l’attribut RegExName de la règle ItemHasRegularExpressionMatch correspondante ou de l’attribut FilterName de la règle ItemHasKnownEntity correspondante.An object that contains arrays of strings that match the regular expressions defined in the manifest XML file. The name of each array is equal to the corresponding value of the RegExName attribute of the matching ItemHasRegularExpressionMatch rule or the FilterName attribute of the matching ItemHasKnownEntity rule.

ExempleExample

L’exemple suivant montre comment accéder au tableau de correspondances pour les éléments de règle d’expression régulière fruits et veggies, spécifiés dans le manifeste.The following example shows how to access the array of matches for the regular expression rule elements fruits and veggies, which are specified in the manifest.

var selectedMatches = Office.context.mailbox.item.getSelectedRegExMatches();
var fruits = selectedMatches.fruits;
var veggies = selectedMatches.veggies;

loadCustomPropertiesAsync(callback, [userContext])loadCustomPropertiesAsync(callback, [userContext])

Charge de manière asynchrone les propriétés personnalisées de ce complément vers l’élément sélectionné.Asynchronously loads custom properties for this add-in on the selected item.

Les propriétés personnalisées sont stockées sous la forme de paires clé/valeur qui s’appliquent à une application ou un é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 propres à l’élément et au complément actifs. Les propriétés personnalisées ne sont pas chiffrées dans l’élément, par conséquent elles ne doivent pas servir d’espace de stockage sécurisé.Custom properties are stored as key/value pairs on a per-app, per-item basis. This method returns a CustomProperties object in the callback, which provides methods to access the custom properties specific to the current item and the current add-in. Custom properties are not encrypted on the item, so this should not be used as secure storage.

Paramètres :Parameters:
NomName TypeType AttributsAttributes DescriptionDescription
callback fonctionfunction Quand la méthode se termine, la fonction passée dans le paramètre callback est appelée avec un seul paramètre, asyncResult, qui est un objet AsyncResult.When the method completes, the function passed in the callback parameter is called with a single parameter, asyncResult, which is an AsyncResult object.

Les propriétés personnalisées sont fournies sous la forme d’un objet CustomProperties dans la propriété asyncResult.value.The custom properties are provided as a CustomProperties object in the asyncResult.value property. Cet objet peut être utilisé pour obtenir, définir et supprimer les propriétés personnalisées de l’élément et sauvegarder les modifications du jeu de propriétés personnalisées sur le serveur.The custom properties are provided as a CustomProperties object in the asyncResult.value property. This object can be used to get, set, and remove custom properties from the item and save changes to the custom property set back to the server.
userContext ObjetObject <facultatif><optional> Les développeurs peuvent fournir n'importe quel objet auquel ils souhaitent accéder dans la méthode de rappel.Developers can provide any object they wish to access in the callback method. Cet objet est accessible via la propriété asyncResult.asyncContext dans la fonction de rappel.This object can be accessed by the asyncResult.asyncContext property in the callback function.
Conditions requisesRequirements
Condition requiseRequirement ValeurValue
Version minimale de l’ensemble des conditions requises de boîte aux lettresMinimum mailbox requirement set version 1.01.0
Niveau minimal d’autorisationMinimum permission level ReadItemReadItem
Mode Outlook applicableApplicable Outlook mode Composition ou lectureCompose or read
ExempleExample

L’exemple de code suivant montre comment utiliser la méthode loadCustomPropertiesAsync pour charger de manière asynchrone des propriétés personnalisées spécifiques vers l’élément actif. L’exemple montre également comment utiliser la méthode CustomProperties.saveAsync pour réenregistrer ces propriétés sur le serveur. Une fois le chargement des propriétés personnalisées terminé, l’exemple de code utilise la méthode CustomProperties.get pour lire la propriété personnalisée myProp, utilise la méthode CustomProperties.set pour écrire la propriété personnalisée otherProp, puis appelle enfin la méthode saveAsync pour enregistrer les propriétés personnalisées.The following code example shows how to use the loadCustomPropertiesAsync method to asynchronously load custom properties that are specific to the current item. The example also shows how to use the CustomProperties.saveAsync method to save these properties back to the server. After loading the custom properties, the code sample uses the CustomProperties.get method to read the custom property myProp, the CustomProperties.set method to write the custom property otherProp, and then finally calls the saveAsync method to save the custom properties.

// The initialize function is required for all add-ins.
Office.initialize = function () {
  // Checks for the DOM to load using the jQuery ready function.
  $(document).ready(function () {
  // After the DOM is loaded, add-in-specific code can run.
  var item = Office.context.mailbox.item;
  item.loadCustomPropertiesAsync(customPropsCallback);
  });
}

function customPropsCallback(asyncResult) {
  var customProps = asyncResult.value;
  var myProp = customProps.get("myProp");

  customProps.set("otherProp", "value");
  customProps.saveAsync(saveCallback);
}

function saveCallback(asyncResult) {
}

removeAttachmentAsync(attachmentId, [options], [callback])removeAttachmentAsync(attachmentId, [options], [callback])

Supprime une pièce jointe d’un message ou d’un rendez-vous.Removes an attachment from a message or appointment.

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 Web App et OWA pour les appareils, l’identificateur de pièce jointe n’est valable que dans la même session. Une session est terminée lorsque l’utilisateur ferme l’application, ou si celui-ci commence à composer dans un formulaire inclus et qu’il le fait ensuite apparaître dans une nouvelle fenêtre séparée.The removeAttachmentAsync method removes the attachment with the specified identifier from the item. As a best practice, you should use the attachment identifier to remove an attachment only if the same mail app has added that attachment in the same session. In Outlook Web App and OWA for Devices, the attachment identifier is valid only within the same session. A session is over when the user closes the app, or if the user starts composing in an inline form and subsequently pops out the inline form to continue in a separate window.

Paramètres :Parameters:
NomName TypeType AttributsAttributes DescriptionDescription
attachmentId StringString Identificateur de la pièce jointe à supprimer. La longueur maximale de la chaîne est de 100 caractères.The identifier of the attachment to remove. The maximum length of the string is 100 characters.
options ObjetObject <facultatif><optional> Littéral d’objet contenant une ou plusieurs des propriétés suivantes.An object literal that contains one or more of the following properties.
options.asyncContext ObjetObject <facultatif><optional> Les développeurs peuvent indiquer un objet auquel ils souhaitent accéder dans la méthode de rappel.Developers can provide any object they wish to access in the callback method.
callback fonctionfunction <facultatif><optional> Quand la méthode se termine, la fonction passée dans le paramètre callback est appelée avec un seul paramètre, asyncResult, qui est un objet AsyncResult.When the method completes, the function passed in the callback parameter is called with a single parameter, asyncResult, which is an AsyncResult object.
En cas d’échec de la suppression de la pièce jointe, la propriété asyncResult.error contient un code d’erreur et la raison de l’échec.If removing the attachment fails, the asyncResult.error property will contain an error code with the reason for the failure.
ErreursErrors
Code d’erreurError code DescriptionDescription
InvalidAttachmentId L’identificateur de la pièce jointe n’existe pas.The attachment identifier does not exist.
Conditions requisesRequirements
Condition requiseRequirement ValeurValue
Version minimale de l’ensemble des conditions requises de boîte aux lettresMinimum mailbox requirement set version 1.11.1
Niveau minimal d’autorisationMinimum permission level ReadWriteItemReadWriteItem
Mode Outlook applicableApplicable Outlook mode CompositionCompose
ExempleExample

Le code suivant supprime une pièce jointe dont l’identificateur est « 0 ».The following code removes an attachment with an identifier of '0'.

Office.context.mailbox.item.removeAttachmentAsync(
  '0',
  { asyncContext : null },
  function (asyncResult)
  {
    console.log(asyncResult.status);
  }
);

removeHandlerAsync(eventType, handler, [options], [callback])addHandlerAsync(eventType, handler, [options], [callback])

supprime un gestionnaire d’événements pour un événement pris en charge.Adds an event handler for a supported event.

Pour le moment, les types d’événements pris en charge sont Office.EventType.AppointmentTimeChanged, Office.EventType.RecipientsChanged, et Office.EventType.RecurrenceChangedCurrently the supported event types are Office.EventType.AppointmentTimeChanged, Office.EventType.RecipientsChanged, and Office.EventType.RecurrenceChanged

Paramètres :Parameters:
NomName TypeType AttributsAttributes DescriptionDescription
eventType Office.EventTypeOffice.EventType L’événement qui doit invoquer le gestionnaire.The event that should invoke the handler.
handler FonctionFunction La fonction permettant de gérer l’événement. Cette fonction doit accepter un seul paramètre, qui est un littéral d'objet. La propriété type sur le paramètre correspond au paramètre eventType transmis à removeHandlerAsync.The function to handle the event. The function must accept a single parameter, which is an object literal. The type property on the parameter will match the eventType parameter passed to removeHandlerAsync.
options ObjetObject <facultatif><optional> Littéral d’objet contenant une ou plusieurs des propriétés suivantes.An object literal that contains one or more of the following properties.
options.asyncContext ObjetObject <facultatif><optional> Les développeurs peuvent indiquer un objet auquel ils souhaitent accéder dans la méthode de rappel.Developers can provide any object they wish to access in the callback method.
callback fonctionfunction <facultatif><optional> Quand la méthode se termine, la fonction passée dans le paramètre callback est appelée avec un seul paramètre, asyncResult, qui est un objet AsyncResult.When the method completes, the function passed in the callback parameter is called with a single parameter, asyncResult, which is an AsyncResult object.
Conditions requisesRequirements
Condition requiseRequirement ValeurValue
Version minimale de l’ensemble des conditions requises de boîte aux lettresMinimum mailbox requirement set version 1.7-17
Niveau minimal d’autorisationMinimum permission level ReadItemReadItem
Mode Outlook applicableApplicable Outlook mode Composition ou lectureCompose or read
ExempleExample
Office.initialize = function (reason) {
  $(document).ready(function () {
    Office.context.mailbox.item.removeHandlerAsync(Office.EventType.RecurrenceChanged, loadNewItem, function (result) {
      if (result.status === Office.AsyncResultStatus.Failed) {
        // Handle error
      }
    });
  });
};

function loadNewItem(eventArgs) {
  // Load the properties of the newly selected item
  loadProps(Office.context.mailbox.item);
};

saveAsync([options], callback)saveAsync([options], callback)

Enregistre un élément de manière asynchrone.Asynchronously saves an item.

Lorsqu’elle est appelée, cette méthode enregistre le message en cours en tant que brouillon et renvoie l’identificateur de l’élément via la méthode de rappel. Dans Outlook Web App ou Outlook en mode en ligne, l’élément est enregistré sur le serveur. Dans Outlook en mode mis en cache, l’élément est enregistré dans le cache local.When invoked, this method saves the current message as a draft and returns the item id via the callback method. In Outlook Web App or Outlook in online mode, the item is saved to the server. In Outlook in cached mode, the item is saved to the local cache.

Note

Si votre complément appelle saveAsync sur un élément en mode composition afin d’obtenir un itemId pour utiliser avec EWS ou l’API REST, gardez à l’esprit que quand Outlook est en mode mis en cache, il peut prendre un certain temps avant que l’élément ne soit réellement synchronisé avec le serveur.Note: If your add-in calls saveAsync on an item in compose mode in order to get an itemId to use with EWS or the REST API, be aware that when Outlook is in cached mode, it may take some time before the item is actually synced to the server. Until the item is synced, using the will return an error. Jusqu'à ce que l’élément soit synchronisé, utiliser la propriété itemId renvoie une erreur.Until the item is synced, using the itemId will return an error.

Dans la mesure où 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é sous la forme d’un rendez-vous normal sur le calendrier de l’utilisateur. Pour les nouveaux rendez-vous qui n’ont pas été enregistrés, aucune invitation ne sera envoyée. L’enregistrement d’un rendez-vous existant envoie une mise à jour aux participants ajoutés ou supprimés.Since appointments have no draft state, if saveAsync is called on an appointment in compose mode, the item will be saved as a normal appointment on the user's calendar. For new appointments that have not been saved before, no invitation will be sent. Saving an existing appointment will send an update to added or removed attendees.

Note

Les clients suivants ont un comportement différent pour saveAsync pour les rendez-vous en mode composition :The following clients have different behavior for saveAsync on appointments in compose mode:

  • Outlook pour Mac ne gère pas saveAsync pour une réunion en mode composition.Note: Mac Outlook does not support saveAsync on a meeting in compose mode. Calling on a meeting in Mac Outlook will return an error. Faire appel à saveAsync pour une réunion dans Outlook Mac renverra une erreur.Note: Mac Outlook does not support on a meeting in compose mode. Calling saveAsync on a meeting in Mac Outlook will return an error.
  • Outlook sur le web envoie toujours une invitation ou une mise à jour quand saveAsync est appelée pour un rendez-vous en mode composition.Outlook on the web always sends an invitation or update when saveAsync is called on an appointment in compose mode.
Paramètres :Parameters:
NomName TypeType AttributsAttributes DescriptionDescription
options ObjetObject <facultatif><optional> Littéral d’objet contenant une ou plusieurs des propriétés suivantes.An object literal that contains one or more of the following properties.
options.asyncContext ObjetObject <facultatif><optional> Les développeurs peuvent indiquer un objet auquel ils souhaitent accéder dans la méthode de rappel.Developers can provide any object they wish to access in the callback method.
callback fonctionfunction Quand la méthode se termine, la fonction passée dans le paramètre callback est appelée avec un seul paramètre, asyncResult, qui est un objet AsyncResult.When the method completes, the function passed in the callback parameter is called with a single parameter, asyncResult, which is an AsyncResult object.

En cas de réussite, l’identificateur de l’élément est fourni dans la propriété asyncResult.value.On success, the item identifier is provided in the asyncResult.value property.
Conditions requisesRequirements
Condition requiseRequirement ValeurValue
Version minimale de l’ensemble des conditions requises de boîte aux lettresMinimum mailbox requirement set version 1.31.3
Niveau minimal d’autorisationMinimum permission level ReadWriteItemReadWriteItem
Mode Outlook applicableApplicable Outlook mode CompositionCompose
ExemplesExamples
Office.context.mailbox.item.saveAsync(
  function callback(result) {
    // Process the result
  });

Voici un exemple du paramètre result transmis à la fonction de rappel. La propriété value contient l’ID de l’élément.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"
}

setSelectedDataAsync(data, [options], callback)setSelectedDataAsync(data, [options], callback)

Insère les données dans le corps ou l’objet d’un message de manière asynchrone.Asynchronously inserts data into the body or subject of a message.

La méthode setSelectedDataAsync insère la chaîne spécifiée à l’emplacement du curseur dans le corps ou l’objet de l’élément. En revanche, si du texte est sélectionné dans l’éditeur, il remplace le texte sélectionné. Si le curseur ne se trouve pas dans les champs corps ou objet, une erreur est renvoyée. Après l’insertion, le curseur est placé à la fin du contenu inséré.The setSelectedDataAsync method inserts the specified string at the cursor location in the subject or body of the item, or, if text is selected in the editor, it replaces the selected text. If the cursor is not in the body or subject field, an error is returned. After insertion, the cursor is placed at the end of the inserted content.

Paramètres :Parameters:
NomName TypeType AttributsAttributes DescriptionDescription
data StringString Données à insérer. Les données ne doivent pas dépasser 1 000 000 caractères. Si elles contiennent plus de 1 000 000 caractères, une exception ArgumentOutOfRange est générée.The data to be inserted. Data is not to exceed 1,000,000 characters. If more than 1,000,000 characters are passed in, an ArgumentOutOfRange exception is thrown.
options ObjetObject <facultatif><optional> Littéral d’objet contenant une ou plusieurs des propriétés suivantes.An object literal that contains one or more of the following properties.
options.asyncContext ObjetObject <facultatif><optional> Les développeurs peuvent indiquer un objet auquel ils souhaitent accéder dans la méthode de rappel.Developers can provide any object they wish to access in the callback method.
options.coercionType Office.CoercionTypeOffice.CoercionType <facultatif><optional> Si text, le style existant est appliqué dans Outlook Web App et Outlook. Si le champ est un éditeur HTML, seules les données de texte sont insérées, même si les données sont au format HTML.If text, the current style is applied in Outlook Web App and Outlook. If the field is an HTML editor, only the text data is inserted, even if the data is HTML.

Avec html et si le champ prend en charge le langage HTML (contrairement à l’objet), le style existant est appliqué dans Outlook Web App et le style par défaut dans Outlook. Si le champ est au format texte, une erreur InvalidDataFormat est renvoyée.If html and the field supports HTML (the subject doesn't), the current style is applied in Outlook Web App and the default style is applied in Outlook. If the field is a text field, an InvalidDataFormat error is returned.

Si la propriété coercionType n’est pas définie, le résultat dépend du champ : si le champ est au format HTML, le langage HTML est utilisé. Si le champ est au format texte, le texte brut est utilisé.If coercionType is not set, the result depends on the field: if the field is HTML then HTML is used; if the field is text, then plain text is used.
callback fonctionfunction Quand la méthode se termine, la fonction passée dans le paramètre callback est appelée avec un seul paramètre, asyncResult, qui est un objet AsyncResult.When the method completes, the function passed in the callback parameter is called with a single parameter, asyncResult, which is an AsyncResult object.
Conditions requisesRequirements
Condition requiseRequirement ValeurValue
Version minimale de l’ensemble des conditions requises de boîte aux lettresMinimum mailbox requirement set version 1.21.2
Niveau minimal d’autorisationMinimum permission level ReadWriteItemReadWriteItem
Mode Outlook applicableApplicable Outlook mode CompositionCompose
ExempleExample
Office.context.mailbox.item.setSelectedDataAsync("Hello World!");
Office.context.mailbox.item.setSelectedDataAsync("<b>Hello World!</b>", { coercionType : "html" });