Office.AppointmentCompose interface
Mode organisateur de rendez-vous d’Office.context.mailbox.item.
Important : il s’agit d’un objet Outlook interne, qui n’est pas directement exposé via des interfaces existantes. Vous devez traiter cela comme un mode de Office.context.mailbox.item
. Pour plus d’informations, reportez-vous à la page Modèle objet .
Interfaces parentes :
- Extends
Propriétés
body | Obtient un objet qui fournit des méthodes permettant de manipuler le corps d’un élément. |
end | Obtient ou définit la date et l’heure de fin du rendez-vous. La Quand vous utilisez la méthode Important : dans le client Windows, vous ne pouvez pas utiliser cette propriété pour mettre à jour la fin d’une périodicité. |
item |
Obtient le type d’élément représenté par une instance. La propriété |
location | Obtient ou définit le lieu d’un rendez-vous. La |
optional |
Permet d’accéder aux participants facultatifs d’un événement. Le type d’objet et le niveau d’accès dépendent du mode de l’élément actif. La propriété |
required |
Permet d’accéder aux participants requis à un événement. Le type d’objet et le niveau d’accès dépendent du mode de l’élément actif. La propriété |
start | Obtient ou définit la date et l’heure de début du rendez-vous. La Quand vous utilisez la méthode Important : Dans le client Windows, vous ne pouvez pas utiliser cette propriété pour mettre à jour le début d’une périodicité. |
subject | Obtient ou définit la description qui apparaît dans le champ d’objet d’un élément. La propriété La propriété |
Méthodes
add |
Ajoute un fichier à un message ou un rendez-vous en pièce jointe. La méthode |
add |
Ajoute un fichier à un message ou un rendez-vous en pièce jointe. La méthode |
add |
Ajoute un élément Exchange, comme un message, en pièce jointe au message ou au rendez-vous. La méthode L’identificateur peut être utilisé avec la méthode Si votre complément Office s’exécute dans Outlook sur le web et outlook sur Windows, la |
add |
Ajoute un élément Exchange, comme un message, en pièce jointe au message ou au rendez-vous. La méthode L’identificateur peut être utilisé avec la méthode Si votre complément Office s’exécute dans Outlook sur le web et outlook sur Windows, la |
load |
Charge de manière asynchrone les propriétés personnalisées de ce complément vers l’élément sélectionné. Les propriétés personnalisées sont stockées sous forme de paires clé-valeur par application et par élément. Cette méthode renvoie un objet CustomProperties dans le rappel, qui fournit des méthodes pour accéder aux propriétés personnalisées spécifiques à l’élément actuel et au complément actuel. Les propriétés personnalisées ne sont pas chiffrées sur l’élément. Il ne doit donc pas être utilisé comme stockage sécurisé. Les propriétés personnalisées sont fournies sous la forme d’un objet |
remove |
Supprime une pièce jointe d’un message ou d’un rendez-vous. La méthode |
remove |
Supprime une pièce jointe d’un message ou d’un rendez-vous. La méthode |
Détails de la propriété
body
Obtient un objet qui fournit des méthodes permettant de manipuler le corps d’un élément.
body: Body;
Valeur de propriété
Remarques
[ Ensemble d’API : Boîte aux lettres 1.1 ]
Niveau d’autorisation minimal : élément de lecture
Mode Outlook applicable : Organisateur de rendez-vous
Exemples
// This example gets the body of the item as plain text.
Office.context.mailbox.item.body.getAsync(
"text",
{ asyncContext: "This is passed to the callback" },
function callback(result) {
// Do something with the result.
});
// The following is an example of an object that is passed as the result parameter to the callback function.
{
"value": "TEXT of whole body (including threads below)",
"status": "succeeded",
"asyncContext": "This is passed to the callback"
}
end
Obtient ou définit la date et l’heure de fin du rendez-vous.
La end
propriété est un objet Time exprimé sous la forme d’une valeur de date et d’heure UTC (Coordinated Universal Time). Vous pouvez utiliser la convertToLocalClientTime
méthode pour convertir la valeur de la end
propriété en date et heure locales du client.
Quand vous utilisez la méthode Time.setAsync
pour définir l’heure de fin, nous vous recommandons d’utiliser la méthode convertToUtcClientTime
pour convertir l’heure locale du client au format UTC pour le serveur.
Important : dans le client Windows, vous ne pouvez pas utiliser cette propriété pour mettre à jour la fin d’une périodicité.
end: Time;
Valeur de propriété
Remarques
Niveau d’autorisation minimal : élément de lecture
Mode Outlook applicable : Organisateur de rendez-vous
Exemples
// The following example sets the end time of an appointment in compose mode by
// using the `setAsync` method of the `Time` object.
const endTime = new Date("3/14/2015");
const options = {
// Pass information that can be used in the callback.
asyncContext: {verb: "Set"}
};
Office.context.mailbox.item.end.setAsync(endTime, options, function(result) {
if (result.error) {
console.debug(result.error);
} else {
// Access the asyncContext that was passed to the setAsync method.
console.debug("End Time " + result.asyncContext.verb);
}
});
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-set-end-appointment-organizer.yaml
Office.context.mailbox.item.end.getAsync((result) => {
if (result.status !== Office.AsyncResultStatus.Succeeded) {
console.error(`Action failed with message ${result.error.message}`);
return;
}
console.log(`Appointment ends: ${result.value}`);
});
...
Office.context.mailbox.item.start.getAsync((result) => {
if (result.status !== Office.AsyncResultStatus.Succeeded) {
console.error(`Get start date failed with message ${result.error.message}`);
return;
}
const end = result.value; // Set end to current start date and time.
end.setDate(end.getDate() + 1); // Set end as 1 day later than start date.
Office.context.mailbox.item.end.setAsync(end, (result) => {
if (result.status !== Office.AsyncResultStatus.Succeeded) {
console.error(`Set end date failed with message ${result.error.message}`);
return;
}
console.log(`Successfully set end date and time to ${end}`);
});
});
itemType
Obtient le type d’élément représenté par une instance.
La propriété itemType
renvoie une des valeurs d’énumération ItemType
indiquant si l’instance d’objet item
est un message ou un rendez-vous.
itemType: MailboxEnums.ItemType | string;
Valeur de propriété
Office.MailboxEnums.ItemType | string
Remarques
Niveau d’autorisation minimal : élément de lecture
Mode Outlook applicable : Organisateur de rendez-vous
Exemples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-item-type.yaml
const itemType = Office.context.mailbox.item.itemType;
switch (itemType) {
case Office.MailboxEnums.ItemType.Appointment:
console.log(`Current item is an ${itemType}.`);
break;
case Office.MailboxEnums.ItemType.Message:
console.log(`Current item is a ${itemType}. A message could be an email, meeting request, meeting response, or meeting cancellation.`);
break;
}
location
Obtient ou définit le lieu d’un rendez-vous. La location
propriété renvoie un objet Location qui fournit des méthodes utilisées pour obtenir et définir l’emplacement du rendez-vous.
location: Location;
Valeur de propriété
Remarques
Niveau d’autorisation minimal : élément de lecture
Mode Outlook applicable : Organisateur de rendez-vous
Exemples
const userContext = { value : 1 };
Office.context.mailbox.item.location.getAsync( { context: userContext}, callback);
function callback(asyncResult) {
const context = asyncResult.context;
const location = asyncResult.value;
}
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-set-location-appointment-organizer.yaml
Office.context.mailbox.item.location.getAsync((result) => {
if (result.status !== Office.AsyncResultStatus.Succeeded) {
console.error(`Action failed with message ${result.error.message}`);
return;
}
console.log(`Appointment location: ${result.value}`);
});
...
const location = "my office";
Office.context.mailbox.item.location.setAsync(location, (result) => {
if (result.status !== Office.AsyncResultStatus.Succeeded) {
console.error(`Action failed with message ${result.error.message}`);
return;
}
console.log(`Successfully set location to ${location}`);
});
optionalAttendees
Permet d’accéder aux participants facultatifs d’un événement. Le type d’objet et le niveau d’accès dépendent du mode de l’élément actif.
La propriété optionalAttendees
renvoie un objet Recipients
qui fournit des méthodes permettant d’obtenir ou de mettre à jour les participants facultatifs d’une réunion. Toutefois, en fonction du client/plateforme (par exemple, Windows, Mac, etc.), des limites peuvent s’appliquer au nombre de destinataires que vous pouvez obtenir ou mettre à jour. Pour plus d’informations, consultez l’objet Recipients .
optionalAttendees: Recipients;
Valeur de propriété
Remarques
Niveau d’autorisation minimal : élément de lecture
Mode Outlook applicable : Organisateur de rendez-vous
Exemples
Office.context.mailbox.item.optionalAttendees.setAsync( ['alice@contoso.com', 'bob@contoso.com'] );
Office.context.mailbox.item.optionalAttendees.addAsync( ['jason@contoso.com'] );
Office.context.mailbox.item.optionalAttendees.getAsync(callback);
function callback(asyncResult) {
const arrayOfOptionalAttendeesRecipients = asyncResult.value;
}
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-set-optional-attendees-appointment-organizer.yaml
Office.context.mailbox.item.optionalAttendees.getAsync(function(asyncResult) {
if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
const apptOptionalAttendees = asyncResult.value;
for (let i = 0; i < apptOptionalAttendees.length; i++) {
console.log(
"Optional attendees: " +
apptOptionalAttendees[i].displayName +
" (" +
apptOptionalAttendees[i].emailAddress +
") - response: " +
apptOptionalAttendees[i].appointmentResponse
);
}
} else {
console.error(asyncResult.error);
}
});
...
const email = $("#emailOptional")
.val()
.toString();
const emailArray = [email];
Office.context.mailbox.item.optionalAttendees.setAsync(emailArray, function(asyncResult) {
if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
console.log("Succeeded in setting optional attendees field.");
} else {
console.error(asyncResult.error);
}
});
requiredAttendees
Permet d’accéder aux participants requis à un événement. Le type d’objet et le niveau d’accès dépendent du mode de l’élément actif.
La propriété requiredAttendees
renvoie un objet Recipients
qui fournit des méthodes permettant d’obtenir ou de mettre à jour les participants requis à une réunion. Toutefois, en fonction du client/plateforme (par exemple, Windows, Mac, etc.), des limites peuvent s’appliquer au nombre de destinataires que vous pouvez obtenir ou mettre à jour. Pour plus d’informations, consultez l’objet Recipients .
requiredAttendees: Recipients;
Valeur de propriété
Remarques
Niveau d’autorisation minimal : élément de lecture
Mode Outlook applicable : Organisateur de rendez-vous
Exemples
Office.context.mailbox.item.requiredAttendees.setAsync( ['alice@contoso.com', 'bob@contoso.com'] );
Office.context.mailbox.item.requiredAttendees.addAsync( ['jason@contoso.com'] );
Office.context.mailbox.item.requiredAttendees.getAsync(callback);
function callback(asyncResult) {
const arrayOfRequiredAttendeesRecipients = asyncResult.value;
console.log(JSON.stringify(arrayOfRequiredAttendeesRecipients));
}
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-set-required-attendees-appointment-organizer.yaml
Office.context.mailbox.item.requiredAttendees.getAsync(function(asyncResult) {
if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
const apptRequiredAttendees = asyncResult.value;
for (let i = 0; i < apptRequiredAttendees.length; i++) {
console.log(
"Required attendees: " +
apptRequiredAttendees[i].displayName +
" (" +
apptRequiredAttendees[i].emailAddress +
") - response: " +
apptRequiredAttendees[i].appointmentResponse
);
}
} else {
console.error(asyncResult.error);
}
});
...
const email = $("#emailRequired")
.val()
.toString();
const emailArray = [email];
Office.context.mailbox.item.requiredAttendees.setAsync(emailArray, function(asyncResult) {
if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
console.log("Succeeded in setting required attendees field.");
} else {
console.error(asyncResult.error);
}
});
start
Obtient ou définit la date et l’heure de début du rendez-vous.
La start
propriété est un objet Time exprimé sous la forme d’une valeur de date et d’heure UTC (Coordinated Universal Time). Vous pouvez utiliser la convertToLocalClientTime
méthode pour convertir la valeur en date et heure locales du client.
Quand vous utilisez la méthode Time.setAsync
pour définir l’heure de début, nous vous recommandons d’utiliser la méthode convertToUtcClientTime
pour convertir l’heure locale du client au format UTC pour le serveur.
Important : Dans le client Windows, vous ne pouvez pas utiliser cette propriété pour mettre à jour le début d’une périodicité.
start: Time;
Valeur de propriété
Remarques
Niveau d’autorisation minimal : élément de lecture
Mode Outlook applicable : Organisateur de rendez-vous
Exemples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-set-start-appointment-organizer.yaml
Office.context.mailbox.item.start.getAsync((result) => {
if (result.status !== Office.AsyncResultStatus.Succeeded) {
console.error(`Action failed with message ${result.error.message}`);
return;
}
console.log(`Appointment starts: ${result.value}`);
});
...
const start = new Date(); // Represents current date and time.
start.setDate(start.getDate() + 2); // Add 2 days to current date.
Office.context.mailbox.item.start.setAsync(start, (result) => {
if (result.status !== Office.AsyncResultStatus.Succeeded) {
console.error(`Action failed with message ${result.error.message}`);
return;
}
console.log(`Successfully set start date and time to ${start}`);
});
subject
Obtient ou définit la description qui apparaît dans le champ d’objet d’un élément.
La propriété subject
obtient ou définit l’intégralité de l’objet de l’élément, tel qu’il est envoyé par le serveur de messagerie.
La propriété subject
renvoie un objet Subject
qui fournit des méthodes pour obtenir et définir l’objet.
subject: Subject;
Valeur de propriété
Remarques
Niveau d’autorisation minimal : élément de lecture
Mode Outlook applicable : Organisateur de rendez-vous
Exemples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-set-subject-compose.yaml
Office.context.mailbox.item.subject.getAsync((result) => {
if (result.status !== Office.AsyncResultStatus.Succeeded) {
console.error(`Action failed with message ${result.error.message}`);
return;
}
console.log(`Subject: ${result.value}`);
});
...
let subject = "Hello World!";
Office.context.mailbox.item.subject.setAsync(subject, (result) => {
if (result.status !== Office.AsyncResultStatus.Succeeded) {
console.error(`Action failed with message ${result.error.message}`);
return;
}
console.log(`Successfully set subject to ${subject}`);
});
Détails de la méthode
addFileAttachmentAsync(uri, attachmentName, options, callback)
Ajoute un fichier à un message ou un rendez-vous en pièce jointe.
La méthode addFileAttachmentAsync
charge le fichier depuis l’URI spécifié et le joint à l’élément dans le formulaire de composition.
addFileAttachmentAsync(uri: string, attachmentName: string, options: Office.AsyncContextOptions & { isInline: boolean }, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;
Paramètres
- uri
-
string
URI indiquant l’emplacement du fichier à joindre au message ou au rendez-vous. La longueur maximale est de 2 048 caractères.
- attachmentName
-
string
Nom de la pièce jointe affiché lors de son chargement. La longueur maximale est de 255 caractères.
- options
-
Office.AsyncContextOptions & { isInline: boolean }
Littéral d’objet qui contient une ou plusieurs des propriétés suivantes : les asyncContext
développeurs peuvent fournir n’importe quel objet auquel ils souhaitent accéder dans la fonction de rappel.
isInline
: si la valeur est true, indique que la pièce jointe sera affichée en tant qu’image dans le corps du message et ne sera pas affichée dans la liste des pièces jointes.
- callback
-
(asyncResult: Office.AsyncResult<string>) => void
Optional. Une fois la méthode terminée, la fonction passée dans le callback
paramètre est appelée avec un seul paramètre de type Office.AsyncResult
. En cas de réussite, l’identificateur de pièce jointe est fourni dans la propriété asyncResult.value
. 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.
Retours
void
Remarques
[ Ensemble d’API : Boîte aux lettres 1.1 ]
Niveau d’autorisation minimal : élément en lecture/écriture
Mode Outlook applicable : Organisateur de rendez-vous
Important:
Dans les versions récentes d’Outlook classique sur Windows, un bogue a été introduit qui ajoute incorrectement un
Authorization: Bearer
en-tête à cette action (que ce soit à l’aide de cette API ou de l’interface utilisateur Outlook). Pour contourner ce problème, vous pouvez essayer d’utiliser l’API introduite avec l’ensembleaddFileAttachmentFromBase64
de conditions requises 1.8.L’URI du fichier à joindre doit prendre en charge la mise en cache en production. Le serveur hébergeant l’image ne doit pas retourner d’en-tête
Cache-Control
qui spécifieno-cache
,no-store
ou des options similaires dans la réponse HTTP. Toutefois, lorsque vous développez le complément et apportez des modifications aux fichiers, la mise en cache peut vous empêcher de voir vos modifications. Nous vous recommandons d’utiliserCache-Control
des en-têtes pendant le développement.Vous pouvez utiliser le même URI avec la
removeAttachmentAsync
méthode pour supprimer la pièce jointe dans la même session.
Erreurs :
AttachmentSizeExceeded
: la pièce jointe est plus grande que ce qui est autorisé.FileTypeNotSupported
: la pièce jointe a une extension qui n’est pas autorisée.NumberOfAttachmentsExceeded
: le message ou le rendez-vous contient trop de pièces jointes.
Exemples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/40-attachments/attachments-compose.yaml
const attachmentUrl = $("#attachmentUrl")
.val()
.toString();
Office.context.mailbox.item.addFileAttachmentAsync(
attachmentUrl,
getFileName(attachmentUrl),
{ isInline: false },
(result) => {
console.log(result);
}
);
addFileAttachmentAsync(uri, attachmentName, callback)
Ajoute un fichier à un message ou un rendez-vous en pièce jointe.
La méthode addFileAttachmentAsync
charge le fichier depuis l’URI spécifié et le joint à l’élément dans le formulaire de composition.
addFileAttachmentAsync(uri: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;
Paramètres
- uri
-
string
URI indiquant l’emplacement du fichier à joindre au message ou au rendez-vous. La longueur maximale est de 2 048 caractères.
- attachmentName
-
string
Nom de la pièce jointe affiché lors de son chargement. La longueur maximale est de 255 caractères.
- callback
-
(asyncResult: Office.AsyncResult<string>) => void
Optional. Une fois la méthode terminée, la fonction passée dans le callback
paramètre est appelée avec un seul paramètre de type Office.AsyncResult
. En cas de réussite, l’identificateur de pièce jointe est fourni dans la propriété asyncResult.value
. 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.
Retours
void
Remarques
[ Ensemble d’API : Boîte aux lettres 1.1 ]
Niveau d’autorisation minimal : élément en lecture/écriture
Mode Outlook applicable : Organisateur de rendez-vous
Important:
Dans les versions récentes d’Outlook classique sur Windows, un bogue a été introduit qui ajoute incorrectement un
Authorization: Bearer
en-tête à cette action (que ce soit à l’aide de cette API ou de l’interface utilisateur Outlook). Pour contourner ce problème, vous pouvez essayer d’utiliser l’API introduite avec l’ensembleaddFileAttachmentFromBase64
de conditions requises 1.8.L’URI du fichier à joindre doit prendre en charge la mise en cache en production. Le serveur hébergeant l’image ne doit pas retourner d’en-tête
Cache-Control
qui spécifieno-cache
,no-store
ou des options similaires dans la réponse HTTP. Toutefois, lorsque vous développez le complément et apportez des modifications aux fichiers, la mise en cache peut vous empêcher de voir vos modifications. Nous vous recommandons d’utiliserCache-Control
des en-têtes pendant le développement.Vous pouvez utiliser le même URI avec la
removeAttachmentAsync
méthode pour supprimer la pièce jointe dans la même session.
Erreurs :
AttachmentSizeExceeded
: la pièce jointe est plus grande que ce qui est autorisé.FileTypeNotSupported
: la pièce jointe a une extension qui n’est pas autorisée.NumberOfAttachmentsExceeded
: le message ou le rendez-vous contient trop de pièces jointes.
addItemAttachmentAsync(itemId, attachmentName, options, callback)
Ajoute un élément Exchange, comme un message, en pièce jointe au message ou au rendez-vous.
La méthode addItemAttachmentAsync
joint l’élément avec l’identificateur Exchange spécifié à l’élément du formulaire de composition. Si vous spécifiez une fonction de rappel, la méthode est appelée avec un paramètre, asyncResult
, qui contient l’identificateur de pièce jointe ou un code qui indique toute erreur qui s’est produite lors de l’attachement de l’élément. Vous pouvez utiliser le options
paramètre pour transmettre des informations d’état à la fonction de rappel, si nécessaire.
L’identificateur peut être utilisé avec la méthode removeAttachmentAsync
pour supprimer la pièce jointe dans la même session.
Si votre complément Office s’exécute dans Outlook sur le web et outlook sur Windows, la addItemAttachmentAsync
méthode peut attacher des éléments à des éléments autres que l’élément que vous modifiez. Toutefois, cela n’est pas pris en charge et n’est pas recommandé.
addItemAttachmentAsync(itemId: any, attachmentName: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;
Paramètres
- itemId
-
any
Identificateur Exchange de l’élément à joindre. La taille maximale est de 100 caractères.
- attachmentName
-
string
Nom de la pièce jointe affiché lors de son chargement. La longueur maximale est de 255 caractères.
- options
- Office.AsyncContextOptions
Littéral d’objet qui contient une ou plusieurs des propriétés suivantes : les asyncContext
développeurs peuvent fournir n’importe quel objet auquel ils souhaitent accéder dans la fonction de rappel.
- callback
-
(asyncResult: Office.AsyncResult<string>) => void
Optional. Une fois la méthode terminée, la fonction passée dans le paramètre de rappel est appelée avec un seul paramètre de type Office.AsyncResult
. En cas de réussite, l’identificateur de pièce jointe est fourni dans la propriété asyncResult.value
. 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.
Retours
void
Remarques
[ Ensemble d’API : Boîte aux lettres 1.1 ]
Niveau d’autorisation minimal : élément en lecture/écriture
Mode Outlook applicable : Organisateur de rendez-vous
Erreurs :
-
NumberOfAttachmentsExceeded
: le message ou le rendez-vous contient trop de pièces jointes.
Exemples
// The following example adds an existing Outlook item as an attachment
// with the name "My Attachment".
function addAttachment() {
// EWS ID of item to attach (shortened for readability).
const itemId = "AAMkADI1...AAA=";
// The values in asyncContext can be accessed in the callback.
const options = { asyncContext: { var1: 1, var2: 2 } };
Office.context.mailbox.item.addItemAttachmentAsync(itemId, "My Attachment", options, (result) => {
if (result.status === Office.AsyncResultStatus.Failed) {
console.error("Failed to add attachment: " + result.error.message);
return;
}
console.log("Attachment added successfully.");
console.log("var1: " + result.asyncContext.var1);
console.log("var2: " + result.asyncContext.var2);
});
}
addItemAttachmentAsync(itemId, attachmentName, callback)
Ajoute un élément Exchange, comme un message, en pièce jointe au message ou au rendez-vous.
La méthode addItemAttachmentAsync
joint l’élément avec l’identificateur Exchange spécifié à l’élément du formulaire de composition. Si vous spécifiez une fonction de rappel, la méthode est appelée avec un paramètre, asyncResult
, qui contient l’identificateur de pièce jointe ou un code qui indique toute erreur qui s’est produite lors de l’attachement de l’élément. Vous pouvez utiliser le options
paramètre pour transmettre des informations d’état à la fonction de rappel, si nécessaire.
L’identificateur peut être utilisé avec la méthode removeAttachmentAsync
pour supprimer la pièce jointe dans la même session.
Si votre complément Office s’exécute dans Outlook sur le web et outlook sur Windows, la addItemAttachmentAsync
méthode peut attacher des éléments à des éléments autres que l’élément que vous modifiez. Toutefois, cela n’est pas pris en charge et n’est pas recommandé.
addItemAttachmentAsync(itemId: any, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;
Paramètres
- itemId
-
any
Identificateur Exchange de l’élément à joindre. La taille maximale est de 100 caractères.
- attachmentName
-
string
Nom de la pièce jointe affiché lors de son chargement. La longueur maximale est de 255 caractères.
- callback
-
(asyncResult: Office.AsyncResult<string>) => void
Optional. Une fois la méthode terminée, la fonction passée dans le paramètre de rappel est appelée avec un seul paramètre de type Office.AsyncResult
. En cas de réussite, l’identificateur de pièce jointe est fourni dans la propriété asyncResult.value
. 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.
Retours
void
Remarques
[ Ensemble d’API : Boîte aux lettres 1.1 ]
Niveau d’autorisation minimal : élément en lecture/écriture
Mode Outlook applicable : Organisateur de rendez-vous
Erreurs :
-
NumberOfAttachmentsExceeded
: le message ou le rendez-vous contient trop de pièces jointes.
loadCustomPropertiesAsync(callback, userContext)
Charge de manière asynchrone les propriétés personnalisées de ce complément vers l’élément sélectionné.
Les propriétés personnalisées sont stockées sous forme de paires clé-valeur par application et par élément. Cette méthode renvoie un objet CustomProperties dans le rappel, qui fournit des méthodes pour accéder aux propriétés personnalisées spécifiques à l’élément actuel et au complément actuel. Les propriétés personnalisées ne sont pas chiffrées sur l’élément. Il ne doit donc pas être utilisé comme stockage sécurisé.
Les propriétés personnalisées sont fournies sous la forme d’un objet CustomProperties
dans la propriété asyncResult.value
. Cet objet peut être utilisé pour obtenir, définir, enregistrer et supprimer des propriétés personnalisées de l’élément de courrier.
loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult<CustomProperties>) => void, userContext?: any): void;
Paramètres
- callback
-
(asyncResult: Office.AsyncResult<Office.CustomProperties>) => void
Une fois la méthode terminée, la fonction passée dans le callback
paramètre est appelée avec un seul paramètre de type Office.AsyncResult
.
- userContext
-
any
Optional. Les développeurs peuvent fournir un objet auquel ils souhaitent accéder dans la fonction de rappel. Cet objet est accessible via la propriété asyncResult.asyncContext
dans la fonction de rappel.
Retours
void
Remarques
[ Ensemble d’API : Boîte aux lettres 1.1 ]
Pour en savoir plus sur les propriétés personnalisées, voir Obtenir et définir des métadonnées de complément pour un complément Outlook.
Niveau d’autorisation minimal : élément de lecture
Mode Outlook applicable : Organisateur de rendez-vous
Exemples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/15-item-custom-properties/load-set-get-save.yaml
Office.context.mailbox.item.loadCustomPropertiesAsync((result) => {
if (result.status === Office.AsyncResultStatus.Failed) {
console.error(`loadCustomPropertiesAsync failed with message ${result.error.message}`);
return;
}
customProps = result.value;
console.log("Loaded the CustomProperties object.");
});
removeAttachmentAsync(attachmentId, options, callback)
Supprime une pièce jointe d’un message ou d’un rendez-vous.
La méthode removeAttachmentAsync
supprime la pièce jointe avec l’identificateur spécifié de l’élément. Nous vous recommandons vivement de supprimer une pièce jointe à l’aide de son identificateur uniquement si la même application de messagerie a ajouté cette pièce jointe au cours de la même session. Dans Outlook sur le web, sur les appareils mobiles et dans le nouvel Outlook sur Windows, l’identificateur de pièce jointe n’est valide que dans la même session. Une session est terminée lorsque l’utilisateur ferme l’application, ou si l’utilisateur commence à composer un formulaire inline, puis affiche ensuite le formulaire pour continuer dans une fenêtre distincte.
removeAttachmentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
Paramètres
- attachmentId
-
string
Identificateur de la pièce jointe à supprimer. La longueur de chaîne maximale du est attachmentId
de 200 caractères dans Outlook sur le web et sur Windows (nouveau et classique).
- options
- Office.AsyncContextOptions
Littéral d’objet qui contient une ou plusieurs des propriétés suivantes : les asyncContext
développeurs peuvent fournir n’importe quel objet auquel ils souhaitent accéder dans la fonction de rappel.
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
Optional. Une fois la méthode terminée, la fonction passée dans le callback
paramètre est appelée avec un seul paramètre de type Office.AsyncResult
. 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.
Retours
void
Remarques
[ Ensemble d’API : Boîte aux lettres 1.1 ]
Niveau d’autorisation minimal : élément en lecture/écriture
Mode Outlook applicable : Organisateur de rendez-vous
Important* : la removeAttachmentAsync
méthode ne supprime pas les pièces jointes inline d’un élément de courrier. Pour supprimer une pièce jointe inline, commencez par obtenir le corps de l’élément, puis supprimez toutes les références de la pièce jointe de son contenu. Utilisez les API Office.Body pour obtenir et définir le corps d’un élément.
Erreurs :
-
InvalidAttachmentId
: l’identificateur de pièce jointe n’existe pas.
Exemples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/40-attachments/attachments-compose.yaml
Office.context.mailbox.item.removeAttachmentAsync(
$("#attachmentId")
.val()
.toString(),
(result) => {
if (result.status === Office.AsyncResultStatus.Failed) {
console.error(result.error.message);
return;
}
console.log(`Attachment removed successfully.`);
}
);
removeAttachmentAsync(attachmentId, callback)
Supprime une pièce jointe d’un message ou d’un rendez-vous.
La méthode removeAttachmentAsync
supprime la pièce jointe avec l’identificateur spécifié de l’élément. Nous vous recommandons vivement de supprimer une pièce jointe à l’aide de son identificateur uniquement si la même application de messagerie a ajouté cette pièce jointe au cours de la même session. Dans Outlook sur le web, sur les appareils mobiles et dans le nouvel Outlook sur Windows, l’identificateur de pièce jointe n’est valide que dans la même session. Une session est terminée lorsque l’utilisateur ferme l’application, ou si l’utilisateur commence à composer un formulaire inline, puis affiche ensuite le formulaire pour continuer dans une fenêtre distincte.
removeAttachmentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
Paramètres
- attachmentId
-
string
Identificateur de la pièce jointe à supprimer. La longueur de chaîne maximale du est attachmentId
de 200 caractères dans Outlook sur le web et sur Windows (nouveau et classique).
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
Optional. Une fois la méthode terminée, la fonction passée dans le callback
paramètre est appelée avec un seul paramètre de type Office.AsyncResult
. 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.
Retours
void
Remarques
[ Ensemble d’API : Boîte aux lettres 1.1 ]
Niveau d’autorisation minimal : élément en lecture/écriture
Mode Outlook applicable : Organisateur de rendez-vous
Important* : la removeAttachmentAsync
méthode ne supprime pas les pièces jointes inline d’un élément de courrier. Pour supprimer une pièce jointe inline, commencez par obtenir le corps de l’élément, puis supprimez toutes les références de la pièce jointe de son contenu. Utilisez les API Office.Body pour obtenir et définir le corps d’un élément.
Erreurs :
-
InvalidAttachmentId
: l’identificateur de pièce jointe n’existe pas.