Office.Recipients interface

Ajoute une liste de destinataires aux destinataires existants d’un rendez-vous ou d’un message.

addAsync(recipients: Array<string | EmailUser | EmailAddressDetails>, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Paramètres

Retours

Remarques

Jeu d’API : Boîte aux lettres 1.1

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

Mode Outlook applicable : Compose

Important:

Avec cette addAsync méthode, vous pouvez ajouter un maximum de 100 destinataires à un élément de courrier à la fois dans Outlook sur le web, sur Windows (nouveau et classique), sur Mac (interface utilisateur classique), sur Android et sur iOS. Toutefois, prenez note des points suivants :

• Dans Outlook classique sur Windows (Boîte aux lettres 1.15 et versions antérieures) et sur Mac (interface utilisateur classique), vous pouvez avoir un maximum de 500 destinataires dans un champ cible. Dans Outlook classique sur Windows, les clients qui prennent en charge la boîte aux lettres 1.16 et versions ultérieures peuvent avoir un maximum de 1 000 destinataires. Les champs cibles dans Outlook sur le web et la nouvelle version d’Outlook sur Windows n’ont aucune limite de destinataires. Si vous devez ajouter plus de 100 destinataires à un courrier, vous pouvez appeler addAsync à plusieurs reprises, mais n’oubliez pas la limite de destinataires du champ.

• Dans Outlook sur Android et iOS, la méthode est prise en charge à partir de la addAsync version 4.2530.0. Sur ces clients mobiles, la addAsync méthode n’est pas prise en charge lorsqu’un utilisateur répond à partir du champ de réponse au bas d’un message.

Il n’y a aucune limite de destinataires si vous appelez addAsync dans Outlook sur Mac (nouvelle interface utilisateur).

La addAsync méthode n’est pas prise en charge sur un message actuellement chargé à l’aide de la loadItemByIdAsync méthode. Pour plus d’informations, voir Activer votre complément Outlook sur plusieurs messages.

Tous les clients Outlook utilisent des règles d’expression régulière pour résoudre les adresses e-mail dans les champs de destinataire.

Dans Outlook sur le web et la nouvelle version d’Outlook sur Windows, addAsync et setAsync ajoutez les adresses e-mail résolues et non résolues aux champs de destinataire. Toutefois, les adresses e-mail non résolues empêchent l’envoi d’un élément tant qu’il n’a pas été résolu ou validé avec succès. Si des destinataires non résolus sont ajoutés par un complément Smart Alerts à n’importe quel champ destinataire, l’opération d’envoi est bloquée et une notification d’erreur s’affiche. La notification d’erreur identifie le complément qui a ajouté les destinataires non résolus et répertorie les adresses e-mail concernées. Si une boîte de dialogue Alertes intelligentes s’affiche après avoir sélectionné Envoyer, la notification d’erreur s’affiche après la fermeture de la boîte de dialogue (en sélectionnant Envoyer quand même ou Ne pas envoyer, ou en fermant la boîte de dialogue).

Erreurs :

• NumberOfRecipientsExceeded : Le nombre de destinataires a dépassé les 100 entrées.

Exemples

// The following example creates an array of EmailUser objects
// and adds them to the To recipients of the message.
const newRecipients = [
    {
        "displayName": "Allie Bellew",
        "emailAddress": "allieb@contoso.com"
    },
    {
        "displayName": "Alex Darrow",
        "emailAddress": "alexd@contoso.com"
    }
];

Office.context.mailbox.item.to.addAsync(newRecipients, function(result) {
    if (result.error) {
        console.log(result.error);
    } else {
        console.log("Recipients added");
    }
});

Ajoute une liste de destinataires aux destinataires existants d’un rendez-vous ou d’un message.

addAsync(recipients: Array<string | EmailUser | EmailAddressDetails>, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Paramètres

Retours

Remarques

Jeu d’API : Boîte aux lettres 1.1

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

Mode Outlook applicable : Compose

Important:

Avec cette addAsync méthode, vous pouvez ajouter un maximum de 100 destinataires à un élément de courrier à la fois dans Outlook sur le web, sur Windows (nouveau et classique), sur Mac (interface utilisateur classique), sur Android et sur iOS. Toutefois, prenez note des points suivants :

• Dans Outlook classique sur Windows (Boîte aux lettres 1.15 et versions antérieures) et sur Mac (interface utilisateur classique), vous pouvez avoir un maximum de 500 destinataires dans un champ cible. Dans Outlook classique sur Windows, les clients qui prennent en charge la boîte aux lettres 1.16 et versions ultérieures peuvent avoir un maximum de 1 000 destinataires. Les champs cibles dans Outlook sur le web et la nouvelle version d’Outlook sur Windows n’ont aucune limite de destinataires. Si vous devez ajouter plus de 100 destinataires à un courrier, vous pouvez appeler addAsync à plusieurs reprises, mais n’oubliez pas la limite de destinataires du champ.

• Dans Outlook sur Android et iOS, la méthode est prise en charge à partir de la addAsync version 4.2530.0. Sur ces clients mobiles, la addAsync méthode n’est pas prise en charge lorsqu’un utilisateur répond à partir du champ de réponse au bas d’un message.

Il n’y a aucune limite de destinataires si vous appelez addAsync dans Outlook sur Mac (nouvelle interface utilisateur).

La addAsync méthode n’est pas prise en charge sur un message actuellement chargé à l’aide de la loadItemByIdAsync méthode. Pour plus d’informations, voir Activer votre complément Outlook sur plusieurs messages.

Tous les clients Outlook utilisent des règles d’expression régulière pour résoudre les adresses e-mail dans les champs de destinataire.

Dans Outlook sur le web et la nouvelle version d’Outlook sur Windows, addAsync et setAsync ajoutez les adresses e-mail résolues et non résolues aux champs de destinataire. Toutefois, les adresses e-mail non résolues empêchent l’envoi d’un élément tant qu’il n’a pas été résolu ou validé avec succès. Si des destinataires non résolus sont ajoutés par un complément Smart Alerts à n’importe quel champ destinataire, l’opération d’envoi est bloquée et une notification d’erreur s’affiche. La notification d’erreur identifie le complément qui a ajouté les destinataires non résolus et répertorie les adresses e-mail concernées. Si une boîte de dialogue Alertes intelligentes s’affiche après avoir sélectionné Envoyer, la notification d’erreur s’affiche après la fermeture de la boîte de dialogue (en sélectionnant Envoyer quand même ou Ne pas envoyer, ou en fermant la boîte de dialogue).

Erreurs :

• NumberOfRecipientsExceeded : Le nombre de destinataires a dépassé les 100 entrées.

Obtient une liste de destinataires pour un rendez-vous ou un message.

getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<EmailAddressDetails[]>) => void): void;

Paramètres

Retours

Remarques

Jeu d’API : Boîte aux lettres 1.1

Niveau d’autorisation minimal : lire l’élément

Mode Outlook applicable : Compose

Important:

Le nombre maximal de destinataires retournés par cette méthode varie selon le client Outlook.

• Windows (classique - Boîte aux lettres 1.15 et versions antérieures), Mac (interface utilisateur classique) : 500 destinataires

• Web, Windows (nouveau, classique - Boîte aux lettres 1.16 et versions ultérieures) : 1 000 destinataires

• Android, iOS : 100 destinataires

• Mac (nouvelle interface utilisateur) : Aucune limite

Dans Outlook classique sur Windows, l’organisateur de rendez-vous est inclus dans l’objet retourné par la getAsync méthode lorsque vous créez un rendez-vous ou en modifiez un existant. Dans Outlook sur le web et la nouvelle version d’Outlook sur Windows, l’organisateur est inclus dans l’objet renvoyé uniquement lorsque vous modifiez un rendez-vous existant.

La getAsync méthode renvoie uniquement les destinataires résolus par le client Outlook. Un destinataire résolu présente les caractéristiques suivantes.

• Si le destinataire a une entrée enregistrée dans le carnet d’adresses de l’expéditeur, Outlook résout l’adresse e-mail avec le nom complet enregistré du destinataire.

• Une icône de status de réunion Teams s’affiche devant le nom ou l’adresse e-mail du destinataire.

• Un point-virgule apparaît après le nom ou l’adresse e-mail du destinataire.

• Le nom ou l’adresse e-mail du destinataire est souligné ou encadré.

Pour résoudre une adresse e-mail une fois ajoutée à un courrier, l’expéditeur doit utiliser la touche Tab ou sélectionner un contact ou une adresse e-mail suggérés dans la liste de saisie semi-automatique.

Dans Outlook sur le web et sur Windows (nouveau et classique), si un utilisateur crée un message en activant le lien de l’adresse e-mail d’un contact à partir de sa carte de contact ou de visite, l’appel de Recipients.getAsync votre complément retourne l’adresse e-mail du contact dans la displayName propriété de l’objet EmailAddressDetails associé au lieu du nom enregistré du contact. Pour plus d’informations, consultez le problème GitHub associé.

Lorsque vous composez un élément de courrier, lorsque vous basculez vers un compte d’expéditeur sur un domaine différent de celui du compte d’expéditeur précédemment sélectionné, la valeur de la recipientType propriété pour les destinataires existants n’est pas mise à jour et reste basée sur le domaine du compte précédemment sélectionné. Pour obtenir les types de destinataires corrects après avoir changé de compte, vous devez d’abord supprimer les destinataires existants, puis les rajouter à l’élément Courrier.

Dans Outlook sur Android et iOS, seule la getAsync méthode est prise en charge lorsqu’un utilisateur répond à partir du champ de réponse situé au bas d’un message.

Obtient une liste de destinataires pour un rendez-vous ou un message.

getAsync(callback: (asyncResult: Office.AsyncResult<EmailAddressDetails[]>) => void): void;

Paramètres

Retours

Remarques

Jeu d’API : Boîte aux lettres 1.1

Niveau d’autorisation minimal : lire l’élément

Mode Outlook applicable : Compose

Important:

Le nombre maximal de destinataires retournés par cette méthode varie selon le client Outlook.

• Windows (classique - Boîte aux lettres 1.15 et versions antérieures), Mac (interface utilisateur classique) : 500 destinataires

• Web, Windows (nouveau, classique - Boîte aux lettres 1.16 et versions ultérieures) : 1 000 destinataires

• Android, iOS : 100 destinataires

• Mac (nouvelle interface utilisateur) : Aucune limite

La getAsync méthode renvoie uniquement les destinataires résolus par le client Outlook. Un destinataire résolu présente les caractéristiques suivantes.

• Si le destinataire a une entrée enregistrée dans le carnet d’adresses de l’expéditeur, Outlook résout l’adresse e-mail avec le nom complet enregistré du destinataire.

• Une icône de status de réunion Teams s’affiche devant le nom ou l’adresse e-mail du destinataire.

• Un point-virgule apparaît après le nom ou l’adresse e-mail du destinataire.

• Le nom ou l’adresse e-mail du destinataire est souligné ou encadré.

Pour résoudre une adresse e-mail une fois ajoutée à un courrier, l’expéditeur doit utiliser la touche Tab ou sélectionner un contact ou une adresse e-mail suggérés dans la liste de saisie semi-automatique.

Dans Outlook sur le web et sur Windows (nouveau et classique), si un utilisateur crée un message en activant le lien de l’adresse e-mail d’un contact à partir de sa carte de contact ou de visite, l’appel de Recipients.getAsync votre complément retourne l’adresse e-mail du contact dans la displayName propriété de l’objet EmailAddressDetails associé au lieu du nom enregistré du contact. Pour plus d’informations, consultez le problème GitHub associé.

Lorsque vous composez un élément de courrier, lorsque vous basculez vers un compte d’expéditeur sur un domaine différent de celui du compte d’expéditeur précédemment sélectionné, la valeur de la recipientType propriété pour les destinataires existants n’est pas mise à jour et reste basée sur le domaine du compte précédemment sélectionné. Pour obtenir les types de destinataires corrects après avoir changé de compte, vous devez d’abord supprimer les destinataires existants, puis les rajouter à l’élément Courrier.

Dans Outlook sur Android et iOS, seule la getAsync méthode est prise en charge lorsqu’un utilisateur répond à partir du champ de réponse situé au bas d’un message.

Exemples

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

Office.context.mailbox.item.bcc.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const msgBcc = asyncResult.value;
    console.log("Message being blind-copied to:");
    for (let i = 0; i < msgBcc.length; i++) {
      console.log(msgBcc[i].displayName + " (" + msgBcc[i].emailAddress + ")");
    }
  } else {
    console.error(asyncResult.error);
  }
});

...

Office.context.mailbox.item.cc.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const msgCc = asyncResult.value;
    console.log("Message being copied to:");
    for (let i = 0; i < msgCc.length; i++) {
      console.log(msgCc[i].displayName + " (" + msgCc[i].emailAddress + ")");
    }
  } else {
    console.error(asyncResult.error);
  }
});

...

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

...

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

...

Office.context.mailbox.item.to.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const msgTo = asyncResult.value;
    console.log("Message being sent to:");
    for (let i = 0; i < msgTo.length; i++) {
      console.log(msgTo[i].displayName + " (" + msgTo[i].emailAddress + ")");
    }
  } else {
    console.error(asyncResult.error);
  }
});

Définit une liste de destinataires pour un rendez-vous ou un message.

La méthode setAsync remplace la liste des destinataires active.

setAsync(recipients: Array<string | EmailUser | EmailAddressDetails>, options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<void>) => void): void;

Paramètres

Retours

Remarques

Jeu d’API : Boîte aux lettres 1.1

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

Mode Outlook applicable : Compose

Important:

Avec la setAsync méthode, vous pouvez définir un maximum de 100 destinataires à la fois dans Outlook sur le web, sur Windows (nouveau et classique), sur Mac (interface utilisateur classique), sur Android et sur iOS. Toutefois, prenez note des points suivants :

• Dans Outlook classique sur Windows (Boîte aux lettres 1.15 et versions antérieures) et sur Mac (interface utilisateur classique), vous pouvez avoir un maximum de 500 destinataires dans un champ cible. Dans Outlook classique sur Windows, les clients qui prennent en charge la boîte aux lettres 1.16 et versions ultérieures peuvent avoir un maximum de 1 000 destinataires. Les champs cibles dans Outlook sur le web et la nouvelle version d’Outlook sur Windows n’ont aucune limite de destinataires. Si vous devez ajouter plus de 100 destinataires à un courrier, vous pouvez appeler addAsync à plusieurs reprises, mais n’oubliez pas la limite de destinataires du champ.

• Dans Outlook sur Android et iOS, la méthode est prise en charge à partir de la setAsync version 4.2530.0. Sur ces clients mobiles, la setAsync méthode n’est pas prise en charge lorsqu’un utilisateur répond à partir du champ de réponse au bas d’un message.

Il n’y a aucune limite de destinataires si vous appelez setAsync dans Outlook sur Mac (nouvelle interface utilisateur).

La setAsync méthode n’est pas prise en charge sur un message actuellement chargé à l’aide de la loadItemByIdAsync méthode. Pour plus d’informations, voir Activer votre complément Outlook sur plusieurs messages.

Tous les clients Outlook utilisent des règles d’expression régulière pour résoudre les adresses e-mail dans les champs de destinataire.

Dans Outlook sur le web et la nouvelle version d’Outlook sur Windows, addAsync et setAsync ajoutez les adresses e-mail résolues et non résolues aux champs de destinataire. Toutefois, les adresses e-mail non résolues empêchent l’envoi d’un élément tant qu’il n’a pas été résolu ou validé avec succès. Si des destinataires non résolus sont ajoutés par un complément Smart Alerts à n’importe quel champ destinataire, l’opération d’envoi est bloquée et une notification d’erreur s’affiche. La notification d’erreur identifie le complément qui a ajouté les destinataires non résolus et répertorie les adresses e-mail concernées. Si une boîte de dialogue Alertes intelligentes s’affiche après avoir sélectionné Envoyer, la notification d’erreur s’affiche après la fermeture de la boîte de dialogue (en sélectionnant Envoyer quand même ou Ne pas envoyer, ou en fermant la boîte de dialogue).

Erreurs :

• NumberOfRecipientsExceeded : Le nombre de destinataires a dépassé les 100 entrées.

Définit une liste de destinataires pour un rendez-vous ou un message.

La méthode setAsync remplace la liste des destinataires active.

setAsync(recipients: Array<string | EmailUser | EmailAddressDetails>, callback: (asyncResult: Office.AsyncResult<void>) => void): void;

Paramètres

Retours

Remarques

Jeu d’API : Boîte aux lettres 1.1

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

Mode Outlook applicable : Compose

Important:

Avec la setAsync méthode, vous pouvez définir un maximum de 100 destinataires à la fois dans Outlook sur le web, sur Windows (nouveau et classique), sur Mac (interface utilisateur classique), sur Android et sur iOS. Toutefois, prenez note des points suivants :

• Dans Outlook classique sur Windows (Boîte aux lettres 1.15 et versions antérieures) et sur Mac (interface utilisateur classique), vous pouvez avoir un maximum de 500 destinataires dans un champ cible. Dans Outlook classique sur Windows, les clients qui prennent en charge la boîte aux lettres 1.16 et versions ultérieures peuvent avoir un maximum de 1 000 destinataires. Les champs cibles dans Outlook sur le web et la nouvelle version d’Outlook sur Windows n’ont aucune limite de destinataires. Si vous devez ajouter plus de 100 destinataires à un courrier, vous pouvez appeler addAsync à plusieurs reprises, mais n’oubliez pas la limite de destinataires du champ.

• Dans Outlook sur Android et iOS, la méthode est prise en charge à partir de la setAsync version 4.2530.0. Sur ces clients mobiles, la setAsync méthode n’est pas prise en charge lorsqu’un utilisateur répond à partir du champ de réponse au bas d’un message.

Il n’y a aucune limite de destinataires si vous appelez setAsync dans Outlook sur Mac (nouvelle interface utilisateur).

La setAsync méthode n’est pas prise en charge sur un message actuellement chargé à l’aide de la loadItemByIdAsync méthode. Pour plus d’informations, voir Activer votre complément Outlook sur plusieurs messages.

Tous les clients Outlook utilisent des règles d’expression régulière pour résoudre les adresses e-mail dans les champs de destinataire.

Dans Outlook sur le web et la nouvelle version d’Outlook sur Windows, addAsync et setAsync ajoutez les adresses e-mail résolues et non résolues aux champs de destinataire. Toutefois, les adresses e-mail non résolues empêchent l’envoi d’un élément tant qu’il n’a pas été résolu ou validé avec succès. Si des destinataires non résolus sont ajoutés par un complément Smart Alerts à n’importe quel champ destinataire, l’opération d’envoi est bloquée et une notification d’erreur s’affiche. La notification d’erreur identifie le complément qui a ajouté les destinataires non résolus et répertorie les adresses e-mail concernées. Si une boîte de dialogue Alertes intelligentes s’affiche après avoir sélectionné Envoyer, la notification d’erreur s’affiche après la fermeture de la boîte de dialogue (en sélectionnant Envoyer quand même ou Ne pas envoyer, ou en fermant la boîte de dialogue).

Erreurs :

• NumberOfRecipientsExceeded : Le nombre de destinataires a dépassé les 100 entrées.

Exemples

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

const email = (document.getElementById("emailBcc") as HTMLInputElement).value;
const emailArray = [email];
Office.context.mailbox.item.bcc.setAsync(emailArray, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Succeeded in setting Bcc field.");
  } else {
    console.error(asyncResult.error);
  }
});

...

const email = (document.getElementById("emailCc") as HTMLInputElement).value;
const emailArray = [email];
Office.context.mailbox.item.cc.setAsync(emailArray, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Succeeded in setting Cc field.");
  } else {
    console.error(asyncResult.error);
  }
});

...

const email = (document.getElementById("emailOptional") as HTMLInputElement).value;
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);
  }
});

...

const email = (document.getElementById("emailRequired") as HTMLInputElement).value;
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);
  }
});

...

const email = (document.getElementById("emailTo") as HTMLInputElement).value;
const emailArray = [email];
Office.context.mailbox.item.to.setAsync(emailArray, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Succeeded in setting To field.");
  } else {
    console.error(asyncResult.error);
  }
});