Office.MessageRead interface

Referencia

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.

Interfaces primarias:

Extends: Office.Message

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.
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: 500 destinatarios Android, interfaz de usuario clásica de Mac, iOS: 100 destinatarios Explorador web: 20 destinatarios 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.
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 para el elemento actual. La propiedad `itemId` no está disponible en el modo redacción. Si se requiere un identificador de elemento, el método `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. Nota: El identificador devuelto por la `itemId` propiedad es el mismo que el identificador de elemento de Exchange Web Services. La propiedad `itemId` no es idéntica al identificador de entrada de Outlook ni al identificador que usa la API de 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.
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.
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.
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: 500 destinatarios Android, interfaz de usuario clásica de Mac, iOS: 100 destinatarios Explorador web: 20 destinatarios Nueva interfaz de usuario de Mac: sin límite

Métodos

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.
displayReplyForm(formData)	Muestra un formulario de respuesta que incluye solo el remitente del mensaje seleccionado o el organizador de la cita seleccionada.
getEntities()	Obtiene las entidades que obtenidas en el cuerpo del elemento seleccionado.
getEntitiesByType(entityType)	Obtiene una matriz de todas las entidades del tipo de entidad especificado encontrado en el cuerpo del elemento seleccionado.
getFilteredEntitiesByName(name)	Devuelve entidades conocidas del elemento seleccionado que pasan el filtro con nombre definido en un archivo de manifiesto XML.
getRegExMatches()	Devuelve los valores de cadena del elemento seleccionado que coinciden con las expresiones regulares definidas en un archivo de manifiesto XML.
getRegExMatchesByName(name)	Devuelve valores de cadena en el elemento seleccionado que coinciden con la expresión regular con nombre definida en un archivo de manifiesto XML.
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.

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"
}

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: 500 destinatarios
Android, interfaz de usuario clásica de Mac, iOS: 100 destinatarios
Explorador web: 20 destinatarios
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}`);

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.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 para el elemento actual.

La propiedad itemId no está disponible en el modo redacción. Si se requiere un identificador de elemento, el método 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.

Nota: El identificador devuelto por la itemId propiedad es el mismo que el identificador de elemento de Exchange Web Services. La propiedad itemId no es idéntica al identificador de entrada de Outlook ni al identificador que usa la API de 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.

itemId: string;

Valor de propiedad

string

Comentarios

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Lectura de mensajes

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

sender

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

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 + ")");

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: 500 destinatarios
Android, interfaz de usuario clásica de Mac, iOS: 100 destinatarios
Explorador web: 20 destinatarios
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

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, 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 de 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

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

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

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, 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 de 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.");
  }
});

getEntities()

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

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

Importante:

Los complementos contextuales de Outlook basados en entidades, incluido el método , se retirarán en el getEntities segundo trimestre de 2024. El trabajo para retirar este método comenzará en mayo y continuará hasta finales de junio. Después de junio, los complementos contextuales ya no podrán detectar entidades en elementos de correo para realizar tareas en ellos. Las reglas de expresión regular seguirán siendo compatibles después de retirar los complementos contextuales basados en entidades. 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 Usar reglas de activación de expresiones regulares para mostrar un complemento de Outlook. Para obtener más información sobre la retirada de complementos contextuales de Outlook basados en entidades, consulte Retirada de complementos contextuales de Outlook basados en entidades.
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/75-entities-and-regex-matches/basic-entities.yaml

const entities = Office.context.mailbox.item.getEntities();
let entityTypesFound = 0;
if (entities.addresses.length > 0) {
    console.warn("physical addresses: ");
    console.log(entities.addresses);
    entityTypesFound++;
}
if (entities.contacts.length > 0) {
    console.warn("contacts: ");
    entities.contacts.forEach(function (contact) { console.log(contact.personName); })
    entityTypesFound++;
}
if (entities.emailAddresses.length > 0) {
    console.warn("email addresses: ");
    console.log(entities.emailAddresses);
    entityTypesFound++;
}
if (entities.meetingSuggestions.length > 0) {
    console.warn("meetings suggestions: ");
    entities.meetingSuggestions.forEach(function (meetingSuggestion) { console.log(meetingSuggestion.meetingString); })
    entityTypesFound++;
}
if (entities.phoneNumbers.length > 0) {
    console.warn("phone numbers: ");
    entities.phoneNumbers.forEach(function (phoneNumber) { console.log(phoneNumber.originalPhoneString); })
    entityTypesFound++;
}
if (entities.taskSuggestions.length > 0) {
    console.warn("task suggestions: ");
    entities.taskSuggestions.forEach(function (taskSuggestion) { console.log(taskSuggestion.taskString); })
    entityTypesFound++;
}
if (entities.urls.length > 0) {
    console.warn("URLs: ");
    console.log(entities.urls);
    entityTypesFound++;
}
if (entityTypesFound == 0)
{
    console.log("No entities found on this item.");
}

getEntitiesByType(entityType)

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

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.

Aunque el nivel de permiso mínimo para usar este método está restringido, algunos tipos de entidad requieren acceso a elementos de lectura , como se especifica en la tabla siguiente.

Valor de entityType	Tipo de objetos de la matriz devuelta	Nivel de permiso requerido
Dirección	Cadena	Restricted
Contacto	Contacto	ReadItem
EmailAddress	Cadena	ReadItem
MeetingSuggestion	MeetingSuggestion	ReadItem
PhoneNumber	PhoneNumber	Restricted
TaskSuggestion	TaskSuggestion	ReadItem
URL	Cadena	Restricted

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

Importante:

Los complementos contextuales de Outlook basados en entidades, incluido el método , se retirarán en el getEntitiesByType segundo trimestre de 2024. El trabajo para retirar este método comenzará en mayo y continuará hasta finales de junio. Después de junio, los complementos contextuales ya no podrán detectar entidades en elementos de correo para realizar tareas en ellos. Las reglas de expresión regular seguirán siendo compatibles después de retirar los complementos contextuales basados en entidades. 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 Usar reglas de activación de expresiones regulares para mostrar un complemento de Outlook. Para obtener más información sobre la retirada de complementos contextuales de Outlook basados en entidades, consulte Retirada de complementos contextuales de Outlook basados en entidades.
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/75-entities-and-regex-matches/basic-entities.yaml

console.log(Office.context.mailbox.item.getEntitiesByType(Office.MailboxEnums.EntityType.Address));

getFilteredEntitiesByName(name)

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

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 XML de manifiesto 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

Importante:

Los complementos contextuales de Outlook basados en entidades, incluido el método , se retirarán en el getFilteredEntitiesByName segundo trimestre de 2024. El trabajo para retirar este método comenzará en mayo y continuará hasta finales de junio. Después de junio, los complementos contextuales ya no podrán detectar entidades en elementos de correo para realizar tareas en ellos. Las reglas de expresión regular seguirán siendo compatibles después de retirar los complementos contextuales basados en entidades. 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 Usar reglas de activación de expresiones regulares para mostrar un complemento de Outlook. Para obtener más información sobre la retirada de complementos contextuales de Outlook basados en entidades, consulte Retirada de complementos contextuales de Outlook basados en entidades.
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 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/75-entities-and-regex-matches/contextual.yaml

// This API would only work when you click on highlighted physical address that has the word "Way" in it.
console.log(Office.context.mailbox.item.getFilteredEntitiesByName("sampleFilterName"));

getRegExMatches()

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

getRegExMatches(): any;

Devoluciones

any

Un objeto que contiene matrices de cadenas que coinciden con las expresiones regulares definidas en el archivo XML de manifiesto. El nombre de cada matriz es igual al valor correspondiente del atributo RegExName de la regla coincidente ItemHasRegularExpressionMatch o el FilterName atributo de la regla coincidente ItemHasKnownEntity . Para una regla ItemHasRegularExpressionMatch, tiene que darse una cadena coincidente en la propiedad del elemento especificado por la 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:

Los complementos contextuales de Outlook basados en entidades se retirarán en el segundo trimestre de 2024. Una vez retirados, los complementos contextuales ya no podrán detectar entidades en elementos de correo para realizar tareas en ellos. Las reglas de expresión regular seguirán siendo compatibles después de retirar los complementos contextuales basados en entidades. 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 Usar reglas de activación de expresiones regulares para mostrar un complemento de Outlook. Para obtener más información sobre la retirada de complementos contextuales basados en entidades, consulte Retirada de complementos contextuales de Outlook basados en entidades.
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-entities-and-regex-matches/contextual.yaml

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

getRegExMatchesByName(name)

Devuelve valores de cadena en el elemento seleccionado que coinciden con la expresión regular con nombre definida en un archivo de manifiesto XML.

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 XML de manifiesto, 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:

Los complementos contextuales de Outlook basados en entidades se retirarán en el segundo trimestre de 2024. Una vez retirados, los complementos contextuales ya no podrán detectar entidades en elementos de correo para realizar tareas en ellos. Las reglas de expresión regular seguirán siendo compatibles después de retirar los complementos contextuales basados en entidades. 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 Usar reglas de activación de expresiones regulares para mostrar un complemento de Outlook. Para obtener más información sobre la retirada de complementos contextuales basados en entidades, consulte Retirada de complementos contextuales de Outlook basados en entidades.
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-entities-and-regex-matches/contextual.yaml

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

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

Compartir a través de

Office.MessageRead interface

Propiedades

Métodos

Detalles de las propiedades

attachments

Valor de propiedad

Comentarios

Ejemplos

body

Valor de propiedad

Comentarios

Ejemplos

cc

Valor de propiedad

Comentarios

Ejemplos

conversationId

Valor de propiedad

Comentarios

Ejemplos

dateTimeCreated

Valor de propiedad

Comentarios

Ejemplos

dateTimeModified

Valor de propiedad

Comentarios

Ejemplos

end

Valor de propiedad

Comentarios

Ejemplos

from

Valor de propiedad

Comentarios

Ejemplos

internetMessageId

Valor de propiedad

Comentarios

Ejemplos

itemClass

Valor de propiedad

Comentarios

Ejemplos

itemId

Valor de propiedad

Comentarios

Ejemplos

itemType

Valor de propiedad

Comentarios

Ejemplos

location

Valor de propiedad

Comentarios

Ejemplos

normalizedSubject

Valor de propiedad

Comentarios

Ejemplos

notificationMessages

Valor de propiedad

Comentarios

Ejemplos

sender

Valor de propiedad

Comentarios

Ejemplos

start

Valor de propiedad

Comentarios

Ejemplos

subject

Valor de propiedad

Comentarios

Ejemplos

to

Valor de propiedad

Comentarios