Office.Recipients interface

Agrega una lista de destinatarios a los destinatarios existentes de un mensaje o una cita.

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

Parámetros

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

Destinatarios que se deben agregar a la lista de destinatarios. La matriz de destinatarios puede contener cadenas de direcciones de correo electrónico SMTP, objetos EmailUser o objetos EmailAddressDetails .

options: Office.AsyncContextOptions

Literal de objeto que contiene una o varias de las siguientes propiedades:- asyncContext: los desarrolladores pueden proporcionar cualquier objeto al que quieran acceder en la función de devolución de llamada.

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

Opcional. Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro de tipo Office.AsyncResult. Si se produce un error al agregar el destinatario, la propiedad asyncResult.error contendrá un código de error.

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.1 ]

Nivel mínimo de permiso: elemento de lectura y escritura

Modo de Outlook aplicable: Compose

Importante:

Con el addAsync método , puede agregar un máximo de 100 destinatarios a un elemento de correo en Outlook en la Web, en Windows (nuevo y clásico), en Mac (interfaz de usuario clásica), en Android y en iOS. Sin embargo, tome nota de lo siguiente:

En Outlook en la Web, en Windows (nuevo y clásico) y en Mac (interfaz de usuario clásica), puede tener un máximo de 500 destinatarios en un campo de destino. Si necesita agregar más de 100 destinatarios a un elemento de correo, puede llamar a addAsync repetidamente, pero tener en cuenta el límite de destinatarios del campo.
En Outlook en Android y en iOS, el método no se admite en el addAsync modo message Compose. Solo se admite el modo Organizador de citas. Para obtener más información sobre las API admitidas en Outlook mobile, vea API de JavaScript de Outlook compatibles con Outlook en dispositivos móviles.

No hay ningún límite de destinatarios si llama a addAsync Outlook en Mac (nueva interfaz de usuario).

El addAsync método no se admite en un mensaje que se carga actualmente mediante el loadItemByIdAsync método . Para obtener más información, vea Activar el complemento de Outlook en varios mensajes.

Errores:

NumberOfRecipientsExceeded : el número de destinatarios superó las 100 entradas.

Ejemplos

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

Agrega una lista de destinatarios a los destinatarios existentes de un mensaje o una cita.

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

Parámetros

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

Destinatarios que se deben agregar a la lista de destinatarios. La matriz de destinatarios puede contener cadenas de direcciones de correo electrónico SMTP, objetos EmailUser o objetos EmailAddressDetails .

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

Opcional. Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro de tipo Office.AsyncResult. Si se produce un error al agregar el destinatario, la propiedad asyncResult.error contendrá un código de error.

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.1 ]

Nivel mínimo de permiso: elemento de lectura y escritura

Modo de Outlook aplicable: Compose

Importante:

Con el addAsync método , puede agregar un máximo de 100 destinatarios a un elemento de correo en Outlook en la Web, en Windows, en Mac (interfaz de usuario clásica), en Android y en iOS. Sin embargo, tome nota de lo siguiente:

En Outlook en la Web, en Windows y en Mac (interfaz de usuario clásica), puede tener un máximo de 500 destinatarios en un campo de destino. Si necesita agregar más de 100 destinatarios a un elemento de correo, puede llamar a addAsync repetidamente, pero tener en cuenta el límite de destinatarios del campo.
En Outlook en Android y en iOS, el método no se admite en el addAsync modo message Compose. Solo se admite el modo Organizador de citas. Para obtener más información sobre las API admitidas en Outlook mobile, vea API de JavaScript de Outlook compatibles con Outlook en dispositivos móviles.

No hay ningún límite de destinatarios si llama a addAsync Outlook en Mac (nueva interfaz de usuario).

El addAsync método no se admite en un mensaje que se carga actualmente mediante el loadItemByIdAsync método . Para obtener más información, vea Activar el complemento de Outlook en varios mensajes.

Errores:

NumberOfRecipientsExceeded : el número de destinatarios superó las 100 entradas.

Obtiene una lista de destinatarios para un mensaje o una cita.

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

Parámetros

options: Office.AsyncContextOptions

Literal de objeto que contiene una o varias de las siguientes propiedades:- asyncContext: los desarrolladores pueden proporcionar cualquier objeto al que quieran acceder en la función de devolución de llamada.

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

Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro,asyncResult , de tipo Office.AsyncResult. La asyncResult.value propiedad del resultado es una matriz de objetos EmailAddressDetails .

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.1 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose

Importante:

El número máximo de destinatarios devueltos por este método varía según el cliente de Outlook.

Windows (nuevo y clásico), explorador web, Mac (interfaz de usuario clásica): 500 destinatarios
Android, iOS: 100 destinatarios
Mac (nueva interfaz de usuario): sin límite

En Outlook clásico en Windows, el organizador de citas se incluye en el objeto devuelto por el getAsync método al crear una nueva cita o editar una existente. En Outlook en la Web y nueva Outlook en Windows, el organizador solo se incluye en el objeto devuelto al editar una cita existente.

El getAsync método solo devuelve destinatarios resueltos por el cliente de Outlook. Un destinatario resuelto tiene las siguientes características.

Si el destinatario tiene una entrada guardada en la libreta de direcciones del remitente, Outlook resuelve la dirección de correo electrónico en el nombre para mostrar guardado del destinatario.
Aparece un icono de estado de reunión de Teams antes del nombre o la dirección de correo electrónico del destinatario.
Aparece un punto y coma después del nombre o la dirección de correo electrónico del destinatario.
El nombre o la dirección de correo electrónico del destinatario están subrayados o incluidos en un cuadro.

Para resolver una dirección de correo electrónico una vez agregada a un elemento de correo, el remitente debe usar la tecla Tab o seleccionar una dirección de contacto o correo electrónico sugerida de la lista de autocompletar.

En Outlook en la Web y en Windows (nuevo y clásico), si un usuario crea un nuevo mensaje activando el vínculo de dirección de correo electrónico de un contacto desde su tarjeta de contacto o perfil, la llamada del Recipients.getAsync complemento devuelve la dirección de correo electrónico del contacto en la displayName propiedad del objeto EmailAddressDetails asociado en lugar del nombre guardado del contacto. Para obtener más información, consulte problema relacionado de GitHub.

Al redactar un elemento de correo, al cambiar a una cuenta de remitente que se encuentra en un dominio diferente al de la cuenta de remitente seleccionada anteriormente, el valor de la recipientType propiedad para los destinatarios existentes no se actualiza y seguirá basándose en el dominio de la cuenta seleccionada anteriormente. Para obtener los tipos de destinatario correctos después de cambiar de cuentas, primero debe quitar los destinatarios existentes y, a continuación, agregarlos de nuevo al elemento de correo.

Obtiene una lista de destinatarios para un mensaje o una cita.

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

Parámetros

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

Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro,asyncResult , de tipo Office.AsyncResult. La asyncResult.value propiedad del resultado es una matriz de objetos EmailAddressDetails .

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.1 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose

Importante:

El número máximo de destinatarios devueltos por este método varía según el cliente de Outlook.

Windows (nuevo y clásico), explorador web, Mac (interfaz de usuario clásica): 500 destinatarios
Android, iOS: 100 destinatarios
Mac (nueva interfaz de usuario): sin límite

El getAsync método solo devuelve destinatarios resueltos por el cliente de Outlook. Un destinatario resuelto tiene las siguientes características.

Si el destinatario tiene una entrada guardada en la libreta de direcciones del remitente, Outlook resuelve la dirección de correo electrónico en el nombre para mostrar guardado del destinatario.
Aparece un icono de estado de reunión de Teams antes del nombre o la dirección de correo electrónico del destinatario.
Aparece un punto y coma después del nombre o la dirección de correo electrónico del destinatario.
El nombre o la dirección de correo electrónico del destinatario están subrayados o incluidos en un cuadro.

Para resolver una dirección de correo electrónico una vez agregada a un elemento de correo, el remitente debe usar la tecla Tab o seleccionar una dirección de contacto o correo electrónico sugerida de la lista de autocompletar.

En Outlook en la Web y en Windows (nuevo y clásico), si un usuario crea un nuevo mensaje activando el vínculo de dirección de correo electrónico de un contacto desde su tarjeta de contacto o perfil, la llamada del Recipients.getAsync complemento devuelve la dirección de correo electrónico del contacto en la displayName propiedad del objeto EmailAddressDetails asociado en lugar del nombre guardado del contacto. Para obtener más información, consulte problema relacionado de GitHub.

Al redactar un elemento de correo, al cambiar a una cuenta de remitente que se encuentra en un dominio diferente al de la cuenta de remitente seleccionada anteriormente, el valor de la recipientType propiedad para los destinatarios existentes no se actualiza y seguirá basándose en el dominio de la cuenta seleccionada anteriormente. Para obtener los tipos de destinatario correctos después de cambiar de cuentas, primero debe quitar los destinatarios existentes y, a continuación, agregarlos de nuevo al elemento de correo.

Ejemplos

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

Establece una lista de destinatarios para una cita o un mensaje.

El método setAsync sobrescribe la lista de destinatarios actual.

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

Parámetros

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

Destinatarios que se deben agregar a la lista de destinatarios. La matriz de destinatarios puede contener cadenas de direcciones de correo electrónico SMTP, objetos EmailUser o objetos EmailAddressDetails .

options: Office.AsyncContextOptions

Literal de objeto que contiene una o varias de las siguientes propiedades:- asyncContext: los desarrolladores pueden proporcionar cualquier objeto al que quieran acceder en la función de devolución de llamada.

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

Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro de tipo Office.AsyncResult. Si no es posible establecer el destinatario, la propiedad asyncResult.error contendrá un código que indica el error que se produjo al agregar los datos.

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.1 ]

Nivel mínimo de permiso: elemento de lectura y escritura

Modo de Outlook aplicable: Compose

Importante:

Con el setAsync método , puede establecer un máximo de 100 destinatarios en Outlook en la Web, en Windows (nuevo y clásico), en Mac (interfaz de usuario clásica), en Android y en iOS. Sin embargo, tome nota de lo siguiente:

En Outlook en la Web, en Windows (nuevo y clásico) y en Mac (interfaz de usuario clásica), puede tener un máximo de 500 destinatarios en un campo de destino. Si necesita establecer más de 100 destinatarios, puede llamar repetidamente setAsync , pero tener en cuenta el límite de destinatarios del campo.
En Outlook en Android y en iOS, el setAsync método no se admite en el modo message Compose. Solo se admite el modo Organizador de citas. Para obtener más información sobre las API admitidas en Outlook mobile, vea API de JavaScript de Outlook compatibles con Outlook en dispositivos móviles.

No hay ningún límite de destinatarios si llama a setAsync Outlook en Mac (nueva interfaz de usuario).

El setAsync método no se admite en un mensaje que se carga actualmente mediante el loadItemByIdAsync método . Para obtener más información, vea Activar el complemento de Outlook en varios mensajes.

Errores:

NumberOfRecipientsExceeded : el número de destinatarios superó las 100 entradas.

Establece una lista de destinatarios para una cita o un mensaje.

El método setAsync sobrescribe la lista de destinatarios actual.

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

Parámetros

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

Destinatarios que se deben agregar a la lista de destinatarios. La matriz de destinatarios puede contener cadenas de direcciones de correo electrónico SMTP, objetos EmailUser o objetos EmailAddressDetails .

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

Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro de tipo Office.AsyncResult. Si no es posible establecer el destinatario, la propiedad asyncResult.error contendrá un código que indica el error que se produjo al agregar los datos.

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.1 ]

Nivel mínimo de permiso: elemento de lectura y escritura

Modo de Outlook aplicable: Compose

Importante:

Con el setAsync método , puede establecer un máximo de 100 destinatarios en Outlook en la Web, en Windows (nuevo y clásico), en Mac (interfaz de usuario clásica), en Android y en iOS. Sin embargo, tome nota de lo siguiente:

En Outlook en la Web, en Windows (nuevo y clásico) y en Mac (interfaz de usuario clásica), puede tener un máximo de 500 destinatarios en un campo de destino. Si necesita establecer más de 100 destinatarios, puede llamar repetidamente setAsync , pero tener en cuenta el límite de destinatarios del campo.
En Outlook en Android y en iOS, el setAsync método no se admite en el modo message Compose. Solo se admite el modo Organizador de citas. Para obtener más información sobre las API admitidas en Outlook mobile, vea API de JavaScript de Outlook compatibles con Outlook en dispositivos móviles.

No hay ningún límite de destinatarios si llama a setAsync Outlook en Mac (nueva interfaz de usuario).

El setAsync método no se admite en un mensaje que se carga actualmente mediante el loadItemByIdAsync método . Para obtener más información, vea Activar el complemento de Outlook en varios mensajes.

Errores:

NumberOfRecipientsExceeded : el número de destinatarios superó las 100 entradas.

Ejemplos

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

Compartir a través de

Comentarios

Métodos

Detalles del método

addAsync(recipients, options, callback)

Parámetros

Devoluciones

Comentarios

Ejemplos

addAsync(recipients, callback)

Parámetros

Devoluciones

Comentarios

getAsync(options, callback)

Parámetros

Devoluciones

Comentarios

getAsync(callback)

Parámetros

Devoluciones

Comentarios

Ejemplos

setAsync(recipients, options, callback)

Parámetros

Devoluciones

Comentarios

setAsync(recipients, callback)

Parámetros

Devoluciones

Comentarios

Ejemplos

Recursos adicionales