Office.MessageCompose interface

Paquete:

outlook

Modo de redacción de mensajes de Office.context.mailbox.item.

Importante: se trata de un objeto interno de Outlook, no expuesto directamente a través de interfaces existentes. Debe tratar esto como un modo de Office.context.mailbox.item. Para obtener más información, consulte la página Modelo de objetos.

Interfaces primarias:

• ItemCompose

• Message

Extends

Office.Message

Propiedades

bcc	Obtiene un objeto que proporciona métodos para obtener o actualizar los destinatarios en la línea CCO (copia de carbono ciego) de un mensaje. Dependiendo del cliente o la plataforma (es decir, Windows, Mac, etc.), se pueden aplicar límites en cuanto a cuántos destinatarios puede obtener o actualizar. Consulte el objeto Recipients para obtener más detalles.
body	Obtiene un objeto que proporciona métodos para manipular el cuerpo de un elemento.
categories	Obtiene un objeto que proporciona métodos para administrar las categorías del elemento. Importante: En Outlook en la Web, no puede usar la API para administrar categorías en un mensaje en el modo Redactar.
cc	Proporciona acceso a los destinatarios CC (en copia) de un mensaje. El tipo de objeto y el nivel de acceso dependen del modo del elemento actual. La propiedad cc devuelve un objeto Recipients que proporciona métodos para obtener o actualizar los destinatarios en la línea Cc del mensaje. Sin embargo, dependiendo del cliente o la plataforma (es decir, Windows, Mac, etc.), se pueden aplicar límites en cuanto a cuántos destinatarios puede obtener o actualizar. Consulte el objeto Recipients para obtener más detalles.
conversationId	Obtiene un identificador de la conversación de correo electrónico que contiene un mensaje determinado. Puede obtener un entero para esta propiedad si la aplicación de correo se activa en respuestas o formularios de lectura o en formularios de redacción. Si, después, el usuario cambia el asunto del mensaje de respuesta, al enviar dicha respuesta, el Id. de conversación de ese mensaje cambiará y el valor que se obtuvo anteriormente ya no será de aplicación. Obtiene un valor NULL para esta propiedad para un nuevo elemento de un formulario de redacción. Si el usuario establece un asunto y guarda el elemento, la propiedad conversationId devolverá un valor.
delayDeliveryTime	Obtiene o establece la fecha y hora de entrega retrasada de un mensaje. La delayDeliveryTime propiedad devuelve un DelayDeliveryTime objeto que proporciona métodos para administrar la fecha y hora de entrega del mensaje.
from	Obtiene la dirección de correo electrónico del remitente de un mensaje. La from propiedad devuelve un From objeto que proporciona un método para obtener el valor from.
inReplyTo	Obtiene el identificador de mensaje del mensaje original al que responde el mensaje actual.
internetHeaders	Obtiene o establece los encabezados de Internet personalizados de un mensaje. La internetHeaders propiedad devuelve un InternetHeaders objeto que proporciona métodos para administrar los encabezados de Internet en el mensaje. Para obtener más información, vea Obtener y establecer encabezados de Internet en un mensaje en un complemento de Outlook.
itemType	Obtiene el tipo de elemento que representa una instancia. La itemType propiedad devuelve uno de los ItemType valores de enumeración, que indica si la instancia del objeto item es un mensaje o una cita.
notificationMessages	Obtiene los mensajes de notificación de un elemento.
sensitivityLabel	Obtiene el objeto para obtener o establecer la etiqueta de confidencialidad de un mensaje.
seriesId	Obtiene el identificador de la serie a la que pertenece una instancia. En Outlook en la Web y en los clientes de escritorio, seriesId devuelve el identificador de Exchange Web Services (EWS) del elemento primario (serie) al que pertenece este elemento. Sin embargo, en iOS y Android, seriesId devuelve el identificador REST del elemento primario. Nota: El identificador devuelto por la seriesId propiedad es el mismo que el identificador de elemento de Exchange Web Services. La seriesId propiedad no es idéntica a los identificadores de Outlook usados por la API REST de Outlook. Antes de realizar llamadas a la API REST con este valor, debe convertirse mediante Office.context.mailbox.convertToRestId. Para obtener más información, consulte Uso de las API REST de Outlook desde un complemento de Outlook. La seriesId propiedad devuelve null para los elementos que no tienen elementos primarios, como citas únicas, elementos de serie o convocatorias de reunión, y devuelve undefined para cualquier otro elemento que no sea convocatorias de reunión.
sessionData	Administra los datos de sesión de un elemento en modo de redacción. Importante: Todo el objeto SessionData está limitado a 50 000 caracteres por complemento.
subject	Obtiene o establece la descripción que se muestra en el campo de asunto de un elemento. La propiedad subject obtiene o establece el asunto completo del elemento, como lo ha enviado el servidor de correo electrónico. La propiedad subject devuelve un objeto Subject que proporciona métodos para obtener y establecer el asunto.
to	Proporciona acceso a los destinatarios en la línea Para de un mensaje. El tipo de objeto y el nivel de acceso dependen del modo del elemento actual. La propiedad to devuelve un objeto Recipients que proporciona métodos para obtener o actualizar los destinatarios en la línea Para del mensaje. Sin embargo, dependiendo del cliente o la plataforma (es decir, Windows, Mac, etc.), se pueden aplicar límites en cuanto a cuántos destinatarios puede obtener o actualizar. Consulte el objeto Recipients para obtener más detalles.

Métodos

addFileAttachmentAsync(uri, attachmentName, options, callback)	Agrega un archivo a un mensaje o cita como datos adjuntos. El método addFileAttachmentAsync carga el archivo en el URI especificado y lo asocia al elemento en el formulario de redacción. Después, puede usar el identificador con el método removeAttachmentAsync para quitar los datos adjuntos en la misma sesión. Importante: En las compilaciones recientes de Outlook en Windows, se introdujo un error que anexa incorrectamente un Authorization: Bearer encabezado a esta acción (ya sea mediante esta API o la interfaz de usuario de Outlook). Para solucionar este problema, puede intentar usar la API introducida con el addFileAttachmentFromBase64 conjunto de requisitos 1.8.
addFileAttachmentAsync(uri, attachmentName, callback)	Agrega un archivo a un mensaje o cita como datos adjuntos. El método addFileAttachmentAsync carga el archivo en el URI especificado y lo asocia al elemento en el formulario de redacción. Después, puede usar el identificador con el método removeAttachmentAsync para quitar los datos adjuntos en la misma sesión. Importante: En las compilaciones recientes de Outlook en Windows, se introdujo un error que anexa incorrectamente un Authorization: Bearer encabezado a esta acción (ya sea mediante esta API o la interfaz de usuario de Outlook). Para solucionar este problema, puede intentar usar la API introducida con el addFileAttachmentFromBase64 conjunto de requisitos 1.8.
addFileAttachmentFromBase64Async(base64File, attachmentName, options, callback)	Agrega un archivo a un mensaje o cita como datos adjuntos. El addFileAttachmentFromBase64Async método carga el archivo desde la codificación Base64 y lo adjunta al elemento del formulario de redacción. Este método devuelve el identificador de datos adjuntos en el asyncResult.value objeto . Después, puede usar el identificador con el método removeAttachmentAsync para quitar los datos adjuntos en la misma sesión.
addFileAttachmentFromBase64Async(base64File, attachmentName, callback)	Agrega un archivo a un mensaje o cita como datos adjuntos. El addFileAttachmentFromBase64Async método carga el archivo desde la codificación Base64 y lo adjunta al elemento del formulario de redacción. Este método devuelve el identificador de datos adjuntos en el asyncResult.value objeto . Después, puede usar el identificador con el método removeAttachmentAsync para quitar los datos adjuntos en la misma sesión.
addHandlerAsync(eventType, handler, options, callback)	Agrega un controlador de eventos para un evento admitido. Nota: Los eventos solo están disponibles con la implementación del panel de tareas. Para ver los eventos admitidos, consulte la sección Eventos del modelo de objetos item.
addHandlerAsync(eventType, handler, callback)	Agrega un controlador de eventos para un evento admitido. Nota: Los eventos solo están disponibles con la implementación del panel de tareas. Para ver los eventos admitidos, consulte la sección Eventos del modelo de objetos item.
addItemAttachmentAsync(itemId, attachmentName, options, callback)	Agrega un elemento de Exchange (por ejemplo, un mensaje) como datos adjuntos al mensaje o a la cita. El método addItemAttachmentAsync asocia el elemento con el identificador especificado de Exchange al elemento en el formulario de redacción. Si especifica una función de devolución de llamada, se llama al método con un parámetro, asyncResult, que contiene el identificador de datos adjuntos o un código que indica cualquier error que se haya producido al adjuntar el elemento. Puede usar el parámetro options para pasar información de estado a la función de devolución de llamada, si es necesario. Después, puede usar el identificador con el método removeAttachmentAsync para quitar los datos adjuntos en la misma sesión. Si el complemento de Office se ejecuta en Outlook en la Web, el método addItemAttachmentAsync puede adjuntar elementos a otros elementos distintos del que quiere editar. No obstante, esta acción no es compatible y no se recomienda.
addItemAttachmentAsync(itemId, attachmentName, callback)	Agrega un elemento de Exchange (por ejemplo, un mensaje) como datos adjuntos al mensaje o a la cita. El método addItemAttachmentAsync asocia el elemento con el identificador especificado de Exchange al elemento en el formulario de redacción. Si especifica una función de devolución de llamada, se llama al método con un parámetro, asyncResult, que contiene el identificador de datos adjuntos o un código que indica cualquier error que se haya producido al adjuntar el elemento. Puede usar el parámetro options para pasar información de estado a la función de devolución de llamada, si es necesario. Después, puede usar el identificador con el método removeAttachmentAsync para quitar los datos adjuntos en la misma sesión. Si el complemento de Office se ejecuta en Outlook en la Web, el método addItemAttachmentAsync puede adjuntar elementos a otros elementos distintos del que quiere editar. No obstante, esta acción no es compatible y no se recomienda.
close()	Cierra el elemento actual que se está redactando. El comportamiento del método close depende del estado actual del elemento que se está redactando. Si el elemento tiene cambios no guardados, el cliente solicita al usuario que guarde, descarte o cierre la acción. En el cliente de escritorio de Outlook, el close método no tiene ningún efecto en una respuesta en el panel de lectura.
closeAsync(options, callback)	Cierra el mensaje actual que se está redactando con la opción de descartar los cambios no guardados. El mensaje que se va a componer puede ser un nuevo mensaje, una respuesta o un borrador existente.
closeAsync(callback)	Cierra el nuevo mensaje actual que se va a componer. El comportamiento de un nuevo mensaje que se va a componer depende de si el mensaje contiene cambios no guardados. Si no se ha realizado ningún cambio, el mensaje se cierra sin un cuadro de diálogo guardar. Por otro lado, si el mensaje contiene cambios no guardados, aparece un cuadro de diálogo guardar que pide al usuario que guarde un borrador, descarte los cambios o cancele la operación.
disableClientSignatureAsync(options, callback)	Deshabilita la firma de cliente de Outlook. El comportamiento de este método depende del cliente en el que se ejecuta el complemento. En Outlook en la Web, la opción de firma para nuevos correos, respuestas y reenvíos está deshabilitada. El método también deshabilita una firma seleccionada. En Outlook en Windows y en Mac, la firma de las secciones Nuevos mensajes y Respuestas/reenvíos de la cuenta de envío se establece en (ninguno). En Outlook en Android y en iOS, se borra la firma guardada en el dispositivo móvil.
disableClientSignatureAsync(callback)	Deshabilita la firma de cliente de Outlook. El comportamiento de este método depende del cliente en el que se ejecuta el complemento. En Outlook en la Web, la opción de firma para nuevos correos, respuestas y reenvíos está deshabilitada. El método también deshabilita una firma seleccionada. En Outlook en Windows y en Mac, la firma de las secciones Nuevos mensajes y Respuestas/reenvíos de la cuenta de envío se establece en (ninguno). En Outlook en Android y en iOS, se borra la firma guardada en el dispositivo móvil.
getAttachmentContentAsync(attachmentId, options, callback)	Obtiene datos adjuntos de un mensaje o cita y lo devuelve como un AttachmentContent objeto. El getAttachmentContentAsync método obtiene los datos adjuntos con el identificador especificado del elemento. Como procedimiento recomendado, debe obtener el identificador de los datos adjuntos de una getAttachmentsAsync llamada y, después, en la misma sesión, usar ese identificador para recuperar los datos adjuntos. En Outlook en la Web y en dispositivos móviles, el identificador de datos adjuntos solo es válido dentro de la misma sesión. Una sesión termina cuando el usuario cierra la aplicación, o si el usuario comienza a redactar un formulario insertado, a continuación, extrae el formulario para continuar en una ventana independiente.
getAttachmentContentAsync(attachmentId, callback)	Obtiene datos adjuntos de un mensaje o cita y lo devuelve como un AttachmentContent objeto. El getAttachmentContentAsync método obtiene los datos adjuntos con el identificador especificado del elemento. Como procedimiento recomendado, debe obtener el identificador de los datos adjuntos de una getAttachmentsAsync llamada y, después, en la misma sesión, usar ese identificador para recuperar los datos adjuntos. En Outlook en la Web y en dispositivos móviles, el identificador de datos adjuntos solo es válido dentro de la misma sesión. Una sesión termina cuando el usuario cierra la aplicación, o si el usuario comienza a redactar un formulario insertado, a continuación, extrae el formulario para continuar en una ventana independiente.
getAttachmentsAsync(options, callback)	Obtiene los datos adjuntos del elemento como una matriz.
getAttachmentsAsync(callback)	Obtiene los datos adjuntos del elemento como una matriz.
getComposeTypeAsync(options, callback)	Especifica el tipo de redacción de mensajes y su tipo de coerción. El mensaje puede ser nuevo, una respuesta o un reenvío. El tipo de coerción puede ser HTML o texto sin formato.
getComposeTypeAsync(callback)	Especifica el tipo de redacción de mensajes y su tipo de coerción. El mensaje puede ser nuevo, una respuesta o un reenvío. El tipo de coerción puede ser HTML o texto sin formato.
getConversationIndexAsync(options, callback)	Obtiene la posición codificada en Base64 del mensaje actual en un subproceso de conversación.
getConversationIndexAsync(callback)	Obtiene la posición codificada en Base64 del mensaje actual en un subproceso de conversación.
getInitializationContextAsync(options, callback)	Obtiene los datos de inicialización pasados cuando un mensaje accionable activa el complemento.
getInitializationContextAsync(callback)	Obtiene los datos de inicialización pasados cuando un mensaje accionable activa el complemento.
getItemClassAsync(options, callback)	Obtiene la clase de elemento servicios web de Exchange del mensaje seleccionado.
getItemClassAsync(callback)	Obtiene la clase de elemento servicios web de Exchange del mensaje seleccionado.
getItemIdAsync(options, callback)	Obtiene de forma asincrónica el identificador de un elemento guardado. Cuando se invoca, este método devuelve el identificador de elemento a través de la función de devolución de llamada. Nota: Si el complemento llama a getItemIdAsync un elemento en modo de redacción (por ejemplo, para obtener un itemId elemento para usarlo con EWS o la API REST), tenga en cuenta que, cuando Outlook está en modo almacenado en caché, puede tardar algún tiempo antes de que el elemento se sincronice con el servidor. Hasta que el elemento se sincronice, itemId no se reconoce y su uso devuelve un error.
getItemIdAsync(callback)	Obtiene de forma asincrónica el identificador de un elemento guardado. Cuando se invoca, este método devuelve el identificador de elemento a través de la función de devolución de llamada. Nota: Si el complemento llama a getItemIdAsync un elemento en modo de redacción (por ejemplo, para obtener un itemId elemento para usarlo con EWS o la API REST), tenga en cuenta que, cuando Outlook está en modo almacenado en caché, puede tardar algún tiempo antes de que el elemento se sincronice con el servidor. Hasta que el elemento se sincronice, itemId no se reconoce y su uso devuelve un error.
getSelectedDataAsync(coercionType, options, callback)	Devuelve asincrónicamente datos seleccionados desde el asunto o el cuerpo de un mensaje. Si no hay ninguna selección pero el cursor está en el cuerpo o el asunto, el método devuelve una cadena vacía para los datos seleccionados. Si se selecciona un campo que no sea el cuerpo o el asunto, el método devuelve el error InvalidSelection. Para acceder a los datos seleccionados desde la función de devolución de llamada, llame a asyncResult.value.data. Para acceder a la propiedad de origen de la que procede la selección, llame a asyncResult.value.sourceProperty, que será obodysubject.
getSelectedDataAsync(coercionType, callback)	Devuelve asincrónicamente datos seleccionados desde el asunto o el cuerpo de un mensaje. Si no hay ninguna selección pero el cursor está en el cuerpo o el asunto, el método devuelve una cadena vacía para los datos seleccionados. Si se selecciona un campo que no sea el cuerpo o el asunto, el método devuelve el error InvalidSelection. Para acceder a los datos seleccionados desde la función de devolución de llamada, llame a asyncResult.value.data. Para acceder a la propiedad de origen de la que procede la selección, llame a asyncResult.value.sourceProperty, que será obodysubject.
getSharedPropertiesAsync(options, callback)	Obtiene las propiedades de una cita o mensaje en una carpeta compartida o un buzón compartido. Para obtener más información sobre el uso de esta API, vea Habilitar carpetas compartidas y escenarios de buzón compartido en un complemento de Outlook.
getSharedPropertiesAsync(callback)	Obtiene las propiedades de una cita o mensaje en una carpeta compartida o un buzón compartido. Para obtener más información sobre el uso de esta API, vea Habilitar carpetas compartidas y escenarios de buzón compartido en un complemento de Outlook.
isClientSignatureEnabledAsync(options, callback)	Obtiene si la firma de cliente está habilitada. Para los clientes enriquecidos de Windows y Mac, la llamada API debe devolverse true si la firma predeterminada para nuevos mensajes, respuestas o reenvíos está establecida en una plantilla para la cuenta de Outlook de envío. Para Outlook en la Web, la llamada API debe devolverse true si la firma está habilitada para los tiposnewMail de redacción , replyo forward. Si la configuración está establecida en "(none)" en mac o en clientes enriquecidos de Windows o deshabilitada en Outlook en la Web, la llamada API debe devolver false.
isClientSignatureEnabledAsync(callback)	Obtiene si la firma de cliente está habilitada. Para los clientes enriquecidos de Windows y Mac, la llamada API debe devolverse true si la firma predeterminada para nuevos mensajes, respuestas o reenvíos está establecida en una plantilla para la cuenta de Outlook de envío. Para Outlook en la Web, la llamada API debe devolverse true si la firma está habilitada para los tiposnewMail de redacción , replyo forward. Si la configuración está establecida en "(none)" en mac o en clientes enriquecidos de Windows o deshabilitada en Outlook en la Web, la llamada API debe devolver false.
loadCustomPropertiesAsync(callback, userContext)	Carga de forma asincrónica las propiedades personalizadas de este complemento en el elemento seleccionado. Las propiedades personalizadas se almacenan como pares clave-valor por aplicación y por elemento. Este método devuelve un objeto CustomProperties en la devolución de llamada, que proporciona métodos para acceder a las propiedades personalizadas específicas del elemento actual y del complemento actual. Las propiedades personalizadas no se cifran en el elemento, por lo que no se debe usar como almacenamiento seguro. Las propiedades personalizadas se proporcionan como un objeto CustomProperties en la propiedad asyncResult.value. Este objeto se puede usar para obtener, establecer, guardar y quitar propiedades personalizadas del elemento de correo.
removeAttachmentAsync(attachmentId, options, callback)	Quita los datos adjuntos de un mensaje o cita. El método removeAttachmentAsync quita del elemento los datos adjuntos con el identificador especificado. Como práctica recomendada, debe usar el identificador de datos adjuntos para quitar datos adjuntos solo si la misma aplicación de correo ha agregado los datos adjuntos en la misma sesión. En Outlook en la Web y en dispositivos móviles, el identificador de datos adjuntos solo es válido dentro de la misma sesión. Una sesión termina cuando el usuario cierra la aplicación, o si el usuario comienza a redactar un formulario insertado, a continuación, extrae el formulario para continuar en una ventana independiente.
removeAttachmentAsync(attachmentId, callback)	Quita los datos adjuntos de un mensaje o cita. El método removeAttachmentAsync quita del elemento los datos adjuntos con el identificador especificado. Como práctica recomendada, debe usar el identificador de datos adjuntos para quitar datos adjuntos solo si la misma aplicación de correo ha agregado los datos adjuntos en la misma sesión. En Outlook en la Web y en dispositivos móviles, el identificador de datos adjuntos solo es válido dentro de la misma sesión. Una sesión termina cuando el usuario cierra la aplicación, o si el usuario comienza a redactar un formulario insertado, a continuación, extrae el formulario para continuar en una ventana independiente.
removeHandlerAsync(eventType, options, callback)	Elimina el controlador de eventos de un tpo de evento admitido. Nota: Los eventos solo están disponibles con la implementación del panel de tareas. Para ver los eventos admitidos, consulte la sección Eventos del modelo de objetos item.
removeHandlerAsync(eventType, callback)	Elimina el controlador de eventos de un tpo de evento admitido. Nota: Los eventos solo están disponibles con la implementación del panel de tareas. Para ver los eventos admitidos, consulte la sección Eventos del modelo de objetos item.
saveAsync(options, callback)	Guarda de forma asincrónica el mensaje actual como borrador.
saveAsync(callback)	Guarda de forma asincrónica el mensaje actual como borrador.
setSelectedDataAsync(data, options, callback)	Inserta asincrónicamente datos en el cuerpo o el asunto de un mensaje. El setSelectedDataAsync método inserta la cadena especificada en la ubicación del cursor en el asunto o cuerpo del elemento, o bien, si el texto está seleccionado en el editor, reemplaza el texto seleccionado. Si el cursor no está en el cuerpo o el campo subject, se devuelve un error. Después de la inserción, el cursor se coloca al final del contenido insertado.
setSelectedDataAsync(data, callback)	Inserta asincrónicamente datos en el cuerpo o el asunto de un mensaje. El setSelectedDataAsync método inserta la cadena especificada en la ubicación del cursor en el asunto o cuerpo del elemento, o bien, si el texto está seleccionado en el editor, reemplaza el texto seleccionado. Si el cursor no está en el cuerpo o el campo subject, se devuelve un error. Después de la inserción, el cursor se coloca al final del contenido insertado.

Detalles de las propiedades

bcc

Obtiene un objeto que proporciona métodos para obtener o actualizar los destinatarios en la línea CCO (copia de carbono ciego) de un mensaje.

Dependiendo del cliente o la plataforma (es decir, Windows, Mac, etc.), se pueden aplicar límites en cuanto a cuántos destinatarios puede obtener o actualizar. Consulte el objeto Recipients para obtener más detalles.

bcc: Recipients;

Valor de propiedad

Office.Recipients

Comentarios

[ Conjunto de API: Buzón 1.1 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Redacción de mensajes

Ejemplos

Office.context.mailbox.item.bcc.setAsync( ['alice@contoso.com', 'bob@contoso.com'] );
Office.context.mailbox.item.bcc.addAsync( ['jason@contoso.com'] );
Office.context.mailbox.item.bcc.getAsync(callback);

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

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

...

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

body

Obtiene un objeto que proporciona métodos para manipular el cuerpo de un elemento.

body: Body;

Valor de propiedad

Office.Body

Comentarios

[ Conjunto de API: Buzón 1.1 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Redacción de mensajes

Ejemplos

// 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 the result parameter passed to the callback function.
{
    "value": "TEXT of whole body (including threads below)",
    "status": "succeeded",
    "asyncContext": "This is passed to the callback"
}

categories

Obtiene un objeto que proporciona métodos para administrar las categorías del elemento.

Importante: En Outlook en la Web, no puede usar la API para administrar categorías en un mensaje en el modo Redactar.

categories: Categories;

Valor de propiedad

Office.Categories

Comentarios

[ Conjunto de API: Buzón 1.8 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Redacción de mensajes

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/45-categories/work-with-categories.yaml

Office.context.mailbox.item.categories.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const categories = asyncResult.value;
    if (categories && categories.length > 0) {
      console.log("Categories assigned to this item:");
      console.log(JSON.stringify(categories));
    } else {
      console.log("There are no categories assigned to this item.");
    }
  } else {
    console.error(asyncResult.error);
  }
});

...

// Note: In order for you to successfully add a category,
// it must be in the mailbox categories master list.

Office.context.mailbox.masterCategories.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const masterCategories = asyncResult.value;
    if (masterCategories && masterCategories.length > 0) {
      // Grab the first category from the master list.
      const categoryToAdd = [masterCategories[0].displayName];
      Office.context.mailbox.item.categories.addAsync(categoryToAdd, function(asyncResult) {
        if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
          console.log(`Successfully assigned category '${categoryToAdd}' to item.`);
        } else {
          console.log("categories.addAsync call failed with error: " + asyncResult.error.message);
        }
      });
    } else {
      console.log("There are no categories in the master list on this mailbox. You can add categories using Office.context.mailbox.masterCategories.addAsync.");
    }
  } else {
    console.error(asyncResult.error);
  }
});

...

Office.context.mailbox.item.categories.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const categories = asyncResult.value;
    if (categories && categories.length > 0) {
      // Grab the first category assigned to this item.
      const categoryToRemove = [categories[0].displayName];
      Office.context.mailbox.item.categories.removeAsync(categoryToRemove, function(asyncResult) {
        if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
          console.log(`Successfully unassigned category '${categoryToRemove}' from this item.`);
        } else {
          console.log("categories.removeAsync call failed with error: " + asyncResult.error.message);
        }
      });
    } else {
      console.log("There are no categories assigned to this item.");
    }
  } else {
    console.error(asyncResult.error);
  }
});

cc

Proporciona acceso a los destinatarios CC (en copia) de un mensaje. El tipo de objeto y el nivel de acceso dependen del modo del elemento actual.

La propiedad cc devuelve un objeto Recipients que proporciona métodos para obtener o actualizar los destinatarios en la línea Cc del mensaje. Sin embargo, dependiendo del cliente o la plataforma (es decir, Windows, Mac, etc.), se pueden aplicar límites en cuanto a cuántos destinatarios puede obtener o actualizar. Consulte el objeto Recipients para obtener más detalles.

cc: Recipients;

Valor de propiedad

Office.Recipients

Comentarios

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Redacción de mensajes

Ejemplos

Office.context.mailbox.item.cc.setAsync( ['alice@contoso.com', 'bob@contoso.com'] );
Office.context.mailbox.item.cc.addAsync( ['jason@contoso.com'] );
Office.context.mailbox.item.cc.getAsync(callback);

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

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

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

...

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

conversationId

Obtiene un identificador de la conversación de correo electrónico que contiene un mensaje determinado.

Puede obtener un entero para esta propiedad si la aplicación de correo se activa en respuestas o formularios de lectura o en formularios de redacción. Si, después, el usuario cambia el asunto del mensaje de respuesta, al enviar dicha respuesta, el Id. de conversación de ese mensaje cambiará y el valor que se obtuvo anteriormente ya no será de aplicación.

Obtiene un valor NULL para esta propiedad para un nuevo elemento de un formulario de redacción. Si el usuario establece un asunto y guarda el elemento, la propiedad conversationId devolverá un valor.

conversationId: string;

Valor de propiedad

string

Comentarios

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Redacción de mensajes

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-conversation-id-message.yaml

console.log(`Conversation ID: ${Office.context.mailbox.item.conversationId}`);

delayDeliveryTime

Obtiene o establece la fecha y hora de entrega retrasada de un mensaje.

La delayDeliveryTime propiedad devuelve un DelayDeliveryTime objeto que proporciona métodos para administrar la fecha y hora de entrega del mensaje.

delayDeliveryTime: DelayDeliveryTime;

Valor de propiedad

Office.DelayDeliveryTime

Comentarios

[ Conjunto de API: Buzón 1.13 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Redacción de mensajes

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/delay-message-delivery.yaml

function setDeliveryDate(minutes) {
  // This snippet sets the delivery date and time of a message.
  const currentTime = new Date().getTime();
  const milliseconds = totalDelay * 60000;
  const timeDelay = new Date(currentTime + milliseconds);
  Office.context.mailbox.item.delayDeliveryTime.setAsync(timeDelay, (asyncResult) => {
    if (asyncResult.status === Office.AsyncResultStatus.Failed) {
      console.log(asyncResult.error.message);
      return;
    }

    if (minutes === 1440) {
      console.log(`Delayed delivery by an additional one day.`);
    } else {
      console.log(`Delayed delivery by an additional ${minutes} minutes.`);
    }
  });
}

from

Obtiene la dirección de correo electrónico del remitente de un mensaje.

La from propiedad devuelve un From objeto que proporciona un método para obtener el valor from.

from: From;

Valor de propiedad

Office.From

Comentarios

[ Conjunto de API: Buzón 1.7 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Redacción de mensajes

Importante: Esta propiedad se admite en Outlook en Android y en iOS. Para ver un escenario de ejemplo, vea Implementar la activación basada en eventos en complementos móviles de Outlook.

Ejemplos

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

Office.context.mailbox.item.from.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const msgFrom = asyncResult.value;
    console.log("Message from: " + msgFrom.displayName + " (" + msgFrom.emailAddress + ")");
  } else {
    console.error(asyncResult.error);
  }
});

inReplyTo

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Obtiene el identificador de mensaje del mensaje original al que responde el mensaje actual.

inReplyTo: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: versión preliminar del buzón ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Redacción de mensajes

Importante:

• Para obtener una vista previa de la inReplyTo propiedad, debe instalar Outlook en La versión 2402 de Windows (compilación 17317.20000) o posterior. A continuación, únase al programa Microsoft 365 Insider y seleccione la opción Canal beta para acceder a las compilaciones beta de Office.

• En Outlook en Windows, el inReplyTo valor se mantiene en todas las respuestas, independientemente de los cambios realizados por el usuario, como el cambio del asunto en una respuesta.

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/99-preview-apis/get-in-reply-to.yaml

// This snippet gets the ID of the message being replied to by the current message (PR_IN_REPLY_TO_ID).
// The API call is supported on messages being composed and isn't supported on read items.
const inReplyTo = Office.context.mailbox.item.inReplyTo;
if (inReplyTo) {
  console.log("ID of the message being replied to: " + inReplyTo);
} else {
  console.log("No InReplyTo property available for this message");
}

internetHeaders

Obtiene o establece los encabezados de Internet personalizados de un mensaje.

La internetHeaders propiedad devuelve un InternetHeaders objeto que proporciona métodos para administrar los encabezados de Internet en el mensaje.

Para obtener más información, vea Obtener y establecer encabezados de Internet en un mensaje en un complemento de Outlook.

internetHeaders: InternetHeaders;

Valor de propiedad

Office.InternetHeaders

Comentarios

[ Conjunto de API: Buzón 1.8 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Redacción de mensajes

Importante: La API de encabezados de Internet se admite en Outlook en Android y en iOS a partir de la versión 4.2405.0. Para obtener más información sobre las características admitidas en Outlook en dispositivos móviles, consulte API de JavaScript de Outlook compatibles con Outlook en dispositivos móviles.

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/70-mime-headers/manage-custom-internet-headers-message-compose.yaml

Office.context.mailbox.item.internetHeaders.getAsync(
  ["preferred-fruit", "preferred-vegetable", "best-vegetable", "nonexistent-header"],
  function (asyncResult) {
    if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
      console.log("Selected headers: " + JSON.stringify(asyncResult.value));
    } else {
      console.log("Error getting selected headers: " + JSON.stringify(asyncResult.error));
    }
  }
);

itemType

Obtiene el tipo de elemento que representa una instancia.

La itemType propiedad devuelve uno de los ItemType valores de enumeración, que indica si la instancia del objeto item es un mensaje o una cita.

itemType: MailboxEnums.ItemType | string;

Valor de propiedad

Office.MailboxEnums.ItemType | string

Comentarios

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Redacción de mensajes

Ejemplos

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

notificationMessages

Obtiene los mensajes de notificación de un elemento.

notificationMessages: NotificationMessages;

Valor de propiedad

Office.NotificationMessages

Comentarios

[ Conjunto de API: Buzón 1.3 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Redacción de mensajes

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/35-notifications/add-getall-remove.yaml

// Adds a progress indicator to the mail item.
const id = $("#notificationId").val().toString();
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.ProgressIndicator,
    message: "Progress indicator with id = " + id
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);

...

// Adds an informational notification to the mail item.
const id = $("#notificationId").val().toString();
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Non-persistent informational notification message with id = " + id,
    icon: "icon1",
    persistent: false
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);

...

// Adds a persistent information notification to the mail item.
const id = $("#notificationId").val().toString();
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Persistent informational notification message with id = " + id,
    icon: "icon1",
    persistent: true
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);

...

// Gets all the notification messages and their keys for the current mail item.
Office.context.mailbox.item.notificationMessages.getAllAsync((asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Failed) {
    console.log(asyncResult.error.message);
    return;
  }

  console.log(asyncResult.value);
});

...

// Replaces a notification message of a given key with another message.
const id = $("#notificationId").val().toString();
Office.context.mailbox.item.notificationMessages.replaceAsync(
  id,
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Notification message with id = " + id + " has been replaced with an informational message.",
    icon: "icon2",
    persistent: false
  },
  handleResult);

...

// Removes a notification message from the current mail item.
const id = $("#notificationId").val().toString();
Office.context.mailbox.item.notificationMessages.removeAsync(id, handleResult);

sensitivityLabel

Obtiene el objeto para obtener o establecer la etiqueta de confidencialidad de un mensaje.

sensitivityLabel: SensitivityLabel;

Valor de propiedad

Office.SensitivityLabel

Comentarios

[ Conjunto de API: Buzón 1.13 ]

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

Modo de Outlook aplicable: Redacción de mensajes

Importante: Para usar la característica de etiqueta de confidencialidad en el complemento, debe tener una suscripción Microsoft 365 E5.

Para obtener más información sobre cómo administrar etiquetas de confidencialidad en el complemento, consulte Administración de la etiqueta de confidencialidad del mensaje o la cita en modo de redacción.

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/60-sensitivity-label/sensitivity-label.yaml

// This snippet gets the current mail item's sensitivity label.
Office.context.sensitivityLabelsCatalog.getIsEnabledAsync((asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded && asyncResult.value == true) {
    Office.context.mailbox.item.sensitivityLabel.getAsync((asyncResult) => {
      if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
        console.log(asyncResult.value);
      } else {
        console.log("Action failed with error: " + asyncResult.error.message);
      }
    });
  } else {
    console.log("Action failed with error: " + asyncResult.error.message);
  }
});

seriesId

Obtiene el identificador de la serie a la que pertenece una instancia.

En Outlook en la Web y en los clientes de escritorio, seriesId devuelve el identificador de Exchange Web Services (EWS) del elemento primario (serie) al que pertenece este elemento. Sin embargo, en iOS y Android, seriesId devuelve el identificador REST del elemento primario.

Nota: El identificador devuelto por la seriesId propiedad es el mismo que el identificador de elemento de Exchange Web Services. La seriesId propiedad no es idéntica a los identificadores de Outlook usados por la API REST de Outlook. Antes de realizar llamadas a la API REST con este valor, debe convertirse mediante Office.context.mailbox.convertToRestId. Para obtener más información, consulte Uso de las API REST de Outlook desde un complemento de Outlook.

La seriesId propiedad devuelve null para los elementos que no tienen elementos primarios, como citas únicas, elementos de serie o convocatorias de reunión, y devuelve undefined para cualquier otro elemento que no sea convocatorias de reunión.

seriesId: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: Buzón 1.7 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Redacción de mensajes

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/50-recurrence/get-series-id.yaml

const seriesId = Office.context.mailbox.item.seriesId;

if (seriesId === undefined) {
  console.log("This is a message that's not a meeting request.");
} else if (seriesId === null) {
  console.log("This is a single appointment, a parent series, or a meeting request for a series or single meeting.");
} else {
  console.log("This is an instance belonging to series with ID " + seriesId);
}

sessionData

Administra los datos de sesión de un elemento en modo de redacción.

Importante: Todo el objeto SessionData está limitado a 50 000 caracteres por complemento.

sessionData: SessionData;

Valor de propiedad

Office.SessionData

Comentarios

[ Conjunto de API: Buzón 1.11 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Redacción de mensajes

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/session-data-apis.yaml

Office.context.mailbox.item.sessionData.getAllAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("The sessionData is " + JSON.stringify(asyncResult.value));
  } else {
    console.log("Failed to get all sessionData. Error: " + JSON.stringify(asyncResult.error));
  }
});

subject

Obtiene o establece la descripción que se muestra en el campo de asunto de un elemento.

La propiedad subject obtiene o establece el asunto completo del elemento, como lo ha enviado el servidor de correo electrónico.

La propiedad subject devuelve un objeto Subject que proporciona métodos para obtener y establecer el asunto.

subject: Subject;

Valor de propiedad

Office.Subject

Comentarios

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Redacción de mensajes

Ejemplos

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

to

Proporciona acceso a los destinatarios en la línea Para de un mensaje. El tipo de objeto y el nivel de acceso dependen del modo del elemento actual.

La propiedad to devuelve un objeto Recipients que proporciona métodos para obtener o actualizar los destinatarios en la línea Para del mensaje. Sin embargo, dependiendo del cliente o la plataforma (es decir, Windows, Mac, etc.), se pueden aplicar límites en cuanto a cuántos destinatarios puede obtener o actualizar. Consulte el objeto Recipients para obtener más detalles.

to: Recipients;

Valor de propiedad

Office.Recipients

Comentarios

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Redacción de mensajes

Ejemplos

Office.context.mailbox.item.to.setAsync( ['alice@contoso.com', 'bob@contoso.com'] );
Office.context.mailbox.item.to.addAsync( ['jason@contoso.com'] );
Office.context.mailbox.item.to.getAsync(callback);

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

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

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

...

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

Detalles del método

addFileAttachmentAsync(uri, attachmentName, options, callback)

Agrega un archivo a un mensaje o cita como datos adjuntos.

El método addFileAttachmentAsync carga el archivo en el URI especificado y lo asocia al elemento en el formulario de redacción.

Después, puede usar el identificador con el método removeAttachmentAsync para quitar los datos adjuntos en la misma sesión.

Importante: En las compilaciones recientes de Outlook en Windows, se introdujo un error que anexa incorrectamente un Authorization: Bearer encabezado a esta acción (ya sea mediante esta API o la interfaz de usuario de Outlook). Para solucionar este problema, puede intentar usar la API introducida con el addFileAttachmentFromBase64 conjunto de requisitos 1.8.

addFileAttachmentAsync(uri: string, attachmentName: string, options: Office.AsyncContextOptions & { isInline: boolean }, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;

Parámetros

uri

string

El URI que proporciona la ubicación del archivo que se va a adjuntar al mensaje o a la cita. La longitud máxima es de 2048 caracteres.

attachmentName

string

El nombre de los datos adjuntos que se muestra mientras estos se cargan. La longitud máxima es 255 caracteres.

options

Office.AsyncContextOptions & { isInline: boolean }

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. isInline: si es true, indica que los datos adjuntos se mostrarán alineados en el cuerpo del mensaje y no deben mostrarse en la lista de datos adjuntos.

callback

(asyncResult: Office.AsyncResult<string>) => 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 realiza correctamente, se proporcionará el identificador de los datos adjuntos en la propiedad asyncResult.value. Si se produce un error en la carga de los datos adjuntos, el objeto asyncResult contendrá un objeto Error que proporciona una descripción del 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: Redacción de mensajes

Errores:

• AttachmentSizeExceeded: los datos adjuntos son mayores de lo permitido.

• FileTypeNotSupported: los datos adjuntos tienen una extensión que no está permitida.

• NumberOfAttachmentsExceeded: el mensaje o la cita tiene demasiados datos adjuntos.

Ejemplos

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

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

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

// The following example adds an image file as an inline attachment and
// references the attachment in the message body.
Office.context.mailbox.item.addFileAttachmentAsync(
    "http://i.imgur.com/WJXklif.png",
    "cute_bird.png",
    {
        isInline: true
    },
    function (asyncResult) {
        Office.context.mailbox.item.body.setAsync(
            "<p>Here's a cute bird!</p><img src='cid:cute_bird.png'>",
            {
                "coercionType": "html"
            },
            function (asyncResult) {
                // Do something here.
            });
    });

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/40-attachments/attachments-compose.yaml

const attachmentUrl = $("#attachmentUrl").val();
Office.context.mailbox.item.addFileAttachmentAsync(
    attachmentUrl,
    getFileName(attachmentUrl),
    { "asyncContext" : { var1: 1, var2: true } },
    function(result) { console.log(result); });

addFileAttachmentAsync(uri, attachmentName, callback)

Agrega un archivo a un mensaje o cita como datos adjuntos.

El método addFileAttachmentAsync carga el archivo en el URI especificado y lo asocia al elemento en el formulario de redacción.

Después, puede usar el identificador con el método removeAttachmentAsync para quitar los datos adjuntos en la misma sesión.

Importante: En las compilaciones recientes de Outlook en Windows, se introdujo un error que anexa incorrectamente un Authorization: Bearer encabezado a esta acción (ya sea mediante esta API o la interfaz de usuario de Outlook). Para solucionar este problema, puede intentar usar la API introducida con el addFileAttachmentFromBase64 conjunto de requisitos 1.8.

addFileAttachmentAsync(uri: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;

Parámetros

uri

string

El URI que proporciona la ubicación del archivo que se va a adjuntar al mensaje o a la cita. La longitud máxima es de 2048 caracteres.

attachmentName

string

El nombre de los datos adjuntos que se muestra mientras estos se cargan. La longitud máxima es 255 caracteres.

callback

(asyncResult: Office.AsyncResult<string>) => 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 realiza correctamente, se proporcionará el identificador de los datos adjuntos en la propiedad asyncResult.value. Si se produce un error en la carga de los datos adjuntos, el objeto asyncResult contendrá un objeto Error que proporciona una descripción del 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: Redacción de mensajes

Errores:

• AttachmentSizeExceeded: los datos adjuntos son mayores de lo permitido.

• FileTypeNotSupported: los datos adjuntos tienen una extensión que no está permitida.

• NumberOfAttachmentsExceeded: el mensaje o la cita tiene demasiados datos adjuntos.

addFileAttachmentFromBase64Async(base64File, attachmentName, options, callback)

Agrega un archivo a un mensaje o cita como datos adjuntos.

El addFileAttachmentFromBase64Async método carga el archivo desde la codificación Base64 y lo adjunta al elemento del formulario de redacción. Este método devuelve el identificador de datos adjuntos en el asyncResult.value objeto .

Después, puede usar el identificador con el método removeAttachmentAsync para quitar los datos adjuntos en la misma sesión.

addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, options: Office.AsyncContextOptions & { isInline: boolean }, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;

Parámetros

base64File

string

Contenido codificado en Base64 de una imagen o archivo que se va a agregar a un correo electrónico o evento. La longitud máxima de la cadena codificada es de 27 892 122 caracteres (aproximadamente 25 MB).

attachmentName

string

El nombre de los datos adjuntos que se muestra mientras estos se cargan. La longitud máxima es 255 caracteres.

options

Office.AsyncContextOptions & { isInline: boolean }

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. isInline: si es true, indica que los datos adjuntos se mostrarán alineados en el cuerpo del mensaje y no se mostrarán en la lista de datos adjuntos.

callback

(asyncResult: Office.AsyncResult<string>) => 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 realiza correctamente, se proporcionará el identificador de los datos adjuntos en la propiedad asyncResult.value. Si se produce un error en la carga de los datos adjuntos, el objeto asyncResult contendrá un objeto Error que proporciona una descripción del error.

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.8 ]

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

Modo de Outlook aplicable: Redacción de mensajes

Importante:

• La adición de un archivo Base64 insertado a un mensaje en modo de redacción se admite en Outlook en Android y en iOS. 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.

• Si usa una API de dirección URL de datos (por ejemplo, readAsDataURL), debe quitar el prefijo de dirección URL de datos y, a continuación, enviar el resto de la cadena a esta API. Por ejemplo, si la cadena completa está representada por data:image/svg+xml;base64,<rest of Base64 string>, quite data:image/svg+xml;base64,.

• Si va a agregar una imagen Base64 insertada al cuerpo de un mensaje o cita que se va a componer, primero debe obtener el cuerpo del elemento actual mediante el método Office.context.mailbox.item.body.getAsync antes de insertar la imagen mediante addFileAttachmentFromBase64Async. De lo contrario, la imagen no se representará en el cuerpo una vez insertada. Para obtener más instrucciones, consulte Adjuntar un archivo.

Errores:

• AttachmentSizeExceeded: los datos adjuntos son mayores de lo permitido.

• FileTypeNotSupported: los datos adjuntos tienen una extensión que no está permitida.

• NumberOfAttachmentsExceeded: el mensaje o la cita tiene demasiados datos adjuntos.

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/40-attachments/attachments-compose.yaml

base64String = "iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAACXBIWXMAAAsSAAALEgHS3X78AAACRUlEQVRYw82XzXHbMBCFP2F8tzsQc8Ixyh0zoiuIXIGdCsxUYKqC0B04FdiuwMoM7mGOOIXqQGoAymXhgSX+itJM9kIRFLAP+3YXD5Pdbscx5oxaAIW8Ztr6l2PWmQwF4IyaieP53qdfAqQ8CwBn1JU4vpWhrbxXQA5MZfynANmcDIAzKgcy4FKGXsVJFf3nLgKyBQptfT4KQMRz2N0fcbxqmRMDWXflx0VPnrdArq0vekQ1Dv0UeHZGNebHhwjU8AzwKM43RyZnbAf58Q6ghudeWd0Aus0+5EcMIIRi3beua0D3Nm39BEAx3i7HTK4DEBJn5YxKOnaRA5+ErpMBWMpzDvx1RuXCcxOISlufAjfC7zgAsqsvUvMAD0ApPaEtGi9AIlUzKgJo60tt/SyKRkzLrAXERluf7W1gOICWaMyB386oooOWsIHvXbSoHuUSFovtHqicUVnH3EJoeT0aQEf5/XBGlc6otIOWBXAtPeZkAIJ9Bt6cUU9tZautX2nrk3MACHYr1ZKProKRtDw4o8pzAPjWo+NtpXTTvoteDDg8noDAcwbcRedAkGdFXyk2GEDcegVAFp2gyVDHjRQ4o6q2smoqtR5Hd+qMqtoALCWUUymr1m43QMZfOaMK4C0SrMsDANJ2E5FNcbdbjHC+ENl+H0myJFbLtaq4Rt8dyPBYRQV1E40nMv9rl7xrOw3DGb+Whcqu3i/OM6CUOWvgRlufNmnLYy4m77uJI7AXtdNcTDrU71LEyv7v01/N/ovL6bmu5/8A1tNWZldH0W4AAAAASUVORK5CYII=";
Office.context.mailbox.item.addFileAttachmentFromBase64Async(
    base64String,
    "logo.png",
    { isInline: false },
    function(result) { console.log(result); });

...

// Set the signature for the current item with inline image.
const modIcon1Base64 = "iVBORw0KGgoAAAANSUhEUgAAABwAAAAcCAYAAAByDd+UAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAA2ZpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuMC1jMDYxIDY0LjE0MDk0OSwgMjAxMC8xMi8wNy0xMDo1NzowMSAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wTU09Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9tbS8iIHhtbG5zOnN0UmVmPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvc1R5cGUvUmVzb3VyY2VSZWYjIiB4bWxuczp4bXA9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC8iIHhtcE1NOk9yaWdpbmFsRG9jdW1lbnRJRD0ieG1wLmRpZDpDRDMxMDg1MjBCNDZFMTExODE2MkM1RUI2M0M4MDYxRCIgeG1wTU06RG9jdW1lbnRJRD0ieG1wLmRpZDpFMTUxQjgyRjQ2MEQxMUUxODlFMkQwNTYzQ0YwMTUxMiIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDpFMTUxQjgyRTQ2MEQxMUUxODlFMkQwNTYzQ0YwMTUxMiIgeG1wOkNyZWF0b3JUb29sPSJBZG9iZSBQaG90b3Nob3AgQ1M1LjEgV2luZG93cyI+IDx4bXBNTTpEZXJpdmVkRnJvbSBzdFJlZjppbnN0YW5jZUlEPSJ4bXAuaWlkOkQxMzEwODUyMEI0NkUxMTE4MTYyQzVFQjYzQzgwNjFEIiBzdFJlZjpkb2N1bWVudElEPSJ4bXAuZGlkOkNEMzEwODUyMEI0NkUxMTE4MTYyQzVFQjYzQzgwNjFEIi8+IDwvcmRmOkRlc2NyaXB0aW9uPiA8L3JkZjpSREY+IDwveDp4bXBtZXRhPiA8P3hwYWNrZXQgZW5kPSJyIj8+uC/WfAAAAehJREFUeNpilCzfwEAEkAbiECA2A2J1IOaHin8E4ptAfBaIVwLxU0IGMRKw0B6IW4DYhoE4cASIK6E0VsCEQ1wUiNcB8QESLGOAqj0MxBuhZhBloS4QnwHiQAbygR/UDF1CFupCXSjHQDmQg5qli8tCUBBsQUoQ1AD8UDNFsVk4n0o+w+bT+egWglKjNymmeGhLkqLcG2oHAwtUoIuQDj5OVgZPLUmwRe5aEmAxqYqNpFgKssOcCeplM0KqdST5GfpDDRm0JfkYrj3/SE7QguyQY4ImYYLgCtAS10kHGMw6dzNsv/qC7OwCClJXYlR++v6b4er3j5QmIFcmaNlIL6AOslCIjhYKMTHQGTBBqxh6gXcgC6/R0cKbIAv30dHCfaAKGJTxHxJSqS3Fz9DkowNmywpyMcgA8fF7b8D8VWcfM6w8+4gYC+VB+RCk8hSh0gaUD4/dewvlvUWRe/z+GzGWgex4BGtiOAHxXhoHpzMoSGHZAhSPW2lo2VZYWkHOh4nEtLrIAE+hZmNUwK+B2BOIv1PRsu9QM1/jatNcBtVZ0IREKXgENesyoVYbzNIdFFi2A5tl+NqlL6BB4QBNzsSCU1A9nlAzMAALAQMOQl0qB23qWwKxIlIrDBQ394H4OBCvISYqAAIMACVibHDqsO7zAAAAAElFTkSuQmCC";
Office.context.mailbox.item.addFileAttachmentFromBase64Async(
  modIcon1Base64,
  "myImage.png",
  { isInline: true },
  function(result) {
    if (result.status == Office.AsyncResultStatus.Succeeded) {
      const signature = $("#signature").val() + "<img src='cid:myImage.png'>";
      console.log(`Setting signature to "${signature}".`);
      Office.context.mailbox.item.body.setSignatureAsync(
        signature,
        { coercionType: "html" },
        function(asyncResult) {
          console.log(`setSignatureAsync: ${asyncResult.status}`);
        }
      );
    } else {
      console.error(`addFileAttachmentFromBase64Async: ${result.error}`);
    }
  }
);

addFileAttachmentFromBase64Async(base64File, attachmentName, callback)

Agrega un archivo a un mensaje o cita como datos adjuntos.

El addFileAttachmentFromBase64Async método carga el archivo desde la codificación Base64 y lo adjunta al elemento del formulario de redacción. Este método devuelve el identificador de datos adjuntos en el asyncResult.value objeto .

Después, puede usar el identificador con el método removeAttachmentAsync para quitar los datos adjuntos en la misma sesión.

addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;

Parámetros

base64File

string

Contenido codificado en Base64 de una imagen o archivo que se va a agregar a un correo electrónico o evento. La longitud máxima de la cadena codificada es de 27 892 122 caracteres (aproximadamente 25 MB).

attachmentName

string

El nombre de los datos adjuntos que se muestra mientras estos se cargan. La longitud máxima es 255 caracteres.

callback

(asyncResult: Office.AsyncResult<string>) => 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 realiza correctamente, se proporcionará el identificador de los datos adjuntos en la propiedad asyncResult.value. Si se produce un error en la carga de los datos adjuntos, el objeto asyncResult contendrá un objeto Error que proporciona una descripción del error.

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.8 ]

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

Modo de Outlook aplicable: Redacción de mensajes

Importante:

• La adición de un archivo Base64 insertado a un mensaje en modo de redacción se admite en Outlook en Android y en iOS. 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.

• Si usa una API de dirección URL de datos (por ejemplo, readAsDataURL), debe quitar el prefijo de dirección URL de datos y, a continuación, enviar el resto de la cadena a esta API. Por ejemplo, si la cadena completa está representada por data:image/svg+xml;base64,<rest of Base64 string>, quite data:image/svg+xml;base64,.

• Si va a agregar una imagen Base64 insertada al cuerpo de un mensaje o cita que se va a componer, primero debe obtener el cuerpo del elemento actual mediante el método Office.context.mailbox.item.body.getAsync antes de insertar la imagen mediante addFileAttachmentFromBase64Async. De lo contrario, la imagen no se representará en el cuerpo una vez insertada. Para obtener más instrucciones, consulte Adjuntar un archivo.

Errores:

• AttachmentSizeExceeded: los datos adjuntos son mayores de lo permitido.

• FileTypeNotSupported: los datos adjuntos tienen una extensión que no está permitida.

• NumberOfAttachmentsExceeded: el mensaje o la cita tiene demasiados datos adjuntos.

addHandlerAsync(eventType, handler, options, callback)

Agrega un controlador de eventos para un evento admitido. Nota: Los eventos solo están disponibles con la implementación del panel de tareas.

Para ver los eventos admitidos, consulte la sección Eventos del modelo de objetos item.

addHandlerAsync(eventType: Office.EventType | string, handler: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parámetros

eventType

Office.EventType | string

El evento que debe invocar el controlador.

handler

any

La función que va a controlar el evento. La función debe aceptar un único parámetro, que es un literal de objeto. La type propiedad del parámetro coincidirá con el eventType parámetro pasado a addHandlerAsync.

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, asyncResult, que es un Office.AsyncResult objeto .

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.7 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Redacción de mensajes

Ejemplos

function myHandlerFunction(eventarg) {
    if (eventarg.attachmentStatus === Office.MailboxEnums.AttachmentStatus.Added) {
        const attachment = eventarg.attachmentDetails;
        console.log("Event Fired and Attachment Added!");
        getAttachmentContentAsync(attachment.id, options, callback);
    }
}

Office.context.mailbox.item.addHandlerAsync(Office.EventType.AttachmentsChanged, myHandlerFunction, myCallback);

addHandlerAsync(eventType, handler, callback)

Agrega un controlador de eventos para un evento admitido. Nota: Los eventos solo están disponibles con la implementación del panel de tareas.

Para ver los eventos admitidos, consulte la sección Eventos del modelo de objetos item.

addHandlerAsync(eventType: Office.EventType | string, handler: any, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parámetros

eventType

Office.EventType | string

El evento que debe invocar el controlador.

handler

any

La función que va a controlar el evento. La función debe aceptar un único parámetro, que es un literal de objeto. La type propiedad del parámetro coincidirá con el eventType parámetro pasado a addHandlerAsync.

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, asyncResult, que es un Office.AsyncResult objeto .

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.7 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Redacción de mensajes

addItemAttachmentAsync(itemId, attachmentName, options, callback)

Agrega un elemento de Exchange (por ejemplo, un mensaje) como datos adjuntos al mensaje o a la cita.

El método addItemAttachmentAsync asocia el elemento con el identificador especificado de Exchange al elemento en el formulario de redacción. Si especifica una función de devolución de llamada, se llama al método con un parámetro, asyncResult, que contiene el identificador de datos adjuntos o un código que indica cualquier error que se haya producido al adjuntar el elemento. Puede usar el parámetro options para pasar información de estado a la función de devolución de llamada, si es necesario.

Después, puede usar el identificador con el método removeAttachmentAsync para quitar los datos adjuntos en la misma sesión.

Si el complemento de Office se ejecuta en Outlook en la Web, el método addItemAttachmentAsync puede adjuntar elementos a otros elementos distintos del que quiere editar. No obstante, esta acción no es compatible y no se recomienda.

addItemAttachmentAsync(itemId: any, attachmentName: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;

Parámetros

itemId

any

El identificador de Exchange del elemento que debe adjuntarse. La longitud máxima es de 100 caracteres.

attachmentName

string

El nombre de los datos adjuntos que se muestra mientras estos se cargan. La longitud máxima es 255 caracteres.

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<string>) => 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 realiza correctamente, se proporcionará el identificador de los datos adjuntos en la propiedad asyncResult.value. Si se produce un error al agregar los datos adjuntos, el objeto asyncResult contendrá un objeto Error que proporciona una descripción del 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: Redacción de mensajes

Errores:

• NumberOfAttachmentsExceeded: el mensaje o la cita tiene demasiados datos adjuntos.

Ejemplos

// The following example adds an existing Outlook item as an attachment
// with the name `My Attachment`.
function callback(result) {
    if (result.error) {
        console.log(result.error);
    } else {
        console.log("Attachment added");
    }
}

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

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/40-attachments/attachments-compose.yaml

const attachmentItemId = $("#attachmentItemId").val();
Office.context.mailbox.item.addItemAttachmentAsync(
    attachmentItemId,
    "My attachment",
    { "asyncContext" : { var3: 3, var4: false } },
    function(result) { console.log(result); });

addItemAttachmentAsync(itemId, attachmentName, callback)

Agrega un elemento de Exchange (por ejemplo, un mensaje) como datos adjuntos al mensaje o a la cita.

El método addItemAttachmentAsync asocia el elemento con el identificador especificado de Exchange al elemento en el formulario de redacción. Si especifica una función de devolución de llamada, se llama al método con un parámetro, asyncResult, que contiene el identificador de datos adjuntos o un código que indica cualquier error que se haya producido al adjuntar el elemento. Puede usar el parámetro options para pasar información de estado a la función de devolución de llamada, si es necesario.

Después, puede usar el identificador con el método removeAttachmentAsync para quitar los datos adjuntos en la misma sesión.

Si el complemento de Office se ejecuta en Outlook en la Web, el método addItemAttachmentAsync puede adjuntar elementos a otros elementos distintos del que quiere editar. No obstante, esta acción no es compatible y no se recomienda.

addItemAttachmentAsync(itemId: any, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;

Parámetros

itemId

any

El identificador de Exchange del elemento que debe adjuntarse. La longitud máxima es de 100 caracteres.

attachmentName

string

El nombre de los datos adjuntos que se muestra mientras estos se cargan. La longitud máxima es 255 caracteres.

callback

(asyncResult: Office.AsyncResult<string>) => 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 realiza correctamente, se proporcionará el identificador de los datos adjuntos en la propiedad asyncResult.value. Si se produce un error al agregar los datos adjuntos, el objeto asyncResult contendrá un objeto Error que proporciona una descripción del 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: Redacción de mensajes

Errores:

• NumberOfAttachmentsExceeded: el mensaje o la cita tiene demasiados datos adjuntos.

close()

Cierra el elemento actual que se está redactando.

El comportamiento del método close depende del estado actual del elemento que se está redactando. Si el elemento tiene cambios no guardados, el cliente solicita al usuario que guarde, descarte o cierre la acción.

En el cliente de escritorio de Outlook, el close método no tiene ningún efecto en una respuesta en el panel de lectura.

close(): void;

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.3 ]

Nivel mínimo de permiso: restringido

Modo de Outlook aplicable: Redacción de mensajes

Importante: En Outlook en la Web, si el elemento es una cita y se ha guardado anteriormente mediante saveAsync, se le pedirá al usuario que guarde, descarte o cancele incluso si no se ha producido ningún cambio desde que se guardó por última vez el elemento.

Sugerencia: Usa el método closeAsync en lugar del close método si quieres que el complemento:

• Descarte automáticamente un mensaje que se va a componer sin preguntar al usuario con el cuadro de diálogo guardar.

• Determine cuándo un usuario cancela el cuadro de diálogo guardar elemento en un mensaje que se va a componer.

• Cierre una respuesta en el panel de lectura o un borrador existente desde un cliente de escritorio de Outlook.

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/25-item-save-and-close/close.yaml

Office.context.mailbox.item.close();

closeAsync(options, callback)

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Cierra el mensaje actual que se está redactando con la opción de descartar los cambios no guardados. El mensaje que se va a componer puede ser un nuevo mensaje, una respuesta o un borrador existente.

closeAsync(options: Office.AsyncContextOptions & { discardItem: boolean }, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parámetros

options

Office.AsyncContextOptions & { discardItem: boolean }

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. discardItem: si truees , el mensaje actual que se está redactando se cierra y se descartan los cambios no guardados. Cuando el parámetro no se declara o se establece falseen , aparece un cuadro de diálogo guardar que pide al usuario que guarde un borrador, descarte los cambios o cancele la operación. Este comportamiento se produce para los mensajes nuevos y las respuestas que aparecen en el panel de lectura. Si desea cerrar una respuesta en el panel de lectura o en un borrador existente, debe establecer en discardItemtrue. De lo contrario, la llamada devolverá un error. Para obtener más información sobre el error, vea la sección Comentarios.

callback

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

Opcional. Cuando se completa el método, se llama a la función pasada en el parámetro de devolución de llamada con un único parámetro, asyncResult, que es un Office.AsyncResult objeto .

Devoluciones

void

Comentarios

[ Conjunto de API: versión preliminar del buzón ]

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

Modo de Outlook aplicable: Redacción de mensajes

Importante: El closeAsync método está en versión preliminar. Solo se admite en Outlook en Windows en este momento.

Errores:

• The operation was cancelled by the user: el usuario selecciona Cancelar en el cuadro de diálogo guardar y la discardItem propiedad no está definida o está establecida en false.

• The operation is not supported: el closeAsync método intenta cerrar una respuesta en el panel de lectura o un borrador existente y la discardItem propiedad no está definida o está establecida falseen .

closeAsync(callback)

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Cierra el nuevo mensaje actual que se va a componer.

El comportamiento de un nuevo mensaje que se va a componer depende de si el mensaje contiene cambios no guardados. Si no se ha realizado ningún cambio, el mensaje se cierra sin un cuadro de diálogo guardar. Por otro lado, si el mensaje contiene cambios no guardados, aparece un cuadro de diálogo guardar que pide al usuario que guarde un borrador, descarte los cambios o cancele la operación.

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

Parámetros

callback

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

Opcional. Cuando se completa el método, se llama a la función pasada en el parámetro de devolución de llamada con un único parámetro, asyncResult, que es un Office.AsyncResult objeto .

Devoluciones

void

Comentarios

[ Conjunto de API: versión preliminar del buzón ]

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

Modo de Outlook aplicable: Redacción de mensajes

Importante: El closeAsync método está en versión preliminar. Solo se admite en Outlook en Windows en este momento.

Errores:

• The operation was cancelled by the user: el usuario selecciona Cancelar en el cuadro de diálogo guardar.

• The operation is not supported: el closeAsync método intenta cerrar una respuesta en el panel de lectura o un borrador existente.

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/99-preview-apis/close-async.yaml

// This snippet closes the current message being composed and discards any unsaved changes when the optional property, discardItem, is set to true.
// The API call works on a new message being composed, a reply, or an existing draft.
// When discardItem is set to false or isn't defined on a new message with unsaved changes, the user is prompted to save a draft, discard the changes, or cancel the close operation.
Office.context.mailbox.item.closeAsync(
  { discardItem: true },
  (asyncResult) => {
    if (asyncResult.status === Office.AsyncResultStatus.Failed) {
      console.log("Action failed with error: " + asyncResult.error.message);
      return;
    }
  });

disableClientSignatureAsync(options, callback)

Deshabilita la firma de cliente de Outlook.

El comportamiento de este método depende del cliente en el que se ejecuta el complemento.

• En Outlook en la Web, la opción de firma para nuevos correos, respuestas y reenvíos está deshabilitada. El método también deshabilita una firma seleccionada.

• En Outlook en Windows y en Mac, la firma de las secciones Nuevos mensajes y Respuestas/reenvíos de la cuenta de envío se establece en (ninguno).

• En Outlook en Android y en iOS, se borra la firma guardada en el dispositivo móvil.

disableClientSignatureAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => 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<void>) => void

Opcional. Cuando se completa el método, se llama a la función pasada en el parámetro de devolución de llamada con un único parámetro, asyncResult, que es un Office.AsyncResult objeto .

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.10 ]

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

Modo de Outlook aplicable: Redacción de mensajes

Importante: Este método se admite en Message Compose en Outlook en Android y en iOS a partir de la versión 4.2352.0. 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.

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/work-with-client-signatures.yaml

// Disable the client signature.
Office.context.mailbox.item.disableClientSignatureAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("disableClientSignatureAsync succeeded");
  } else {
    console.error(asyncResult.error);
  }
});

disableClientSignatureAsync(callback)

Deshabilita la firma de cliente de Outlook.

El comportamiento de este método depende del cliente en el que se ejecuta el complemento.

• En Outlook en la Web, la opción de firma para nuevos correos, respuestas y reenvíos está deshabilitada. El método también deshabilita una firma seleccionada.

• En Outlook en Windows y en Mac, la firma de las secciones Nuevos mensajes y Respuestas/reenvíos de la cuenta de envío se establece en (ninguno).

• En Outlook en Android y en iOS, se borra la firma guardada en el dispositivo móvil.

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

Parámetros

callback

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

Opcional. Cuando se completa el método, se llama a la función pasada en el parámetro de devolución de llamada con un único parámetro, asyncResult, que es un Office.AsyncResult objeto .

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.10 ]

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

Modo de Outlook aplicable: Redacción de mensajes

Importante: Este método se admite en Message Compose en Outlook en Android y en iOS a partir de la versión 4.2352.0. 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.

getAttachmentContentAsync(attachmentId, options, callback)

Obtiene datos adjuntos de un mensaje o cita y lo devuelve como un AttachmentContent objeto.

El getAttachmentContentAsync método obtiene los datos adjuntos con el identificador especificado del elemento. Como procedimiento recomendado, debe obtener el identificador de los datos adjuntos de una getAttachmentsAsync llamada y, después, en la misma sesión, usar ese identificador para recuperar los datos adjuntos. En Outlook en la Web y en dispositivos móviles, el identificador de datos adjuntos solo es válido dentro de la misma sesión. Una sesión termina cuando el usuario cierra la aplicación, o si el usuario comienza a redactar un formulario insertado, a continuación, extrae el formulario para continuar en una ventana independiente.

getAttachmentContentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void): void;

Parámetros

attachmentId

string

Identificador de los datos adjuntos que desea obtener.

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.AttachmentContent>) => 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, asyncResult, que es un Office.AsyncResult objeto . Si se produce un error en la llamada, la asyncResult.error propiedad contendrá un código de error con el motivo del error.

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.8 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Redacción de mensajes

Errores:

• AttachmentTypeNotSupported: no se admite el tipo de datos adjuntos. Entre los tipos no admitidos se incluyen imágenes incrustadas en formato de texto enriquecido o tipos de datos adjuntos de elementos que no sean elementos de correo electrónico o de calendario (como un contacto o elemento de tarea).

• InvalidAttachmentId: el identificador de datos adjuntos no existe.

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/40-attachments/get-attachment-content.yaml

// Gets the attachments of the current message or appointment in compose mode.
const options = { asyncContext: { currentItem: item } };
// The getAttachmentsAsync call can only be used in compose mode.
item.getAttachmentsAsync(options, callback);

function callback(result) {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.log(result.error.message);
    return;
  }

  if (result.value.length <= 0) {
    console.log("Mail item has no attachments.");
    return;
  }

  for (let i = 0; i < result.value.length; i++) {
    // Log the attachment type and its contents to the console.
    result.asyncContext.currentItem.getAttachmentContentAsync(result.value[i].id, handleAttachmentsCallback);
  }
}

getAttachmentContentAsync(attachmentId, callback)

Obtiene datos adjuntos de un mensaje o cita y lo devuelve como un AttachmentContent objeto.

El getAttachmentContentAsync método obtiene los datos adjuntos con el identificador especificado del elemento. Como procedimiento recomendado, debe obtener el identificador de los datos adjuntos de una getAttachmentsAsync llamada y, después, en la misma sesión, usar ese identificador para recuperar los datos adjuntos. En Outlook en la Web y en dispositivos móviles, el identificador de datos adjuntos solo es válido dentro de la misma sesión. Una sesión termina cuando el usuario cierra la aplicación, o si el usuario comienza a redactar un formulario insertado, a continuación, extrae el formulario para continuar en una ventana independiente.

getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void): void;

Parámetros

attachmentId

string

Identificador de los datos adjuntos que desea obtener.

callback

(asyncResult: Office.AsyncResult<Office.AttachmentContent>) => 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, asyncResult, que es un Office.AsyncResult objeto . Si se produce un error en la llamada, la asyncResult.error propiedad contendrá un código de error con el motivo del error.

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.8 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Redacción de mensajes

Errores:

• AttachmentTypeNotSupported: no se admite el tipo de datos adjuntos. Entre los tipos no admitidos se incluyen imágenes incrustadas en formato de texto enriquecido o tipos de datos adjuntos de elementos que no sean elementos de correo electrónico o de calendario (como un contacto o elemento de tarea).

• InvalidAttachmentId: el identificador de datos adjuntos no existe.

getAttachmentsAsync(options, callback)

Obtiene los datos adjuntos del elemento como una matriz.

getAttachmentsAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<AttachmentDetailsCompose[]>) => 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.AttachmentDetailsCompose[]>) => 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 en la llamada, la asyncResult.error propiedad contendrá un código de error con el motivo del error.

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.8 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Redacción de mensajes

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/40-attachments/attachments-compose.yaml

Office.context.mailbox.item.getAttachmentsAsync(function (result) {
    if (result.status !== Office.AsyncResultStatus.Succeeded) {
        console.error(result.error.message);
    } else {
        if (result.value.length > 0) {
            for (let i = 0; i < result.value.length; i++) {
                const attachment = result.value[i];
                console.log("ID: " + attachment.id + "\n" +
                    "Name: " + attachment.name + "\n" +
                    "Size: " + attachment.size + "\n" +
                    "isInline: " + attachment.isInline);
                switch (attachment.attachmentType) {
                    case Office.MailboxEnums.AttachmentType.Cloud:
                        console.log("Attachment type: Attachment is stored in a cloud location.");
                        break;
                    case Office.MailboxEnums.AttachmentType.File:
                        console.log("Attachment type: Attachment is a file.");
                        break;
                    case Office.MailboxEnums.AttachmentType.Item:
                        console.log("Attachment type: Attachment is an Exchange item.");
                        break;
                }
            }
        }
        else {
            console.log("No attachments on this message.");
        }
    }
});

getAttachmentsAsync(callback)

Obtiene los datos adjuntos del elemento como una matriz.

getAttachmentsAsync(callback?: (asyncResult: Office.AsyncResult<AttachmentDetailsCompose[]>) => void): void;

Parámetros

callback

(asyncResult: Office.AsyncResult<Office.AttachmentDetailsCompose[]>) => 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 en la llamada, la asyncResult.error propiedad contendrá un código de error con el motivo del error.

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.8 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Redacción de mensajes

getComposeTypeAsync(options, callback)

Especifica el tipo de redacción de mensajes y su tipo de coerción. El mensaje puede ser nuevo, una respuesta o un reenvío. El tipo de coerción puede ser HTML o texto sin formato.

getComposeTypeAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<any>) => 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<any>) => 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 se ejecuta correctamente, la asyncResult.value propiedad contiene un objeto con el tipo de redacción y el tipo de coerción del elemento.

Devoluciones

void

Objeto con ComposeType valores de enumeración y CoercionType para el elemento de mensaje.

Comentarios

[ Conjunto de API: Buzón 1.10 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Redacción de mensajes

Importante: Este método se admite en Outlook en Android y en iOS a partir de la versión 4.2352.0. 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.

getComposeTypeAsync(callback)

Especifica el tipo de redacción de mensajes y su tipo de coerción. El mensaje puede ser nuevo, una respuesta o un reenvío. El tipo de coerción puede ser HTML o texto sin formato.

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

Parámetros

callback

(asyncResult: Office.AsyncResult<any>) => 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 se ejecuta correctamente, la asyncResult.value propiedad contiene un objeto con el tipo de redacción y el tipo de coerción del elemento.

Devoluciones

void

Objeto con ComposeType valores de enumeración y CoercionType para el elemento de mensaje.

Comentarios

[ Conjunto de API: Buzón 1.10 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Redacción de mensajes

Importante: Este método se admite en Outlook en Android y en iOS a partir de la versión 4.2352.0. 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.

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/work-with-client-signatures.yaml

// Get the compose type of the current message.
Office.context.mailbox.item.getComposeTypeAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log(
      "getComposeTypeAsync succeeded with composeType: " +
        asyncResult.value.composeType +
        " and coercionType: " +
        asyncResult.value.coercionType
    );
  } else {
    console.error(asyncResult.error);
  }
});

getConversationIndexAsync(options, callback)

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Obtiene la posición codificada en Base64 del mensaje actual en un subproceso de conversación.

getConversationIndexAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => 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<string>) => 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, que es un Office.AsyncResult objeto . La posición codificada en Base64 del mensaje actual en una conversación se devuelve en la asyncResult.value propiedad .

Devoluciones

void

Comentarios

[ Conjunto de API: versión preliminar del buzón ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Redacción de mensajes

Importante: Para obtener una vista previa del getConversationIndexAsync método, debe instalar Outlook en La versión 2402 de Windows (compilación 17317.20000) o posterior. A continuación, únase al programa Microsoft 365 Insider y seleccione la opción Canal beta para acceder a las compilaciones beta de Office.

Sugerencia: Puede usar el índice de conversación para buscar un mensaje en un subproceso de conversación. A continuación, use su contenido para proporcionar contexto para el mensaje actual que se está redactando.

getConversationIndexAsync(callback)

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Obtiene la posición codificada en Base64 del mensaje actual en un subproceso de conversación.

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

Parámetros

callback

(asyncResult: Office.AsyncResult<string>) => 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, que es un Office.AsyncResult objeto . La posición codificada en Base64 del mensaje actual en una conversación se devuelve en la asyncResult.value propiedad .

Devoluciones

void

Comentarios

[ Conjunto de API: versión preliminar del buzón ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Redacción de mensajes

Importante: Para obtener una vista previa del getConversationIndexAsync método, debe instalar Outlook en La versión 2402 de Windows (compilación 17317.20000) o posterior. A continuación, únase al programa Microsoft 365 Insider y seleccione la opción Canal beta para acceder a las compilaciones beta de Office.

Sugerencia: Puede usar el índice de conversación para buscar un mensaje en un subproceso de conversación. A continuación, use su contenido para proporcionar contexto para el mensaje actual que se está redactando.

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/99-preview-apis/get-conversation-index.yaml

// This snippet returns the Base64-encoded position of the current message in a conversation thread (PR_CONVERSATION_INDEX).
// The API call is supported on a message being composed and isn't supported on read items or appointments.
Office.context.mailbox.item.getConversationIndexAsync((result) => {
   if (result.status === Office.AsyncResultStatus.Failed) {
      console.log(result.error.message);
      return;
   }
   
   const conversationIndex = result.value;
   if (conversationIndex) {
      console.log("Position in the conversation thread: " + conversationIndex);
   } else {
      console.log("The current message doesn't belong to a conversation thread.");
   }
});

getInitializationContextAsync(options, callback)

Obtiene los datos de inicialización pasados cuando un mensaje accionable activa el complemento.

getInitializationContextAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => 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<string>) => 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 se realiza correctamente, los datos del contexto de inicialización se proporcionan como una cadena (o una cadena vacía si no hay ningún contexto de inicialización) en la asyncResult.value propiedad .

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.8 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Redacción de mensajes

Ejemplos

// Get the initialization context (if present).
Office.context.mailbox.item.getInitializationContextAsync((asyncResult) => {
    if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
        if (asyncResult.value.length > 0) {
            // The value is a string, parse to an object.
            const context = JSON.parse(asyncResult.value);
            // Do something with context.
        } else {
            // Empty context, treat as no context.
        }
    } else {
        // Handle the error.
    }
});

getInitializationContextAsync(callback)

Obtiene los datos de inicialización pasados cuando un mensaje accionable activa el complemento.

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

Parámetros

callback

(asyncResult: Office.AsyncResult<string>) => 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 se realiza correctamente, los datos del contexto de inicialización se proporcionan como una cadena (o una cadena vacía si no hay ningún contexto de inicialización) en la asyncResult.value propiedad .

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.8 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Redacción de mensajes

getItemClassAsync(options, callback)

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Obtiene la clase de elemento servicios web de Exchange del mensaje seleccionado.

getItemClassAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => 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<string>) => 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, que es un Office.AsyncResult objeto . La clase de mensaje se devuelve en la asyncResult.value propiedad .

Devoluciones

void

Comentarios

[ Conjunto de API: versión preliminar del buzón ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Redacción de mensajes

Importante:

Para obtener una vista previa del getItemClassAsync método, debe instalar Outlook en Windows Versión 2402 (compilación 17317.20000) o posterior. A continuación, únase al programa Microsoft 365 Insider y seleccione la opción Canal beta para acceder a las compilaciones beta de Office.

En la tabla siguiente se enumeran las clases de mensaje predeterminadas.

Clase Item	Descripción
IPM.Note	Nuevos mensajes y respuestas de mensajes
IPM.Schedule.Meeting.Request	Convocatorias de reunión
IPM.Schedule.Meeting.Canceled	Cancelaciones de reunión
IPM.Schedule.Meeting.Resp.Neg	Respuesta negativa a una convocatoria de reunión.
IPM.Schedule.Meeting.Resp.Pos	Respuesta afirmativa a una convocatoria de reunión.
IPM. Schedule.Meeting.Resp.Tent	Respuesta provisional a una convocatoria de reunión.

getItemClassAsync(callback)

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Obtiene la clase de elemento servicios web de Exchange del mensaje seleccionado.

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

Parámetros

callback

(asyncResult: Office.AsyncResult<string>) => 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, que es un Office.AsyncResult objeto . La clase de mensaje se devuelve en la asyncResult.value propiedad .

Devoluciones

void

Comentarios

[ Conjunto de API: versión preliminar del buzón ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Redacción de mensajes

Importante:

Para obtener una vista previa del getItemClassAsync método, debe instalar Outlook en Windows Versión 2402 (compilación 17317.20000) o posterior. A continuación, únase al programa Microsoft 365 Insider y seleccione la opción Canal beta para acceder a las compilaciones beta de Office.

En la tabla siguiente se enumeran las clases de mensaje predeterminadas.

Clase Item	Descripción
IPM.Note	Nuevos mensajes y respuestas de mensajes
IPM.Schedule.Meeting.Request	Convocatorias de reunión
IPM.Schedule.Meeting.Canceled	Cancelaciones de reunión
IPM.Schedule.Meeting.Resp.Neg	Respuesta negativa a una convocatoria de reunión.
IPM.Schedule.Meeting.Resp.Pos	Respuesta afirmativa a una convocatoria de reunión.
IPM. Schedule.Meeting.Resp.Tent	Respuesta provisional a una convocatoria de reunión.

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/99-preview-apis/get-item-class-async.yaml

// This snippet returns the Exchange Web Services item class property (PR_MESSAGE_CLASS) of the current mail item.
// The API call is only supported on a message being composed.
Office.context.mailbox.item.getItemClassAsync((asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Failed) {
    console.log("Action failed with error: " + asyncResult.error.message);
    return;
  }

  console.log("Item class of the current mail item: " + asyncResult.value);
});

getItemIdAsync(options, callback)

Obtiene de forma asincrónica el identificador de un elemento guardado.

Cuando se invoca, este método devuelve el identificador de elemento a través de la función de devolución de llamada.

Nota: Si el complemento llama a getItemIdAsync un elemento en modo de redacción (por ejemplo, para obtener un itemId elemento para usarlo con EWS o la API REST), tenga en cuenta que, cuando Outlook está en modo almacenado en caché, puede tardar algún tiempo antes de que el elemento se sincronice con el servidor. Hasta que el elemento se sincronice, itemId no se reconoce y su uso devuelve un error.

getItemIdAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => 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<string>) => 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.

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.8 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Redacción de mensajes

Errores:

• ItemNotSaved: el identificador no se puede recuperar hasta que se guarda el elemento.

getItemIdAsync(callback)

Obtiene de forma asincrónica el identificador de un elemento guardado.

Cuando se invoca, este método devuelve el identificador de elemento a través de la función de devolución de llamada.

Nota: Si el complemento llama a getItemIdAsync un elemento en modo de redacción (por ejemplo, para obtener un itemId elemento para usarlo con EWS o la API REST), tenga en cuenta que, cuando Outlook está en modo almacenado en caché, puede tardar algún tiempo antes de que el elemento se sincronice con el servidor. Hasta que el elemento se sincronice, itemId no se reconoce y su uso devuelve un error.

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

Parámetros

callback

(asyncResult: Office.AsyncResult<string>) => 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.

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.8 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Redacción de mensajes

Errores:

• ItemNotSaved: el identificador no se puede recuperar hasta que se guarda el elemento.

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/85-tokens-and-service-calls/item-id-compose.yaml

Office.context.mailbox.item.getItemIdAsync(function (result) {
    if (result.status !== Office.AsyncResultStatus.Succeeded) {
        console.error(`getItemIdAsync failed with message: ${result.error.message}`);
    } else {
        console.log(result.value);
    }
});

getSelectedDataAsync(coercionType, options, callback)

Devuelve asincrónicamente datos seleccionados desde el asunto o el cuerpo de un mensaje.

Si no hay ninguna selección pero el cursor está en el cuerpo o el asunto, el método devuelve una cadena vacía para los datos seleccionados. Si se selecciona un campo que no sea el cuerpo o el asunto, el método devuelve el error InvalidSelection.

Para acceder a los datos seleccionados desde la función de devolución de llamada, llame a asyncResult.value.data. Para acceder a la propiedad de origen de la que procede la selección, llame a asyncResult.value.sourceProperty, que será obodysubject.

getSelectedDataAsync(coercionType: Office.CoercionType | string, options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<any>) => void): void;

Parámetros

coercionType

Office.CoercionType | string

Solicita un formato para los datos. Si Textes , el método devuelve el texto sin formato como una cadena, quitando las etiquetas HTML presentes. Si Htmles , el método devuelve el texto seleccionado, ya sea texto sin formato o HTML.

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<any>) => 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.

Devoluciones

void

Los datos seleccionados como una cadena con formato determinado por coercionType.

Comentarios

[ Conjunto de API: Buzón 1.2 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Redacción de mensajes

Ejemplos

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

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

    console.log("Selected text in " + prop + ": " + text);
}

getSelectedDataAsync(coercionType, callback)

Devuelve asincrónicamente datos seleccionados desde el asunto o el cuerpo de un mensaje.

Si no hay ninguna selección pero el cursor está en el cuerpo o el asunto, el método devuelve una cadena vacía para los datos seleccionados. Si se selecciona un campo que no sea el cuerpo o el asunto, el método devuelve el error InvalidSelection.

Para acceder a los datos seleccionados desde la función de devolución de llamada, llame a asyncResult.value.data. Para acceder a la propiedad de origen de la que procede la selección, llame a asyncResult.value.sourceProperty, que será obodysubject.

getSelectedDataAsync(coercionType: Office.CoercionType | string, callback: (asyncResult: Office.AsyncResult<any>) => void): void;

Parámetros

coercionType

Office.CoercionType | string

Solicita un formato para los datos. Si Textes , el método devuelve el texto sin formato como una cadena, quitando las etiquetas HTML presentes. Si Htmles , el método devuelve el texto seleccionado, ya sea texto sin formato o HTML.

callback

(asyncResult: Office.AsyncResult<any>) => 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.

Devoluciones

void

Los datos seleccionados como una cadena con formato determinado por coercionType.

Comentarios

[ Conjunto de API: Buzón 1.2 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Redacción de mensajes

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/20-item-body/get-selected-data.yaml

Office.context.mailbox.item.getSelectedDataAsync(Office.CoercionType.Text, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const text = asyncResult.value.data;
    const prop = asyncResult.value.sourceProperty;
    console.log("Selected text in " + prop + ": " + text);
  } else {
    console.error(asyncResult.error);
  }
});

getSharedPropertiesAsync(options, callback)

Obtiene las propiedades de una cita o mensaje en una carpeta compartida o un buzón compartido.

Para obtener más información sobre el uso de esta API, vea Habilitar carpetas compartidas y escenarios de buzón compartido en un complemento de Outlook.

getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<SharedProperties>) => 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.SharedProperties>) => 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, que es un Office.AsyncResult objeto . La asyncResult.value propiedad proporciona las propiedades del elemento compartido.

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.8 para compatibilidad con carpetas compartidas, Buzón 1.13 para compatibilidad con buzones compartidos ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Redacción de mensajes

Nota: Este método no se admite en Outlook en iOS ni en Android.

Importante: En el modo redacción de mensajes, esta API no se admite en Outlook en la Web ni en Windows, a menos que se cumplan las condiciones siguientes.

a. Delegar acceso/Carpetas compartidas

1. El propietario del buzón inicia un mensaje. Puede ser un mensaje nuevo, una respuesta o un reenvío.

2. Guardan el mensaje y lo mueven de su propia carpeta Borradores a una carpeta compartida con el delegado.

3. El delegado abre el borrador de la carpeta compartida y, a continuación, continúa redactando.

b. Buzón compartido (solo se aplica a Outlook en Windows)

1. El usuario del buzón compartido inicia un mensaje. Puede ser un mensaje nuevo, una respuesta o un reenvío.

2. Guardan el mensaje y lo mueven de su propia carpeta Borradores a una carpeta del buzón compartido.

3. Otro usuario de buzón compartido abre el borrador del buzón compartido y, a continuación, continúa redactando.

El mensaje está ahora en un contexto compartido y los complementos que admiten estos escenarios compartidos pueden obtener las propiedades compartidas del elemento. Una vez enviado el mensaje, normalmente se encuentra en la carpeta Elementos enviados del remitente.

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/65-delegates-and-shared-folders/get-shared-properties.yaml

if (!Office.context.mailbox.item.getSharedPropertiesAsync) {
  console.error("Try this sample on a message from a shared folder.");
  return;
}

Office.context.mailbox.getCallbackTokenAsync({ isRest: true }, function(result) {
  if (result.status === Office.AsyncResultStatus.Succeeded && result.value !== "") {
    Office.context.mailbox.item.getSharedPropertiesAsync(
      {
        // Pass auth token along.
        asyncContext: result.value
      },
      function(result2) {
        let sharedProperties = result2.value;
        let delegatePermissions = sharedProperties.delegatePermissions;

        // Determine if user has the appropriate permission to do the operation.
        if ((delegatePermissions & Office.MailboxEnums.DelegatePermissions.Read) != 0) {
          const ewsId = Office.context.mailbox.item.itemId;
          const restId = Office.context.mailbox.convertToRestId(ewsId, Office.MailboxEnums.RestVersion.v2_0);
          let rest_url =
            sharedProperties.targetRestUrl + "/v2.0/users/" + sharedProperties.targetMailbox + "/messages/" + restId;

          $.ajax({
            url: rest_url,
            dataType: "json",
            headers: { Authorization: "Bearer " + result2.asyncContext }
          })
            .done(function(response) {
              console.log(response);
            })
            .fail(function(error) {
              console.error(error);
            });
        }
      }
    );
  }
});

getSharedPropertiesAsync(callback)

Obtiene las propiedades de una cita o mensaje en una carpeta compartida o un buzón compartido.

Para obtener más información sobre el uso de esta API, vea Habilitar carpetas compartidas y escenarios de buzón compartido en un complemento de Outlook.

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

Parámetros

callback

(asyncResult: Office.AsyncResult<Office.SharedProperties>) => 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, que es un Office.AsyncResult objeto . La asyncResult.value propiedad proporciona las propiedades del elemento compartido.

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.8 para compatibilidad con carpetas compartidas, Buzón 1.13 para compatibilidad con buzones compartidos ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Redacción de mensajes

Nota: Este método no se admite en Outlook en iOS ni en Android.

Importante: En el modo redacción de mensajes, esta API no se admite en Outlook en la Web ni en Windows, a menos que se cumplan las condiciones siguientes.

a. Delegar acceso/Carpetas compartidas

1. El propietario del buzón inicia un mensaje. Puede ser un mensaje nuevo, una respuesta o un reenvío.

2. Guardan el mensaje y lo mueven de su propia carpeta Borradores a una carpeta compartida con el delegado.

3. El delegado abre el borrador de la carpeta compartida y, a continuación, continúa redactando.

b. Buzón compartido (solo se aplica a Outlook en Windows)

1. El usuario del buzón compartido inicia un mensaje. Puede ser un mensaje nuevo, una respuesta o un reenvío.

2. Guardan el mensaje y lo mueven de su propia carpeta Borradores a una carpeta del buzón compartido.

3. Otro usuario de buzón compartido abre el borrador del buzón compartido y, a continuación, continúa redactando.

El mensaje está ahora en un contexto compartido y los complementos que admiten estos escenarios compartidos pueden obtener las propiedades compartidas del elemento. Una vez enviado el mensaje, normalmente se encuentra en la carpeta Elementos enviados del remitente.

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/65-delegates-and-shared-folders/get-shared-properties.yaml

if (!Office.context.mailbox.item.getSharedPropertiesAsync) {
  console.error("Try this sample on an item from a shared folder.");
  return;
}

Office.context.mailbox.item.getSharedPropertiesAsync(function(result) {
  console.log(result.value);
});

isClientSignatureEnabledAsync(options, callback)

Obtiene si la firma de cliente está habilitada.

Para los clientes enriquecidos de Windows y Mac, la llamada API debe devolverse true si la firma predeterminada para nuevos mensajes, respuestas o reenvíos está establecida en una plantilla para la cuenta de Outlook de envío. Para Outlook en la Web, la llamada API debe devolverse true si la firma está habilitada para los tiposnewMail de redacción , replyo forward. Si la configuración está establecida en "(none)" en mac o en clientes enriquecidos de Windows o deshabilitada en Outlook en la Web, la llamada API debe devolver false.

isClientSignatureEnabledAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<boolean>) => 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<boolean>) => 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.

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.10 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Redacción de mensajes

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/work-with-client-signatures.yaml

// Check if the client signature is currently enabled.
Office.context.mailbox.item.isClientSignatureEnabledAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("isClientSignatureEnabledAsync succeeded with result: " + asyncResult.value);
  } else {
    console.error(asyncResult.error);
  }
});

isClientSignatureEnabledAsync(callback)

Obtiene si la firma de cliente está habilitada.

Para los clientes enriquecidos de Windows y Mac, la llamada API debe devolverse true si la firma predeterminada para nuevos mensajes, respuestas o reenvíos está establecida en una plantilla para la cuenta de Outlook de envío. Para Outlook en la Web, la llamada API debe devolverse true si la firma está habilitada para los tiposnewMail de redacción , replyo forward. Si la configuración está establecida en "(none)" en mac o en clientes enriquecidos de Windows o deshabilitada en Outlook en la Web, la llamada API debe devolver false.

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

Parámetros

callback

(asyncResult: Office.AsyncResult<boolean>) => 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.

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.10 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Redacción de mensajes

loadCustomPropertiesAsync(callback, userContext)

Carga de forma asincrónica las propiedades personalizadas de este complemento en el elemento seleccionado.

Las propiedades personalizadas se almacenan como pares clave-valor por aplicación y por elemento. Este método devuelve un objeto CustomProperties en la devolución de llamada, que proporciona métodos para acceder a las propiedades personalizadas específicas del elemento actual y del complemento actual. Las propiedades personalizadas no se cifran en el elemento, por lo que no se debe usar como almacenamiento seguro.

Las propiedades personalizadas se proporcionan como un objeto CustomProperties en la propiedad asyncResult.value. Este objeto se puede usar para obtener, establecer, guardar y quitar propiedades personalizadas del elemento de correo.

loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult<CustomProperties>) => void, userContext?: any): void;

Parámetros

callback

(asyncResult: Office.AsyncResult<Office.CustomProperties>) => 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.

userContext

any

Opcional. Los desarrolladores pueden proporcionar cualquier objeto al que quieran obtener acceso en la función de devolución de llamada. A este objeto se puede acceder mediante la propiedad asyncResult.asyncContext en la función de devolución de llamada.

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.1 ]

Para obtener más información sobre las propiedades personalizadas, vea Obtener y establecer metadatos de complemento para un complemento de Outlook.

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Redacción de mensajes

Ejemplos

// The following example shows how to use the loadCustomPropertiesAsync method
// to asynchronously load custom properties that are specific to the current item.
// The example also shows how to use the saveAsync method to save these properties
// back to the server. After loading the custom properties, the example uses the
// get method to read the custom property myProp, the set method to write the
// custom property otherProp, and then finally calls the saveAsync method to save
// the custom properties.
Office.initialize = function () {
    // Checks for the DOM to load using the jQuery ready method.
    $(document).ready(function () {
        // After the DOM is loaded, add-in-specific code can run.
        const mailbox = Office.context.mailbox;
        mailbox.item.loadCustomPropertiesAsync(customPropsCallback);
    });
};

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

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

function saveCallback(asyncResult) {
}

// 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(function (result) {
  if (result.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Loaded following custom properties:");
    customProps = result.value;
    const dataKey = Object.keys(customProps)[0];
    const data = customProps[dataKey];
    for (let propertyName in data)
    {
      let propertyValue = data[propertyName];
      console.log(`${propertyName}: ${propertyValue}`);
    }              
  }
  else {
    console.error(`loadCustomPropertiesAsync failed with message ${result.error.message}`);
  }
});

removeAttachmentAsync(attachmentId, options, callback)

Quita los datos adjuntos de un mensaje o cita.

El método removeAttachmentAsync quita del elemento los datos adjuntos con el identificador especificado. Como práctica recomendada, debe usar el identificador de datos adjuntos para quitar datos adjuntos solo si la misma aplicación de correo ha agregado los datos adjuntos en la misma sesión. En Outlook en la Web y en dispositivos móviles, el identificador de datos adjuntos solo es válido dentro de la misma sesión. Una sesión termina cuando el usuario cierra la aplicación, o si el usuario comienza a redactar un formulario insertado, a continuación, extrae el formulario para continuar en una ventana independiente.

removeAttachmentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parámetros

attachmentId

string

El identificador de los datos adjuntos para quitar. La longitud máxima de la attachmentId cadena es de 200 caracteres en Outlook en la Web y en Windows.

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 en la eliminación de los datos adjuntos, la propiedad asyncResult.error contendrá un código de error con el motivo del 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: Redacción de mensajes

Errores:

• InvalidAttachmentId: el identificador de datos adjuntos no existe.

Ejemplos

// The following code removes an attachment with an identifier of '0'.
Office.context.mailbox.item.removeAttachmentAsync(
    '0',
    { asyncContext : null },
    function (asyncResult)
    {
        console.log(asyncResult.status);
    }
);

// 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(),
    { asyncContext : null },
    function(result)
    {
        if (result.status !== Office.AsyncResultStatus.Succeeded) {
            console.error(`${result.error.message}`);
        } else {
            console.log(`Attachment removed successfully.`);
        }
    }
);

removeAttachmentAsync(attachmentId, callback)

Quita los datos adjuntos de un mensaje o cita.

El método removeAttachmentAsync quita del elemento los datos adjuntos con el identificador especificado. Como práctica recomendada, debe usar el identificador de datos adjuntos para quitar datos adjuntos solo si la misma aplicación de correo ha agregado los datos adjuntos en la misma sesión. En Outlook en la Web y en dispositivos móviles, el identificador de datos adjuntos solo es válido dentro de la misma sesión. Una sesión termina cuando el usuario cierra la aplicación, o si el usuario comienza a redactar un formulario insertado, a continuación, extrae el formulario para continuar en una ventana independiente.

removeAttachmentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parámetros

attachmentId

string

El identificador de los datos adjuntos para quitar. La longitud máxima de la attachmentId cadena es de 200 caracteres en Outlook en la Web y en Windows.

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 en la eliminación de los datos adjuntos, la propiedad asyncResult.error contendrá un código de error con el motivo del 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: Redacción de mensajes

Errores:

• InvalidAttachmentId: el identificador de datos adjuntos no existe.

removeHandlerAsync(eventType, options, callback)

Elimina el controlador de eventos de un tpo de evento admitido. Nota: Los eventos solo están disponibles con la implementación del panel de tareas.

Para ver los eventos admitidos, consulte la sección Eventos del modelo de objetos item.

removeHandlerAsync(eventType: Office.EventType | string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parámetros

eventType

Office.EventType | string

El evento que debe revocar el controlador.

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, asyncResult, que es un Office.AsyncResult objeto .

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.7 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Redacción de mensajes

removeHandlerAsync(eventType, callback)

Elimina el controlador de eventos de un tpo de evento admitido. Nota: Los eventos solo están disponibles con la implementación del panel de tareas.

Para ver los eventos admitidos, consulte la sección Eventos del modelo de objetos item.

removeHandlerAsync(eventType: Office.EventType | string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parámetros

eventType

Office.EventType | string

El evento que debe revocar el controlador.

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, asyncResult, que es un Office.AsyncResult objeto .

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.7 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Redacción de mensajes

saveAsync(options, callback)

Guarda de forma asincrónica el mensaje actual como borrador.

saveAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => 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<string>) => 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, que es un Office.AsyncResult objeto . El identificador del mensaje se devuelve en la asyncResult.value propiedad .

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.3 ]

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

Modo de Outlook aplicable: Redacción de mensajes

Importante:

• En el modo en línea de Outlook o en Outlook en la web, el elemento se guarda en el servidor. En modo en caché de Outlook, se guarda el elemento en la caché local.

• Al trabajar con contenido con formato HTML, es importante tener en cuenta que el cliente de Outlook puede modificar el contenido. Esto significa que las llamadas posteriores a métodos como Body.getAsync, Body.setAsynce incluso saveAsync pueden no dar lugar al mismo contenido.

• Si el complemento llama a saveAsync un elemento en modo de redacción con el fin de obtener un identificador de elemento para usarlo con EWS o la API REST, tenga en cuenta que, cuando Outlook está en modo almacenado en caché, puede tardar algún tiempo antes de que el elemento se sincronice realmente con el servidor. Hasta que se sincronice el elemento, el uso del identificador de elemento devolverá un error.

• En Outlook en la Web, la cuenta de buzón en la que se guarda un borrador varía cuando saveAsync se llama a en un mensaje que se enviará desde una cuenta de buzón compartido. Si el remitente crea un nuevo mensaje desde su buzón personal y selecciona la cuenta de buzón compartido en el campo Desde , saveAsync guarda el borrador en la carpeta Borradores del buzón personal del usuario. Si el remitente abre la cuenta de buzón compartido en una pestaña del explorador independiente (a través de la opción Abrir otro buzón , por ejemplo) y crea un nuevo mensaje allí, saveAsync guarda el borrador en la carpeta Borradores del buzón compartido.

Errores:

• InvalidAttachmentId: el identificador de datos adjuntos no existe.

saveAsync(callback)

Guarda de forma asincrónica el mensaje actual como borrador.

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

Parámetros

callback

(asyncResult: Office.AsyncResult<string>) => 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, que es un Office.AsyncResult objeto . El identificador del mensaje se devuelve en la asyncResult.value propiedad .

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.3 ]

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

Modo de Outlook aplicable: Redacción de mensajes

Importante:

• En el modo en línea de Outlook o en Outlook en la web, el elemento se guarda en el servidor. En modo en caché de Outlook, se guarda el elemento en la caché local.

• Al trabajar con contenido con formato HTML, es importante tener en cuenta que el cliente de Outlook puede modificar el contenido. Esto significa que las llamadas posteriores a métodos como Body.getAsync, Body.setAsynce incluso saveAsync pueden no dar lugar al mismo contenido.

• Si el complemento llama a saveAsync un elemento en modo de redacción con el fin de obtener un identificador de elemento para usarlo con EWS o la API REST, tenga en cuenta que, cuando Outlook está en modo almacenado en caché, puede tardar algún tiempo antes de que el elemento se sincronice realmente con el servidor. Hasta que se sincronice el elemento, el uso del identificador de elemento devolverá un error.

• En Outlook en la Web, la cuenta de buzón en la que se guarda un borrador varía cuando saveAsync se llama a en un mensaje que se enviará desde una cuenta de buzón compartido. Si el remitente crea un nuevo mensaje desde su buzón personal y selecciona la cuenta de buzón compartido en el campo Desde , saveAsync guarda el borrador en la carpeta Borradores del buzón personal del usuario. Si el remitente abre la cuenta de buzón compartido en una pestaña del explorador independiente (a través de la opción Abrir otro buzón , por ejemplo) y crea un nuevo mensaje allí, saveAsync guarda el borrador en la carpeta Borradores del buzón compartido.

Errores:

• InvalidAttachmentId: el identificador de datos adjuntos no existe.

Ejemplos

Office.context.mailbox.item.saveAsync(
    function callback(result) {
        // Process the result.
    });

// The following is an example of the
// `result` parameter passed to the
// callback function. The `value`
// property contains the item ID of
// the item.
{
    "value": "AAMkADI5...AAA=",
    "status": "succeeded"
}

setSelectedDataAsync(data, options, callback)

Inserta asincrónicamente datos en el cuerpo o el asunto de un mensaje.

El setSelectedDataAsync método inserta la cadena especificada en la ubicación del cursor en el asunto o cuerpo del elemento, o bien, si el texto está seleccionado en el editor, reemplaza el texto seleccionado. Si el cursor no está en el cuerpo o el campo subject, se devuelve un error. Después de la inserción, el cursor se coloca al final del contenido insertado.

setSelectedDataAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parámetros

data

string

Datos que se van a insertar. Los datos no deben superar 1.000.000 de caracteres. Si se pasan más de 1.000.000 de caracteres, se produce una excepción ArgumentOutOfRange.

options

Office.AsyncContextOptions & Office.CoercionTypeOptions

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. coercionType: si es texto, el estilo actual se aplica en Outlook en la Web y en clientes de escritorio. Si el campo es un editor de HTML, se insertan solo los datos de texto, aunque los datos sean HTML. Si html y el campo admiten HTML (el asunto no), el estilo actual se aplica en Outlook en la Web y el estilo predeterminado se aplica en Outlook en clientes de escritorio. Si el campo es un campo de texto, se devuelve un error InvalidDataFormat. Si coercionType no está establecido, el resultado depende del campo: si el campo es HTML, se usa HTML; si el campo es texto, se usa texto sin formato.

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.

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.2 ]

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

Modo de Outlook aplicable: Redacción de mensajes

Errores:

• InvalidAttachmentId: el identificador de datos adjuntos no existe.

Ejemplos

Office.context.mailbox.item.setSelectedDataAsync("<b>Hello World!</b>", { coercionType : "html" });

Office.context.mailbox.item.setSelectedDataAsync("Hello World!");

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/set-selected-data.yaml

Office.context.mailbox.item.setSelectedDataAsync("Replaced", function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Selected text has been updated successfully.");
  } else {
    console.error(asyncResult.error);
  }
});

setSelectedDataAsync(data, callback)

Inserta asincrónicamente datos en el cuerpo o el asunto de un mensaje.

El setSelectedDataAsync método inserta la cadena especificada en la ubicación del cursor en el asunto o cuerpo del elemento, o bien, si el texto está seleccionado en el editor, reemplaza el texto seleccionado. Si el cursor no está en el cuerpo o el campo subject, se devuelve un error. Después de la inserción, el cursor se coloca al final del contenido insertado.

setSelectedDataAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parámetros

data

string

Datos que se van a insertar. Los datos no deben superar 1.000.000 de caracteres. Si se pasan más de 1.000.000 de caracteres, se produce una excepción ArgumentOutOfRange.

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.

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.2 ]

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

Modo de Outlook aplicable: Redacción de mensajes

Errores:

• InvalidAttachmentId: el identificador de datos adjuntos no existe.