Office.MessageRead interface

Paquete:

outlook

Modo de lectura 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.

• Al llamar a Office.context.mailbox.item en un mensaje, tenga en cuenta que el panel de lectura del cliente de Outlook debe estar activado. Para obtener instrucciones sobre cómo configurar el panel de lectura, consulte Uso y configuración del panel de lectura para obtener una vista previa de los mensajes.

Interfaces primarias:

• ItemRead

• Message

Extends

Office.Message

Comentarios

Ejemplos

// The following code builds an HTML string with details of all attachments on the current item.
 const item = Office.context.mailbox.item;
 let outputString = "";
 if (item.attachments.length > 0) {
     for (let i = 0 ; i < item.attachments.length ; i++) {
         const attachment = item.attachments[i];
         outputString += "<BR>" + i + ". Name: ";
         outputString += attachment.name;
         outputString += "<BR>ID: " + attachment.id;
         outputString += "<BR>contentType: " + attachment.contentType;
         outputString += "<BR>size: " + attachment.size;
         outputString += "<BR>attachmentType: " + attachment.attachmentType;
         outputString += "<BR>isInline: " + attachment.isInline;
     }
 }
 console.log(outputString);

Propiedades

attachments	Obtiene los datos adjuntos del elemento como una matriz.
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.
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 cc propiedad devuelve una matriz que contiene un objeto EmailAddressDetails para cada destinatario que aparece en la línea Cc del mensaje. El número máximo de destinatarios devueltos varía según el cliente de Outlook. Windows clásico: 500 destinatarios Android, interfaz de usuario clásica de Mac, iOS: 100 destinatarios Explorador web, nueva Outlook: 20 destinatarios (vista contraída), 500 destinatarios (vista expandida) Nueva interfaz de usuario de Mac: sin límite
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.
dateTimeCreated	Obtiene la fecha y hora de creación de un elemento.
dateTimeModified	Obtiene la fecha y hora en que se modificó por última vez un elemento.
display	Obtiene un objeto para establecer temporalmente el contenido mostrado en el cuerpo o asunto de un mensaje en modo de lectura.
end	Obtiene la fecha y hora de finalización de la cita. La end propiedad es un Date objeto expresado como un valor de fecha y hora de hora universal coordinada (UTC). Puede usar el convertToLocalClientTime método para convertir el valor de propiedad end en la fecha y hora locales del cliente. Si usa el método Time.setAsync para establecer la hora de finalización, use el método convertToUtcClientTime para convertir la hora local del cliente en un valor UTC para el servidor.
from	Obtiene la dirección de correo electrónico del remitente de un mensaje. Las propiedades from y sender representan a la misma persona, a menos que un delegado envíe el mensaje. En ese caso, la from propiedad representa al delegado y la sender propiedad representa al delegado. Nota: La recipientType propiedad del EmailAddressDetails objeto de la from propiedad no está definida. La from propiedad devuelve un EmailAddressDetails objeto .
internetMessageId	Obtiene el identificador de mensaje de Internet de un mensaje de correo electrónico. Importante: En la carpeta Elementos enviados , internetMessageId es posible que todavía no esté disponible en los elementos enviados recientemente. En ese caso, considere la posibilidad de usar servicios web de Exchange para obtener esta propiedad del servidor.
itemClass	Obtiene la clase de elemento servicios web de Exchange del mensaje seleccionado.
itemId	Obtiene el identificador de elemento de Exchange Web Services (EWS) del elemento actual.
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.
location	Obtiene la ubicación de una convocatoria de reunión. La propiedad location devuelve una cadena que contiene la ubicación de la cita.
normalizedSubject	Obtiene el asunto de un elemento, con todos los prefijos quitados (incluidos RE: y FWD:). La normalizedSubject propiedad obtiene el asunto del elemento, con los prefijos estándar (como RE: y FW:) que se agregan mediante los programas de correo electrónico. Para obtener el asunto del elemento con los prefijos intactos, use la propiedad subject.
notificationMessages	Obtiene los mensajes de notificación de un elemento.
recurrence	Obtiene el patrón de periodicidad de una cita. Obtiene el patrón de periodicidad de una convocatoria de reunión. Modos de lectura y redacción para elementos de cita. Modo de lectura para elementos de convocatoria de reunión. La recurrence propiedad devuelve un Recurrence objeto para citas periódicas o convocatorias de reuniones si un elemento es una serie o una instancia de una serie. null se devuelve para citas únicas y convocatorias de reunión de citas únicas. undefined se devuelve para los mensajes que no son convocatorias de reunión. Nota: Las solicitudes de reunión tienen un valor itemClass de IPM.Schedule.Meeting.Request. Nota: Si el recurrence objeto es null, esto indica que el objeto es una sola cita o una convocatoria de reunión de una sola cita y NO una parte de una serie.
sender	Obtiene la dirección de correo electrónico del remitente de un mensaje de correo electrónico. Las propiedades from y sender representan a la misma persona, a menos que un delegado envíe el mensaje. En ese caso, la from propiedad representa al delegado y la sender propiedad representa al delegado. Nota: La recipientType propiedad del EmailAddressDetails objeto de la sender propiedad no está definida.
seriesId	Obtiene el identificador de la serie a la que pertenece una instancia. En Outlook en la Web, en Windows (nuevo y clásico) y en Mac, seriesId devuelve el identificador de Exchange Web Services (EWS) del elemento primario (serie) al que pertenece este elemento. Sin embargo, en Outlook en Android y en iOS, 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 convocatoria de reunión.
start	Obtiene la fecha y hora en que se va a comenzar la cita. La start propiedad es un Date objeto expresado como un valor de fecha y hora de hora universal coordinada (UTC). Puede usar el convertToLocalClientTime método para convertir el valor en la fecha y hora locales del cliente.
subject	Obtiene la descripción que aparece en el campo 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 una cadena. Use la normalizedSubject propiedad para obtener el asunto menos los prefijos iniciales, como RE: y FW:.
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 to propiedad devuelve una matriz que contiene un objeto EmailAddressDetails para cada destinatario que aparece en la línea To del mensaje. El número máximo de destinatarios devueltos varía según el cliente de Outlook. Windows clásico: 500 destinatarios Android, interfaz de usuario clásica de Mac, iOS: 100 destinatarios Explorador web, nueva Outlook: 20 destinatarios (vista contraída), 500 destinatarios (vista expandida) Nueva interfaz de usuario de Mac: sin límite

Métodos

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.
displayReplyAllForm(formData)	Muestra un formulario de respuesta que incluye el remitente y todos los destinatarios del mensaje seleccionado o el organizador y todos los asistentes de la cita seleccionada.
displayReplyAllFormAsync(formData, options, callback)	Muestra un formulario de respuesta que incluye el remitente y todos los destinatarios del mensaje seleccionado o el organizador y todos los asistentes de la cita seleccionada.
displayReplyAllFormAsync(formData, callback)	Muestra un formulario de respuesta que incluye el remitente y todos los destinatarios del mensaje seleccionado o el organizador y todos los asistentes de la cita seleccionada.
displayReplyForm(formData)	Muestra un formulario de respuesta que incluye solo el remitente del mensaje seleccionado o el organizador de la cita seleccionada.
displayReplyFormAsync(formData, options, callback)	Muestra un formulario de respuesta que incluye solo el remitente del mensaje seleccionado o el organizador de la cita seleccionada.
displayReplyFormAsync(formData, callback)	Muestra un formulario de respuesta que incluye solo el remitente del mensaje seleccionado o el organizador de la cita seleccionada.
getAllInternetHeadersAsync(options, callback)	Obtiene todos los encabezados de Internet del mensaje como una cadena. Para obtener más información, vea Obtener y establecer encabezados de Internet en un mensaje en un complemento de Outlook.
getAllInternetHeadersAsync(callback)	Obtiene todos los encabezados de Internet del mensaje como una cadena. Para obtener más información, vea Obtener y establecer encabezados de Internet en un mensaje en un complemento de Outlook.
getAsFileAsync(options, callback)	Obtiene el mensaje actual en formato EML codificado en Base64.
getAsFileAsync(callback)	Obtiene el mensaje actual en formato EML codificado en Base64.
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 llamada item.attachments y, a continuación, en la misma sesión, usar ese identificador para recuperar los datos adjuntos. En Outlook en la Web, en dispositivos móviles y en la nueva Outlook en Windows, 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 llamada item.attachments y, a continuación, en la misma sesión, usar ese identificador para recuperar los datos adjuntos. En Outlook en la Web, en dispositivos móviles y en la nueva Outlook en Windows, 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.
getEntities()	Obtiene las entidades que obtenidas en el cuerpo del elemento seleccionado. Advertencia: Ahora se han retirado los complementos contextuales de Outlook basados en entidades. Sin embargo, se siguen admitiendo reglas de expresión regular. Se recomienda actualizar el complemento contextual para usar reglas de expresión regular como solución alternativa. Para obtener instrucciones sobre cómo implementar estas reglas, vea Complementos contextuales de Outlook.
getEntitiesByType(entityType)	Obtiene una matriz de todas las entidades del tipo de entidad especificado encontrado en el cuerpo del elemento seleccionado. Advertencia: Ahora se han retirado los complementos contextuales de Outlook basados en entidades. Sin embargo, se siguen admitiendo reglas de expresión regular. Se recomienda actualizar el complemento contextual para usar reglas de expresión regular como solución alternativa. Para obtener instrucciones sobre cómo implementar estas reglas, vea Complementos contextuales de Outlook.
getFilteredEntitiesByName(name)	Devuelve entidades conocidas en el elemento seleccionado que pasan el filtro con nombre definido en un archivo de manifiesto de solo complemento. Advertencia: Ahora se han retirado los complementos contextuales de Outlook basados en entidades. Sin embargo, se siguen admitiendo reglas de expresión regular. Se recomienda actualizar el complemento contextual para usar reglas de expresión regular como solución alternativa. Para obtener instrucciones sobre cómo implementar estas reglas, vea Complementos contextuales de Outlook.
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.
getRegExMatches()	Devuelve los valores de cadena del elemento seleccionado que coinciden con las expresiones regulares definidas en un archivo de manifiesto de solo complemento.
getRegExMatchesByName(name)	Devuelve los valores de cadena del elemento seleccionado que coinciden con la expresión regular con nombre definida en un archivo de manifiesto de solo complemento.
getSelectedEntities()	Obtiene las entidades que se han detectado en una coincidencia resaltada que un usuario ha seleccionado. Las coincidencias resaltadas se aplican a complementos contextuales. Advertencia: Ahora se han retirado los complementos contextuales de Outlook basados en entidades. Sin embargo, se siguen admitiendo reglas de expresión regular. Se recomienda actualizar el complemento contextual para usar reglas de expresión regular como solución alternativa. Para obtener instrucciones sobre cómo implementar estas reglas, vea Complementos contextuales de Outlook.
getSelectedRegExMatches()	Devuelve valores de cadena en una coincidencia resaltada que coinciden con las expresiones regulares definidas en un archivo de manifiesto de solo complemento. Las coincidencias resaltadas se aplican a complementos contextuales.
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 (ahora en versión preliminar). 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.
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.
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.

Detalles de las propiedades

attachments

Obtiene los datos adjuntos del elemento como una matriz.

attachments: AttachmentDetails[];

Valor de propiedad

Office.AttachmentDetails[]

Comentarios

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Lectura de mensajes

Nota: Outlook bloquea determinados tipos de archivos debido a posibles problemas de seguridad y, por lo tanto, no se devuelven. Para obtener más información, vea Archivos adjuntos bloqueados en Outlook.

Ejemplos

// The following code builds an HTML string with details of all attachments on the current item.
const item = Office.context.mailbox.item;
let outputString = "";

if (item.attachments.length > 0) {
    for (let i = 0 ; i < item.attachments.length ; i++) {
        const attachment = item.attachments[i];
        outputString += "<BR>" + i + ". Name: ";
        outputString += attachment.name;
        outputString += "<BR>ID: " + attachment.id;
        outputString += "<BR>contentType: " + attachment.contentType;
        outputString += "<BR>size: " + attachment.size;
        outputString += "<BR>attachmentType: " + attachment.attachmentType;
        outputString += "<BR>isInline: " + attachment.isInline;
    }
}

console.log(outputString);

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

const attachments = Office.context.mailbox.item.attachments;
console.log(attachments);

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: Lectura 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.

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: Lectura 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 cc propiedad devuelve una matriz que contiene un objeto EmailAddressDetails para cada destinatario que aparece en la línea Cc del mensaje. El número máximo de destinatarios devueltos varía según el cliente de Outlook.

• Windows clásico: 500 destinatarios

• Android, interfaz de usuario clásica de Mac, iOS: 100 destinatarios

• Explorador web, nueva Outlook: 20 destinatarios (vista contraída), 500 destinatarios (vista expandida)

• Nueva interfaz de usuario de Mac: sin límite

cc: EmailAddressDetails[];

Valor de propiedad

Office.EmailAddressDetails[]

Comentarios

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Lectura de mensajes

Ejemplos

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

const msgCc = Office.context.mailbox.item.cc;
console.log("Message copied to:");
for (let i = 0; i < msgCc.length; i++) {
  console.log(msgCc[i].displayName + " (" + msgCc[i].emailAddress + ")");
}

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

dateTimeCreated

Obtiene la fecha y hora de creación de un elemento.

dateTimeCreated: Date;

Valor de propiedad

Date

Comentarios

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Lectura de mensajes

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-date-time-created-read.yaml

console.log(`Creation date and time: ${Office.context.mailbox.item.dateTimeCreated}`);

dateTimeModified

Obtiene la fecha y hora en que se modificó por última vez un elemento.

dateTimeModified: Date;

Valor de propiedad

Date

Comentarios

[ Conjunto de API: Buzón 1.1 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Asistente de cita

Importante: Esta propiedad no se admite en Outlook en Android o 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.

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-date-time-modified-read.yaml

console.log(`Date and time item last modified: ${Office.context.mailbox.item.dateTimeModified}`);

display

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 un objeto para establecer temporalmente el contenido mostrado en el cuerpo o asunto de un mensaje en modo de lectura.

display: Display;

Valor de propiedad

Office.Display

Comentarios

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

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

Modo de Outlook aplicable: Lectura de mensajes

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/99-preview-apis/set-displayed-body-subject.yaml

// This snippet temporarily sets the content displayed in the body of a message in read mode.
// The set content will remain visible until the user switches to a different message in the Reading Pane or closes the window of the current message.
const bodyText = $("#body-text-field")
  .val()
  .toString();
Office.context.mailbox.item.display.body.setAsync(bodyText, (asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Failed) {
    console.log(`Action failed with error: ${asyncResult.error.message}`);
    return;
  }

  console.log("Temporarily set the content displayed in the body.");
});

end

Obtiene la fecha y hora de finalización de la cita.

La end propiedad es un Date objeto expresado como un valor de fecha y hora de hora universal coordinada (UTC). Puede usar el convertToLocalClientTime método para convertir el valor de propiedad end en la fecha y hora locales del cliente.

Si usa el método Time.setAsync para establecer la hora de finalización, use el método convertToUtcClientTime para convertir la hora local del cliente en un valor UTC para el servidor.

end: Date;

Valor de propiedad

Date

Comentarios

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Lectura de mensajes

Ejemplos

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

console.log(`Appointment ends: ${Office.context.mailbox.item.end}`);

from

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

Las propiedades from y sender representan a la misma persona, a menos que un delegado envíe el mensaje. En ese caso, la from propiedad representa al delegado y la sender propiedad representa al delegado.

Nota: La recipientType propiedad del EmailAddressDetails objeto de la from propiedad no está definida.

La from propiedad devuelve un EmailAddressDetails objeto .

from: EmailAddressDetails;

Valor de propiedad

Office.EmailAddressDetails

Comentarios

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Lectura de mensajes

Ejemplos

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

const msgFrom = Office.context.mailbox.item.from;
console.log("Message received from: " + msgFrom.displayName + " (" + msgFrom.emailAddress + ")");

internetMessageId

Obtiene el identificador de mensaje de Internet de un mensaje de correo electrónico.

Importante: En la carpeta Elementos enviados , internetMessageId es posible que todavía no esté disponible en los elementos enviados recientemente. En ese caso, considere la posibilidad de usar servicios web de Exchange para obtener esta propiedad del servidor.

internetMessageId: string;

Valor de propiedad

string

Comentarios

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Lectura de mensajes

Ejemplos

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

console.log(`Internet message ID: ${Office.context.mailbox.item.internetMessageId}`);

itemClass

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

itemClass: string;

Valor de propiedad

string

Comentarios

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Lectura de mensajes

Importante:

En la tabla siguiente se enumeran las clases de elementos predeterminadas para los mensajes.

Clase Item	Descripción
IPM.Note	Nuevos mensajes y respuestas de mensajes
IPM. Note.SMIME	Mensajes cifrados que también se pueden firmar
IPM. Note.SMIME.MultipartSigned	Mensajes con firma clara
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.

Puede crear clases personalizadas que amplíen una clase de elemento predeterminada. Por ejemplo, IPM.Note.Contoso.

Ejemplos

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

console.log(`Item class: ${Office.context.mailbox.item.itemClass}`);

itemId

Obtiene el identificador de elemento de Exchange Web Services (EWS) del elemento actual.

itemId: string;

Valor de propiedad

string

Comentarios

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Lectura de mensajes

Importante:

• La itemId propiedad no está disponible en modo de redacción. Si se requiere un identificador de elemento, el método Office.context.mailbox.item.saveAsync puede usarse para guardar el elemento en el servidor, que devolverá el identificador de elemento en el parámetro asyncResult.value de la función de devolución de llamada. Si el elemento ya está guardado, puede llamar al Office.context.mailbox.item.getItemIdAsync método en su lugar.

• El identificador de elemento devuelto no es idéntico al identificador de entrada de Outlook o al identificador que usa la API REST de Outlook. Antes de realizar llamadas a la API REST con este valor, debe convertirse mediante Office.context.mailbox.convertToRestId.

Ejemplos

// The following code checks for the presence of an item
// identifier. If the `itemId` property returns `null` or
// `undefined`, it saves the item to the store and gets the
// item identifier from the asynchronous result.
// **Important**: `saveAsync` was introduced with requirement set 1.3
// so you can't get the `itemId` in Compose mode in earlier sets.
let itemId = Office.context.mailbox.item.itemId;
if (itemId === null || itemId == undefined) {
    Office.context.mailbox.item.saveAsync(function(result) {
        itemId = result.value;
    });
}

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: Lectura 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;
}

location

Obtiene la ubicación de una convocatoria de reunión.

La propiedad location devuelve una cadena que contiene la ubicación de la cita.

location: string;

Valor de propiedad

string

Comentarios

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Lectura de mensajes

Ejemplos

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

console.log(`Appointment location: ${Office.context.mailbox.item.location}`);

normalizedSubject

Obtiene el asunto de un elemento, con todos los prefijos quitados (incluidos RE: y FWD:).

La normalizedSubject propiedad obtiene el asunto del elemento, con los prefijos estándar (como RE: y FW:) que se agregan mediante los programas de correo electrónico. Para obtener el asunto del elemento con los prefijos intactos, use la propiedad subject.

normalizedSubject: string;

Valor de propiedad

string

Comentarios

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Lectura de mensajes

Ejemplos

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

console.log(`Normalized subject: ${Office.context.mailbox.item.normalizedSubject}`);

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: Lectura 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);

recurrence

Obtiene el patrón de periodicidad de una cita. Obtiene el patrón de periodicidad de una convocatoria de reunión. Modos de lectura y redacción para elementos de cita. Modo de lectura para elementos de convocatoria de reunión.

La recurrence propiedad devuelve un Recurrence objeto para citas periódicas o convocatorias de reuniones si un elemento es una serie o una instancia de una serie. null se devuelve para citas únicas y convocatorias de reunión de citas únicas. undefined se devuelve para los mensajes que no son convocatorias de reunión.

Nota: Las solicitudes de reunión tienen un valor itemClass de IPM.Schedule.Meeting.Request.

Nota: Si el recurrence objeto es null, esto indica que el objeto es una sola cita o una convocatoria de reunión de una sola cita y NO una parte de una serie.

recurrence: Recurrence;

Valor de propiedad

Office.Recurrence

Comentarios

[ Conjunto de API: Buzón 1.7 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Lectura de mensajes

Ejemplos

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

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

if (recurrence === undefined) {
  console.log("This item is a message but not a meeting request.");
} else if (recurrence === null) {
  console.log("This is a single appointment.");
} else {
  console.log(JSON.stringify(recurrence));
}

sender

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

Las propiedades from y sender representan a la misma persona, a menos que un delegado envíe el mensaje. En ese caso, la from propiedad representa al delegado y la sender propiedad representa al delegado.

Nota: La recipientType propiedad del EmailAddressDetails objeto de la sender propiedad no está definida.

sender: EmailAddressDetails;

Valor de propiedad

Office.EmailAddressDetails

Comentarios

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Lectura de mensajes

Ejemplos

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

const msgSender = Office.context.mailbox.item.sender;
console.log("Sender: " + msgSender.displayName + " (" + msgSender.emailAddress + ")");

seriesId

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

En Outlook en la Web, en Windows (nuevo y clásico) y en Mac, seriesId devuelve el identificador de Exchange Web Services (EWS) del elemento primario (serie) al que pertenece este elemento. Sin embargo, en Outlook en Android y en iOS, 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 convocatoria 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: Lectura 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);
}

start

Obtiene la fecha y hora en que se va a comenzar la cita.

La start propiedad es un Date objeto expresado como un valor de fecha y hora de hora universal coordinada (UTC). Puede usar el convertToLocalClientTime método para convertir el valor en la fecha y hora locales del cliente.

start: Date;

Valor de propiedad

Date

Comentarios

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Lectura de mensajes

Ejemplos

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

console.log(`Appointment starts: ${Office.context.mailbox.item.start}`);

subject

Obtiene la descripción que aparece en el campo 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 una cadena. Use la normalizedSubject propiedad para obtener el asunto menos los prefijos iniciales, como RE: y FW:.

subject: string;

Valor de propiedad

string

Comentarios

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Lectura de mensajes

Ejemplos

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

console.log(`Subject: ${Office.context.mailbox.item.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 to propiedad devuelve una matriz que contiene un objeto EmailAddressDetails para cada destinatario que aparece en la línea To del mensaje. El número máximo de destinatarios devueltos varía según el cliente de Outlook.

• Windows clásico: 500 destinatarios

• Android, interfaz de usuario clásica de Mac, iOS: 100 destinatarios

• Explorador web, nueva Outlook: 20 destinatarios (vista contraída), 500 destinatarios (vista expandida)

• Nueva interfaz de usuario de Mac: sin límite

to: EmailAddressDetails[];

Valor de propiedad

Office.EmailAddressDetails[]

Comentarios

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Lectura de mensajes

Ejemplos

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

const msgTo = Office.context.mailbox.item.to;
const distributionLists = [];
const externalRecipients = [];
const internalRecipients = [];
const otherRecipients = [];
for (let i = 0; i < msgTo.length; i++) {
    switch (msgTo[i].recipientType) {
    case Office.MailboxEnums.RecipientType.DistributionList:
        distributionLists.push(msgTo[i]);
        break;
    case Office.MailboxEnums.RecipientType.ExternalUser:
        externalRecipients.push(msgTo[i]);
        break;
    case Office.MailboxEnums.RecipientType.User:
        internalRecipients.push(msgTo[i]);
        break;
    case Office.MailboxEnums.RecipientType.Other:
        otherRecipients.push(msgTo[i]);
    }
}

if (distributionLists.length > 0) {
    console.log("Distribution Lists:");
    distributionLists.forEach((recipient) => console.log(`${recipient.displayName}, ${recipient.emailAddress}`));
}

if (externalRecipients.length > 0) {
    console.log("External Recipients:");
    externalRecipients.forEach((recipient) => console.log(`${recipient.displayName}, ${recipient.emailAddress}`));
}

if (internalRecipients.length > 0) {
    console.log("Internal Recipients:");
    internalRecipients.forEach((recipient) => console.log(`${recipient.displayName}, ${recipient.emailAddress}`));
}

if (otherRecipients.length > 0) {
    console.log("Other Recipients:");
    otherRecipients.forEach((recipient) => console.log(`${recipient.displayName}, ${recipient.emailAddress}`));
}

Detalles del método

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 parameter 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: Lectura 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 parameter 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: Lectura de mensajes

displayReplyAllForm(formData)

Muestra un formulario de respuesta que incluye el remitente y todos los destinatarios del mensaje seleccionado o el organizador y todos los asistentes de la cita seleccionada.

displayReplyAllForm(formData: string | ReplyFormData): void;

Parámetros

formData

string | Office.ReplyFormData

Una cadena que contiene texto y HTML y que representa el cuerpo del formulario de respuestas. La cadena está limitada a 32 KB o a un objeto ReplyFormData que contiene datos de cuerpo o datos adjuntos y una función de devolución de llamada.

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.1 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Asistente de cita

Importante:

• En Outlook en la Web y nueva Outlook en Windows, el formulario de respuesta se muestra como un formulario emergente en la vista de 3 columnas y un formulario emergente en la vista de 2 columnas o 1 columna.

• Si cualquiera de los parámetros de cadena supera sus límites, displayReplyAllForm produce una excepción.

• Cuando se especifican datos adjuntos en el formData.attachments parámetro , Outlook intenta descargar todos los datos adjuntos y adjuntarlos al formulario de respuesta. Si se produce un error al agregar los datos adjuntos, se muestra un error en la interfaz de usuario del formulario. Si esto no es posible, no se produce ningún mensaje de error.

• Este método no se admite en Outlook en Android o 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.

Ejemplos

// The following code passes a string to the `displayReplyAllForm` method.
Office.context.mailbox.item.displayReplyAllForm('hello there');
Office.context.mailbox.item.displayReplyAllForm('<b>hello there</b>');

// Reply with an empty body.
Office.context.mailbox.item.displayReplyAllForm({});

// Reply with just a body.
Office.context.mailbox.item.displayReplyAllForm(
{
'htmlBody' : 'hi'
});

// Reply with a body and a file attachment.
Office.context.mailbox.item.displayReplyAllForm(
{
    'htmlBody' : 'hi',
    'attachments' :
    [
        {
        'type' : Office.MailboxEnums.AttachmentType.File,
        'name' : 'squirrel.png',
        'url' : 'http://i.imgur.com/sRgTlGR.jpg'
        }
    ]
});

// Reply with a body and an item attachment.
Office.context.mailbox.item.displayReplyAllForm(
{
    'htmlBody' : 'hi',
    'attachments' :
    [
        {
        'type' : 'item',
        'name' : 'rand',
        'itemId' : Office.context.mailbox.item.itemId
        }
    ]
});

// Reply with a body, file attachment, item attachment, and a callback.
Office.context.mailbox.item.displayReplyAllForm(
{
    'htmlBody' : 'hi',
    'attachments' :
    [
        {
            'type' : Office.MailboxEnums.AttachmentType.File,
            'name' : 'squirrel.png',
            'url' : 'http://i.imgur.com/sRgTlGR.jpg'
        },
        {
            'type' : 'item',
            'name' : 'rand',
            'itemId' : Office.context.mailbox.item.itemId
        }
    ],
    'callback' : function(asyncResult)
    {
        console.log(asyncResult.value);
    }
});

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/55-display-items/display-reply-forms.yaml

Office.context.mailbox.item.displayReplyAllForm("This is a reply ALL with <b>some bold text</b>.");

displayReplyAllFormAsync(formData, options, callback)

Muestra un formulario de respuesta que incluye el remitente y todos los destinatarios del mensaje seleccionado o el organizador y todos los asistentes de la cita seleccionada.

displayReplyAllFormAsync(formData: string | ReplyFormData, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parámetros

formData

string | Office.ReplyFormData

Una cadena que contiene texto y HTML y que representa el cuerpo del formulario de respuestas. La cadena está limitada a 32 KB o a un objeto ReplyFormData que contiene datos de cuerpo o datos adjuntos y una función de devolución de llamada.

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.9 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Lectura de mensajes

Importante:

• En Outlook en la Web y nueva Outlook en Windows, el formulario de respuesta se muestra como un formulario emergente en la vista de 3 columnas y un formulario emergente en la vista de 2 columnas o 1 columna.

• Si cualquiera de los parámetros de cadena supera sus límites, displayReplyAllFormAsync produce una excepción.

• Cuando se especifican datos adjuntos en el formData.attachments parámetro , Outlook intenta descargar todos los datos adjuntos y adjuntarlos al formulario de respuesta. Si se produce un error al agregar los datos adjuntos, se muestra un error en la interfaz de usuario del formulario. Si esto no es posible, no se produce ningún mensaje de error.

• Este método no se admite en Outlook en Android o 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.

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/55-display-items/display-reply-forms.yaml

Office.context.mailbox.item.displayReplyAllFormAsync("This is a reply ALL with <b>some bold text</b>.", function(
  asyncResult
) {
  console.log(JSON.stringify(asyncResult));
});

displayReplyAllFormAsync(formData, callback)

Muestra un formulario de respuesta que incluye el remitente y todos los destinatarios del mensaje seleccionado o el organizador y todos los asistentes de la cita seleccionada.

displayReplyAllFormAsync(formData: string | ReplyFormData, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parámetros

formData

string | Office.ReplyFormData

Una cadena que contiene texto y HTML y que representa el cuerpo del formulario de respuestas. La cadena está limitada a 32 KB o a un objeto ReplyFormData que contiene datos de cuerpo o datos adjuntos y una 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.9 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Lectura de mensajes

Importante:

• En Outlook en la Web y nueva Outlook en Windows, el formulario de respuesta se muestra como un formulario emergente en la vista de 3 columnas y un formulario emergente en la vista de 2 columnas o 1 columna.

• Si cualquiera de los parámetros de cadena supera sus límites, displayReplyAllFormAsync produce una excepción.

• Cuando se especifican datos adjuntos en el formData.attachments parámetro , Outlook intenta descargar todos los datos adjuntos y adjuntarlos al formulario de respuesta. Si se produce un error al agregar los datos adjuntos, se muestra un error en la interfaz de usuario del formulario. Si esto no es posible, no se produce ningún mensaje de error.

• Este método no se admite en Outlook en Android o 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.

displayReplyForm(formData)

Muestra un formulario de respuesta que incluye solo el remitente del mensaje seleccionado o el organizador de la cita seleccionada.

displayReplyForm(formData: string | ReplyFormData): void;

Parámetros

formData

string | Office.ReplyFormData

Una cadena que contiene texto y HTML y que representa el cuerpo del formulario de respuestas. La cadena está limitada a 32 KB o a un objeto ReplyFormData que contiene datos de cuerpo o datos adjuntos y una función de devolución de llamada.

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.1 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Lectura de mensajes

Importante:

• En Outlook en la Web y nueva Outlook en Windows, el formulario de respuesta se muestra como un formulario emergente en la vista de 3 columnas y un formulario emergente en la vista de 2 columnas o 1 columna.

• Si cualquiera de los parámetros de cadena supera sus límites, displayReplyForm produce una excepción.

• Cuando se especifican datos adjuntos en el formData.attachments parámetro , Outlook intenta descargar todos los datos adjuntos y adjuntarlos al formulario de respuesta. Si se produce un error al agregar los datos adjuntos, se muestra un error en la interfaz de usuario del formulario. Si esto no es posible, no se produce ningún mensaje de error.

• Este método no se admite en Outlook en Android o 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.

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/55-display-items/display-reply-forms.yaml

Office.context.mailbox.item.displayReplyForm("This is a reply with <i>some text in italics</i>.");

...

Office.context.mailbox.item.displayReplyForm({
  htmlBody: "This is a reply with an inline image and an item attachment.<br><img src='cid:dog.jpg'>",
  attachments: [
    { type: "file", url: "https://i.imgur.com/9S36xvA.jpg", name: "dog.jpg", inLine: true },
    { type: "item", itemId: Office.context.mailbox.item.itemId, name: "test_email.msg" }
  ],
  callback: (result) => {
    if (result.status === Office.AsyncResultStatus.Failed) {
      console.error(`Action failed with message ${result.error.message}`);
      return;
    }

    console.log("Created reply with attachments.");
  }
});

displayReplyFormAsync(formData, options, callback)

Muestra un formulario de respuesta que incluye solo el remitente del mensaje seleccionado o el organizador de la cita seleccionada.

displayReplyFormAsync(formData: string | ReplyFormData, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parámetros

formData

string | Office.ReplyFormData

Una cadena que contiene texto y HTML y que representa el cuerpo del formulario de respuestas. La cadena está limitada a 32 KB o a un objeto ReplyFormData que contiene datos de cuerpo o datos adjuntos y una función de devolución de llamada.

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.9 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Lectura de mensajes

Importante:

• En Outlook en la Web y nueva Outlook en Windows, el formulario de respuesta se muestra como un formulario emergente en la vista de 3 columnas y un formulario emergente en la vista de 2 columnas o 1 columna.

• Si cualquiera de los parámetros de cadena supera sus límites, displayReplyFormAsync produce una excepción.

• Cuando se especifican datos adjuntos en el formData.attachments parámetro , Outlook intenta descargar todos los datos adjuntos y adjuntarlos al formulario de respuesta. Si se produce un error al agregar los datos adjuntos, se muestra un error en la interfaz de usuario del formulario. Si esto no es posible, no se produce ningún mensaje de error.

• Este método no se admite en Outlook en Android o 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.

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/55-display-items/display-reply-forms.yaml

Office.context.mailbox.item.displayReplyFormAsync("This is a reply with <i>some text in italics</i>.", function(
  asyncResult
) {
  console.log(JSON.stringify(asyncResult));
});

...

// The async version is only available starting with requirement set 1.9.
// It provides a callback when the new appointment form has been created.
Office.context.mailbox.item.displayReplyFormAsync(
  {
    htmlBody: "This is a reply with an inline image and an item attachment.<br><img src='cid:dog.jpg'>",
    attachments: [
      { type: "file", url: "http://i.imgur.com/9S36xvA.jpg", name: "dog.jpg", inLine: true },
      { type: "item", itemId: Office.context.mailbox.item.itemId, name: "test_email.msg" }
    ]
  },
  (asyncResult) => {
    console.log(JSON.stringify(asyncResult));
  }
);

displayReplyFormAsync(formData, callback)

Muestra un formulario de respuesta que incluye solo el remitente del mensaje seleccionado o el organizador de la cita seleccionada.

displayReplyFormAsync(formData: string | ReplyFormData, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parámetros

formData

string | Office.ReplyFormData

Una cadena que contiene texto y HTML y que representa el cuerpo del formulario de respuestas. La cadena está limitada a 32 KB o a un objeto ReplyFormData que contiene datos de cuerpo o datos adjuntos y una 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.9 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Lectura de mensajes

Importante:

• En Outlook en la Web y nueva Outlook en Windows, el formulario de respuesta se muestra como un formulario emergente en la vista de 3 columnas y un formulario emergente en la vista de 2 columnas o 1 columna.

• Si cualquiera de los parámetros de cadena supera sus límites, displayReplyFormAsync produce una excepción.

• Cuando se especifican datos adjuntos en el formData.attachments parámetro , Outlook intenta descargar todos los datos adjuntos y adjuntarlos al formulario de respuesta. Si se produce un error al agregar los datos adjuntos, se muestra un error en la interfaz de usuario del formulario. Si esto no es posible, no se produce ningún mensaje de error.

• Este método no se admite en Outlook en Android o 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.

getAllInternetHeadersAsync(options, callback)

Obtiene todos los encabezados de Internet del mensaje como una cadena.

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

getAllInternetHeadersAsync(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

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 ejecuta correctamente, los datos de encabezados de Internet se proporcionan en la asyncResult.value propiedad como una cadena. Consulte RFC 2183 para obtener la información de formato del valor de cadena devuelto. 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: Lectura de mensajes

Ejemplos

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

Office.context.mailbox.item.getAllInternetHeadersAsync(function (asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Internet headers received successfully");
    if (asyncResult.value.match(/preferred-fruit:.*/gim)) {
      console.log("Sender's preferred fruit: " + asyncResult.value.match(/preferred-fruit:.*/gim)[0].slice(17));
    } else {
      console.log("Didn't receive header with sender's preferred fruit");
    }
    if (asyncResult.value.match(/preferred-vegetable:.*/gim)) {
      console.log(
        "Sender's preferred vegetable: " + asyncResult.value.match(/preferred-vegetable:.*/gim)[0].slice(21)
      );
    } else {
      console.log("Didn't receive header with sender's preferred vegetable");
    }
  } else {
    console.log("Error getting internet headers: " + JSON.stringify(asyncResult.error));
  }
});

getAllInternetHeadersAsync(callback)

Obtiene todos los encabezados de Internet del mensaje como una cadena.

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

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

Parámetros

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, asyncResult, que es un Office.AsyncResult objeto . Si se ejecuta correctamente, los datos de encabezados de Internet se proporcionan en la asyncResult.value propiedad como una cadena. Consulte RFC 2183 para obtener la información de formato del valor de cadena devuelto. 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: Lectura de mensajes

getAsFileAsync(options, callback)

Obtiene el mensaje actual en formato EML codificado en Base64.

getAsFileAsync(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 parámetro de devolución de llamada con un único parámetro, asyncResult, que es un Office.AsyncResult objeto . El formato EML codificado en Base64 del mensaje se devuelve en la asyncResult.value propiedad . Los errores detectados se devuelven en la asyncResult.error propiedad .

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.14 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Lectura de mensajes

getAsFileAsync(callback)

Obtiene el mensaje actual en formato EML codificado en Base64.

getAsFileAsync(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 parámetro de devolución de llamada con un único parámetro, asyncResult, que es un Office.AsyncResult objeto . El formato EML codificado en Base64 del mensaje se devuelve en la asyncResult.value propiedad . Los errores detectados se devuelven en la asyncResult.error propiedad .

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.14 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Lectura de mensajes

Ejemplos

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

Office.context.mailbox.item.getAsFileAsync((asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Failed) {
    console.log(`Error encountered during processing: ${asyncResult.error.message}`);
    return;
  }

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

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 llamada item.attachments y, a continuación, en la misma sesión, usar ese identificador para recuperar los datos adjuntos. En Outlook en la Web, en dispositivos móviles y en la nueva Outlook en Windows, 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: Lectura 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 read mode.
// The item.attachments call can only be used in read mode.
const attachments = item.attachments;
if (attachments.length <= 0) {
  console.log("Mail item has no attachments.");
  return;
}

for (let i = 0; i < attachments.length; i++) {
  // Log the attachment type and its contents to the console.
  item.getAttachmentContentAsync(attachments[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 llamada item.attachments y, a continuación, en la misma sesión, usar ese identificador para recuperar los datos adjuntos. En Outlook en la Web, en dispositivos móviles y en la nueva Outlook en Windows, 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: Lectura 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.

getEntities()

Advertencia

Esta API ya está en desuso.

Use regular expression rules instead.

Obtiene las entidades que obtenidas en el cuerpo del elemento seleccionado.

Advertencia: Ahora se han retirado los complementos contextuales de Outlook basados en entidades. Sin embargo, se siguen admitiendo reglas de expresión regular. Se recomienda actualizar el complemento contextual para usar reglas de expresión regular como solución alternativa. Para obtener instrucciones sobre cómo implementar estas reglas, vea Complementos contextuales de Outlook.

getEntities(): Entities;

Devoluciones

Office.Entities

Comentarios

[ Conjunto de API: Buzón 1.1 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Asistente de cita

getEntitiesByType(entityType)

Advertencia

Esta API ya está en desuso.

Use regular expression rules instead.

Obtiene una matriz de todas las entidades del tipo de entidad especificado encontrado en el cuerpo del elemento seleccionado.

Advertencia: Ahora se han retirado los complementos contextuales de Outlook basados en entidades. Sin embargo, se siguen admitiendo reglas de expresión regular. Se recomienda actualizar el complemento contextual para usar reglas de expresión regular como solución alternativa. Para obtener instrucciones sobre cómo implementar estas reglas, vea Complementos contextuales de Outlook.

getEntitiesByType(entityType: MailboxEnums.EntityType | string): Array<string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion>;

Parámetros

entityType

Office.MailboxEnums.EntityType | string

Uno de los EntityType valores de enumeración.

Devoluciones

Array<string | Office.Contact | Office.MeetingSuggestion | Office.PhoneNumber | Office.TaskSuggestion>

Si el valor pasado en entityType no es un miembro válido de la EntityType enumeración, el método devuelve null. Si no hay presente ninguna entidad del tipo especificado en el cuerpo del elemento, el método devuelve una matriz vacía. De lo contrario, el tipo de los objetos en la matriz devuelta depende del tipo de entidad solicitada en el parámetro entityType.

Comentarios

[ Conjunto de API: Buzón 1.1 ]

Nivel mínimo de permiso: restringido

Modo de Outlook aplicable: Lectura de mensajes

getFilteredEntitiesByName(name)

Advertencia

Esta API ya está en desuso.

Use regular expression rules instead.

Devuelve entidades conocidas en el elemento seleccionado que pasan el filtro con nombre definido en un archivo de manifiesto de solo complemento.

Advertencia: Ahora se han retirado los complementos contextuales de Outlook basados en entidades. Sin embargo, se siguen admitiendo reglas de expresión regular. Se recomienda actualizar el complemento contextual para usar reglas de expresión regular como solución alternativa. Para obtener instrucciones sobre cómo implementar estas reglas, vea Complementos contextuales de Outlook.

getFilteredEntitiesByName(name: string): Array<string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion>;

Parámetros

name

string

El nombre del elemento de regla ItemHasKnownEntity que define el filtro para que coincidan.

Devoluciones

Array<string | Office.Contact | Office.MeetingSuggestion | Office.PhoneNumber | Office.TaskSuggestion>

Entidades que coinciden con la expresión regular definida en el ItemHasKnownEntity elemento rule del archivo de manifiesto del complemento con el valor de elemento especificado FilterName . Si no hay ningún ItemHasKnownEntity elemento en el manifiesto con un FilterName valor de elemento que coincida con el name parámetro , el método devuelve null. Si el name parámetro coincide con un ItemHasKnownEntity elemento del manifiesto, pero no hay ninguna entidad en el elemento actual que coincida, el método devuelve una matriz vacía.

Comentarios

[ Conjunto de API: Buzón 1.1 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Asistente de cita

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: Lectura 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: Lectura de mensajes

getRegExMatches()

Devuelve los valores de cadena del elemento seleccionado que coinciden con las expresiones regulares definidas en un archivo de manifiesto de solo complemento.

getRegExMatches(): any;

Devoluciones

any

Objeto que contiene matrices de cadenas que coinciden con las expresiones regulares definidas en el archivo de manifiesto del complemento. El nombre de cada matriz es igual al valor correspondiente del atributo RegExName de la regla coincidente ItemHasRegularExpressionMatch . Para una ItemHasRegularExpressionMatch regla, debe producirse una cadena coincidente en la propiedad del elemento especificado por esa regla. El tipo simple PropertyName define las propiedades admitidas.

Comentarios

[ Conjunto de API: Buzón 1.1 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Asistente de cita

Importante:

• Ahora se han retirado los complementos contextuales de Outlook basados en entidades. Sin embargo, se siguen admitiendo reglas de expresión regular. Se recomienda actualizar el complemento contextual para usar reglas de expresión regular como solución alternativa. Para obtener instrucciones sobre cómo implementar estas reglas, vea Complementos contextuales de Outlook.

• Este método se usa con la característica de reglas de activación para complementos de Outlook, que no es compatible con el manifiesto unificado para Microsoft 365.

• Si especifica una ItemHasRegularExpressionMatch regla en la propiedad body de un elemento, la expresión regular debe filtrar aún más el cuerpo y no debe intentar devolver todo el cuerpo del elemento. El uso de una expresión regular como .* para obtener todo el cuerpo de un elemento no siempre devuelve los resultados esperados. En su lugar, use el método Body.getAsync para recuperar todo el cuerpo.

• Este método no se admite en Outlook en Android o 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.

Ejemplos

// Consider an add-in manifest has the following `Rule` element:
//<Rule xsi:type="RuleCollection" Mode="And">
//  <Rule xsi:type="ItemIs" FormType="Read" ItemType="Message" />
//  <Rule xsi:type="RuleCollection" Mode="Or">
//    <Rule xsi:type="ItemHasRegularExpressionMatch" RegExName="fruits" RegExValue="apple|banana|coconut" PropertyName="BodyAsPlaintext" IgnoreCase="true" />
//    <Rule xsi:type="ItemHasRegularExpressionMatch" RegExName="veggies" RegExValue="tomato|onion|spinach|broccoli" PropertyName="BodyAsPlaintext" IgnoreCase="true" />
//  </Rule>
//</Rule>

// The object returned from `getRegExMatches` would have two properties: `fruits` and `veggies`.
//{
//'fruits': ['apple','banana','Banana','coconut'],
//'veggies': ['tomato','onion','spinach','broccoli']
//}

// The following example shows how to access the array of
// matches for the regular expression rule elements `fruits`
// and `veggies`, which are specified in the manifest.
const allMatches = Office.context.mailbox.item.getRegExMatches();
const fruits = allMatches.fruits;
const veggies = allMatches.veggies;

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/75-regex-matches/contextual.yaml

// This API only works when you click on the highlighted word "ScriptLab".
console.log(Office.context.mailbox.item.getRegExMatches());

getRegExMatchesByName(name)

Devuelve los valores de cadena del elemento seleccionado que coinciden con la expresión regular con nombre definida en un archivo de manifiesto de solo complemento.

getRegExMatchesByName(name: string): string[];

Parámetros

name

string

El nombre del elemento de regla ItemHasRegularExpressionMatch que define el filtro para que coincidan.

Devoluciones

string[]

Matriz que contiene las cadenas que coinciden con la expresión regular definida en el ItemHasRegularExpressionMatch elemento rule del archivo de manifiesto del complemento, con el valor de elemento especificado RegExName .

Comentarios

[ Conjunto de API: Buzón 1.1 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Asistente de cita

Importante:

• Ahora se han retirado los complementos contextuales de Outlook basados en entidades. Sin embargo, se siguen admitiendo reglas de expresión regular. Se recomienda actualizar el complemento contextual para usar reglas de expresión regular como solución alternativa. Para obtener instrucciones sobre cómo implementar estas reglas, vea Complementos contextuales de Outlook.

• Este método se usa con la característica de reglas de activación para complementos de Outlook, que no es compatible con el manifiesto unificado para Microsoft 365.

• Si especifica una ItemHasRegularExpressionMatch regla en la propiedad body de un elemento, la expresión regular debe filtrar aún más el cuerpo y no debe intentar devolver todo el cuerpo del elemento. El uso de una expresión regular como .* para obtener todo el cuerpo de un elemento no siempre devuelve los resultados esperados. En su lugar, use el método Body.getAsync para recuperar todo el cuerpo.

• Este método no se admite en Outlook en Android o 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.

Ejemplos

// Consider an add-in manifest has the following `Rule` element:
//<Rule xsi:type="RuleCollection" Mode="And">
//  <Rule xsi:type="ItemIs" FormType="Read" ItemType="Message" />
//  <Rule xsi:type="RuleCollection" Mode="Or">
//    <Rule xsi:type="ItemHasRegularExpressionMatch" RegExName="fruits" RegExValue="apple|banana|coconut" PropertyName="BodyAsPlaintext" IgnoreCase="true" />
//    <Rule xsi:type="ItemHasRegularExpressionMatch" RegExName="veggies" RegExValue="tomato|onion|spinach|broccoli" PropertyName="BodyAsPlaintext" IgnoreCase="true" />
//  </Rule>
//</Rule>

// The object returned from `getRegExMatches` would have two properties: `fruits` and `veggies`.
//{
//'fruits': ['apple','banana','Banana','coconut'],
//'veggies': ['tomato','onion','spinach','broccoli']
//}

const fruits = Office.context.mailbox.item.getRegExMatchesByName("fruits");
const veggies = Office.context.mailbox.item.getRegExMatchesByName("veggies");

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/75-regex-matches/contextual.yaml

// This API only works when you click on the highlighted word "ScriptLab".
console.log(Office.context.mailbox.item.getRegExMatchesByName("sampleRegexName"));

getSelectedEntities()

Advertencia

Esta API ya está en desuso.

Use regular expression rules instead.

Obtiene las entidades que se han detectado en una coincidencia resaltada que un usuario ha seleccionado. Las coincidencias resaltadas se aplican a complementos contextuales.

Advertencia: Ahora se han retirado los complementos contextuales de Outlook basados en entidades. Sin embargo, se siguen admitiendo reglas de expresión regular. Se recomienda actualizar el complemento contextual para usar reglas de expresión regular como solución alternativa. Para obtener instrucciones sobre cómo implementar estas reglas, vea Complementos contextuales de Outlook.

getSelectedEntities(): Entities;

Devoluciones

Office.Entities

Comentarios

[ Conjunto de API: Buzón 1.6 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Lectura de mensajes

getSelectedRegExMatches()

Devuelve valores de cadena en una coincidencia resaltada que coinciden con las expresiones regulares definidas en un archivo de manifiesto de solo complemento. Las coincidencias resaltadas se aplican a complementos contextuales.

getSelectedRegExMatches(): any;

Devoluciones

any

Objeto que contiene matrices de cadenas que coinciden con las expresiones regulares definidas en el archivo de manifiesto del complemento. El nombre de cada matriz es igual al valor correspondiente del RegExName atributo de la regla coincidente ItemHasRegularExpressionMatch . Para una ItemHasRegularExpressionMatch regla, debe producirse una cadena coincidente en la propiedad del elemento especificado por esa regla. El tipo simple PropertyName define las propiedades admitidas.

Comentarios

[ Conjunto de API: Buzón 1.6 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Lectura de mensajes

Importante:

• Ahora se han retirado los complementos contextuales de Outlook basados en entidades. Sin embargo, se siguen admitiendo reglas de expresión regular. Se recomienda actualizar el complemento contextual para usar reglas de expresión regular como solución alternativa. Para obtener instrucciones sobre cómo implementar estas reglas, vea Complementos contextuales de Outlook.

• Este método se usa con la característica de reglas de activación para complementos de Outlook, que no es compatible con el manifiesto unificado para Microsoft 365.

• Este método no se admite en Outlook en iOS o Android. 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 especifica una ItemHasRegularExpressionMatch regla en la propiedad body de un elemento, la expresión regular debe filtrar aún más el cuerpo y no debe intentar devolver todo el cuerpo del elemento. El uso de una expresión regular como .* para obtener todo el cuerpo de un elemento no siempre devuelve los resultados esperados. En su lugar, use el método Body.getAsync para recuperar todo el cuerpo.

Ejemplos

// Consider an add-in manifest has the following `Rule` element:
//<Rule xsi:type="RuleCollection" Mode="And">
//  <Rule xsi:type="ItemIs" FormType="Read" ItemType="Message" />
//  <Rule xsi:type="RuleCollection" Mode="Or">
//    <Rule xsi:type="ItemHasRegularExpressionMatch" RegExName="fruits" RegExValue="apple|banana|coconut" PropertyName="BodyAsPlaintext" IgnoreCase="true" />
//    <Rule xsi:type="ItemHasRegularExpressionMatch" RegExName="veggies" RegExValue="tomato|onion|spinach|broccoli" PropertyName="BodyAsPlaintext" IgnoreCase="true" />
//  </Rule>
//</Rule>

// The object returned from `getRegExMatches` would have two properties: `fruits` and `veggies`.
//{
//'fruits': ['apple','banana','Banana','coconut'],
//'veggies': ['tomato','onion','spinach','broccoli']
//}

// The following example shows how to access the array of matches for the
// regular expression rule elements `fruits` and `veggies`, which are
// specified in the manifest.
const selectedMatches = Office.context.mailbox.item.getSelectedRegExMatches();
const fruits = selectedMatches.fruits;
const veggies = selectedMatches.veggies;

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/75-regex-matches/contextual.yaml

const matches = Office.context.mailbox.item.getSelectedRegExMatches();
if (matches) {
    console.log(matches);
} else {
    console.error("Open add-in by clicking on a highlighted regex match, for this API to return something useful.");
}

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: Lectura de mensajes

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

getSharedPropertiesAsync(callback)

Obtiene las propiedades de una cita o mensaje en una carpeta compartida o un buzón compartido (ahora en versión preliminar).

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: Lectura de mensajes

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

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

Office.context.mailbox.item.getSharedPropertiesAsync((result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.error("The current folder or mailbox isn't shared.");
    return;
  }
  const sharedProperties = result.value;
  console.log(`Owner: ${sharedProperties.owner}`);
  console.log(`Permissions: ${sharedProperties.delegatePermissions}`);
  console.log(`Target mailbox: ${sharedProperties.targetMailbox}`);
});

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: Lectura de mensajes

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/15-item-custom-properties/load-set-get-save.yaml

Office.context.mailbox.item.loadCustomPropertiesAsync((result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.error(`loadCustomPropertiesAsync failed with message ${result.error.message}`);
    return;
  }

  customProps = result.value;
  console.log("Loaded the CustomProperties object.");
});

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: Lectura 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: Lectura de mensajes

Ejemplos

Office.context.mailbox.item.removeHandlerAsync(Office.EventType.ItemChanged, (asyncResult) => {
    if (asyncResult.status === Office.AsyncResultStatus.Failed) {
        console.error("Failed to remove event handler: " + asyncResult.error.message);
        return;
    }

    console.log("Event handler removed successfully.");
});