Office.Recipients interface

Référence

Paquet:: outlook

Représente les destinataires d’un élément. Mode composition uniquement.

Remarques

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

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

Mode Outlook applicable : Composer

Méthodes

addAsync(recipients, options, callback)	Ajoute une liste de destinataires aux destinataires existants d’un rendez-vous ou d’un message.
addAsync(recipients, callback)	Ajoute une liste de destinataires aux destinataires existants d’un rendez-vous ou d’un message.
getAsync(options, callback)	Obtient une liste de destinataires pour un rendez-vous ou un message.
getAsync(callback)	Obtient une liste de destinataires pour un rendez-vous ou un message.
setAsync(recipients, options, callback)	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, callback)	Définit une liste de destinataires pour un rendez-vous ou un message. La méthode `setAsync` remplace la liste des destinataires active.

Détails de la méthode

addAsync(recipients, options, callback)

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

recipients: Array<string | Office.EmailUser | Office.EmailAddressDetails>

Destinataires à ajouter à la liste des destinataires. Le tableau de destinataires peut contenir des chaînes d’adresses e-mail SMTP, d’objets EmailUser ou d’objets EmailAddressDetails .

options: Office.AsyncContextOptions

Littéral d’objet qui contient une ou plusieurs des propriétés suivantes : les asyncContextdéveloppeurs peuvent fournir n’importe quel objet auquel ils souhaitent accéder dans la fonction de rappel.

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

Facultatif. 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 l’ajout des destinataires, la propriété asyncResult.error contient un code d’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 : Composer

Important : avec la addAsync méthode , vous pouvez ajouter un maximum de 100 destinataires à un élément de courrier dans Outlook sur Windows, sur Mac (interface utilisateur classique), sur le web, sur Android et sur iOS. Toutefois, notez les points suivants :

Dans Outlook sur Windows, sur Mac (interface utilisateur classique) et sur le web, vous pouvez avoir un maximum de 500 destinataires dans un champ cible. Si vous devez ajouter plus de 100 destinataires à un élément de courrier, vous pouvez appeler addAsync à plusieurs reprises, mais gardez à l’esprit la limite de destinataires du champ.
Dans Outlook sur Android et sur iOS, la addAsync méthode n’est pas prise en charge en mode De rédaction de messages. Seul le mode Organisateur de rendez-vous est pris en charge. Pour plus d’informations sur les API prises en charge dans Outlook Mobile, consultez API JavaScript Outlook prises en charge dans Outlook sur les appareils mobiles.

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

Erreurs :

NumberOfRecipientsExceeded: le nombre de destinataires a dépassé 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");
    }
});

addAsync(recipients, callback)

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

recipients: Array<string | Office.EmailUser | Office.EmailAddressDetails>

Destinataires à ajouter à la liste des destinataires. Le tableau de destinataires peut contenir des chaînes d’adresses e-mail SMTP, d’objets EmailUser ou d’objets EmailAddressDetails .

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

Retours

void

Remarques

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

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

Mode Outlook applicable : Composer

Dans Outlook sur Windows, sur Mac (interface utilisateur classique) et sur le web, vous pouvez avoir un maximum de 500 destinataires dans un champ cible. Si vous devez ajouter plus de 100 destinataires à un élément de courrier, vous pouvez appeler addAsync à plusieurs reprises, mais gardez à l’esprit la limite de destinataires du champ.
Dans Outlook sur Android et sur iOS, la addAsync méthode n’est pas prise en charge en mode De rédaction de messages. Seul le mode Organisateur de rendez-vous est pris en charge. Pour plus d’informations sur les API prises en charge dans Outlook Mobile, consultez API JavaScript Outlook prises en charge dans Outlook sur les appareils mobiles.

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

Erreurs :

NumberOfRecipientsExceeded: le nombre de destinataires a dépassé 100 entrées.

getAsync(options, callback)

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

options: Office.AsyncContextOptions

callback: (asyncResult: Office.AsyncResult<Office.EmailAddressDetails[]>) => 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, asyncResult, de type Office.AsyncResult. La asyncResult.value propriété du résultat est un tableau d’objets EmailAddressDetails .

Retours

void

Remarques

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

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

Mode Outlook applicable : Composer

Important:

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

Windows, navigateur web, Mac (interface utilisateur classique) : 500 destinataires
Android, iOS : 100 destinataires
Mac (nouvelle interface utilisateur) : aucune limite

La getAsync méthode retourne 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 en nom complet enregistré du destinataire.
Une icône de status de réunion Teams s’affiche avant 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 placé dans une zone.

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

Dans Outlook sur le web et sur Windows, si un utilisateur crée un message en activant le lien d’adresse e-mail d’un contact à partir de son contact ou de son profil carte, l’appel de Recipients.getAsync votre complément renvoie 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 problème GitHub associé.

getAsync(callback)

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

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

Paramètres

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

Retours

void

Remarques

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

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

Mode Outlook applicable : Composer

Important:

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

Windows, navigateur web, Mac (interface utilisateur classique) : 500 destinataires
Android, iOS : 100 destinataires
Mac (nouvelle interface utilisateur) : aucune limite

La getAsync méthode retourne 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 en nom complet enregistré du destinataire.
Une icône de status de réunion Teams s’affiche avant 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 placé dans une zone.

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

setAsync(recipients, options, callback)

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

recipients: Array<string | Office.EmailUser | Office.EmailAddressDetails>

Destinataires à ajouter à la liste des destinataires. Le tableau de destinataires peut contenir des chaînes d’adresses e-mail SMTP, d’objets EmailUser ou d’objets EmailAddressDetails .

options: Office.AsyncContextOptions

callback: (asyncResult: Office.AsyncResult<void>) => 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. En cas d’échec de la définition des destinataires, la propriété asyncResult.error contient un code indiquant toute erreur survenue lors de l’ajout des données.

Retours

void

Remarques

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

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

Mode Outlook applicable : Composer

Important : avec la setAsync méthode , vous pouvez définir un maximum de 100 destinataires dans Outlook sur Windows, sur Mac (interface utilisateur classique), sur le web, sur Android et sur iOS. Toutefois, notez les points suivants :

Dans Outlook sur Windows, sur Mac (interface utilisateur classique) et sur le web, vous pouvez avoir un maximum de 500 destinataires dans un champ cible. Si vous devez définir plus de 100 destinataires, vous pouvez appeler setAsync à plusieurs reprises, mais gardez à l’esprit la limite de destinataires du champ.
Dans Outlook sur Android et sur iOS, la setAsync méthode n’est pas prise en charge en mode De rédaction de messages. Seul le mode Organisateur de rendez-vous est pris en charge. Pour plus d’informations sur les API prises en charge dans Outlook Mobile, consultez API JavaScript Outlook prises en charge dans Outlook sur les appareils mobiles.

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

Erreurs :

NumberOfRecipientsExceeded: le nombre de destinataires a dépassé 100 entrées.

setAsync(recipients, callback)

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

recipients: Array<string | Office.EmailUser | Office.EmailAddressDetails>

Destinataires à ajouter à la liste des destinataires. Le tableau de destinataires peut contenir des chaînes d’adresses e-mail SMTP, d’objets EmailUser ou d’objets EmailAddressDetails .

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

Retours

void

Remarques

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

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

Mode Outlook applicable : Composer

Dans Outlook sur Windows, sur Mac (interface utilisateur classique) et sur le web, vous pouvez avoir un maximum de 500 destinataires dans un champ cible. Si vous devez définir plus de 100 destinataires, vous pouvez appeler setAsync à plusieurs reprises, mais gardez à l’esprit la limite de destinataires du champ.
Dans Outlook sur Android et sur iOS, la setAsync méthode n’est pas prise en charge en mode De rédaction de messages. Seul le mode Organisateur de rendez-vous est pris en charge. Pour plus d’informations sur les API prises en charge dans Outlook Mobile, consultez API JavaScript Outlook prises en charge dans Outlook sur les appareils mobiles.

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

Erreurs :

NumberOfRecipientsExceeded: le nombre de destinataires a dépassé 100 entrées.

Exemples

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

Office.context.mailbox.item.cc.setAsync(newRecipients, function(result) {
    if (result.error) {
        console.log(result.error);
    } else {
        console.log("Recipients overwritten");
    }
});

// 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 = $("#emailBcc")
  .val()
  .toString();
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 = $("#emailCc")
  .val()
  .toString();
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 = $("#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);
  }
});

...

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

...

const email = $("#emailTo")
  .val()
  .toString();
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);
  }
});

Office.Recipients interface

Remarques

Méthodes

Détails de la méthode

addAsync(recipients, options, callback)

Paramètres

Retours

Remarques

Exemples

addAsync(recipients, callback)

Paramètres

Retours

Remarques

getAsync(options, callback)

Paramètres

Retours

Remarques

getAsync(callback)

Paramètres

Retours

Remarques

Exemples

setAsync(recipients, options, callback)

Paramètres

Retours

Remarques

setAsync(recipients, callback)

Paramètres

Retours

Remarques

Exemples

Commentaires

Ressources supplémentaires