Conjunto de requisitos de API de complemento de Outlook 1.15

El subconjunto de API de complementos de Outlook de la API de JavaScript de Office incluye objetos, métodos, propiedades y eventos que puede usar en un complemento de Outlook.

Nota:

Esta documentación es para un conjunto de requisitos que no sea el último conjunto de requisitos.

Novedades de la versión 1.15

El conjunto de requisitos de buzón 1.15 incluye todas las características del conjunto de requisitos 1.14. Se han agregado las siguientes características.

Lista de API

En la tabla siguiente se enumeran las API introducidas en el conjunto de requisitos de buzón 1.15. Para ver la documentación de referencia de API de todas las API compatibles con el conjunto de requisitos de buzón 1.15 o versiones anteriores, consulte API de Outlook.

Clase Campos Descripción
AppointmentCompose sendAsync(callback?: (asyncResult: Office.AsyncResult<void>) => void) Envía la cita que se está redactando.
sendAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Envía la cita que se está redactando.
InitializationContextChangedEventArgs initializationContextData Representa los datos que se van a pasar al panel de tareas de un complemento desde un mensaje accionable, un mensaje de notificación, un cuadro de diálogo de alertas inteligentes o un cuadro de diálogo integrado
type Indica el tipo del evento.
LoadedMessageCompose bcc Obtiene los destinatarios en la línea CCO (copia carbón oculta) de un mensaje.
body Obtiene el cuerpo y el formato del artículo.
categorías Obtiene un objeto que proporciona métodos para administrar las categorías del elemento.
cc Obtiene destinatarios en la línea Cc (copia de carbón) de un mensaje.
conversationId Obtiene un identificador de la conversación de correo electrónico que contiene un mensaje determinado.
delayDeliveryTime Obtiene la fecha y hora de entrega retrasadas de un mensaje.
from Obtiene la dirección de correo electrónico del remitente de un mensaje.
getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void) Obtiene un archivo adjunto de un mensaje o cita y lo devuelve como un AttachmentContent objeto.
getAttachmentContentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void) Obtiene un archivo adjunto de un mensaje o cita y lo devuelve como un AttachmentContent objeto.
getAttachmentsAsync(callback?: (asyncResult: Office.AsyncResult<AttachmentDetailsCompose[]>) => void) Obtiene los datos adjuntos del elemento como una matriz.
getAttachmentsAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<AttachmentDetailsCompose[]>) => void) Obtiene los datos adjuntos del elemento como una matriz.
getComposeTypeAsync(callback: (asyncResult: Office.AsyncResult) => void) Especifica el tipo de mensaje redactado y su tipo de coerción.
getComposeTypeAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void) Especifica el tipo de mensaje redactado y su tipo de coerción.
getConversationIndexAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) Obtiene la posición codificada en base64 del mensaje actual en una conversación.
getConversationIndexAsync(opciones: Office.AsyncContextOptions, devolución de llamada: (asyncResult: cadena> Office.AsyncResult<) => void) Obtiene la posición codificada en base64 del mensaje actual en una conversación.
getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) Obtiene los datos de inicialización pasados cuando el complemento se activa mediante un mensaje accionable.
getInitializationContextAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void) Obtiene los datos de inicialización pasados cuando el complemento se activa mediante un mensaje accionable.
getItemClassAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) Obtiene la clase de elemento servicios Web Exchange del mensaje seleccionado.
getItemClassAsync(options: Office.AsyncContextOptions, callback: (asyncResult: cadena> Office.AsyncResult<) => void) Obtiene la clase de elemento servicios Web Exchange del mensaje seleccionado.
getItemIdAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) Obtiene de forma asincrónica el id. de un elemento guardado.
getItemIdAsync(options: Office.AsyncContextOptions, callback: (asyncResult: cadena> Office.AsyncResult<) => void) Obtiene de forma asincrónica el identificador de elemento de los servicios Web Exchange (EWS)
getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void) Obtiene las propiedades de una cita o un mensaje en una carpeta compartida o un buzón compartido.
getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void) Obtiene las propiedades de una cita o un mensaje en una carpeta compartida o un buzón compartido.
inReplyTo Obtiene el Id. del mensaje original al que responde el mensaje actual.
internetHeaders Obtiene los encabezados personalizados de Internet de un mensaje.
isClientSignatureEnabledAsync(callback: (asyncResult: Office.AsyncResult<boolean>) => void) Obtiene si la firma del cliente está habilitada.
isClientSignatureEnabledAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<boolean>) => void) Obtiene si la firma del cliente está habilitada.
itemType Obtiene el tipo de elemento que representa una instancia.
loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult<CustomProperties>) => void, userContext?: any) Carga de forma asincrónica las propiedades personalizadas de este complemento en el elemento seleccionado.
notificationMessages Obtiene los mensajes de notificación del elemento.
saveAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) Guarda de forma asincrónica el mensaje actual como borrador.
saveAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void) Guarda de forma asincrónica el mensaje actual como borrador.
etiqueta de confidencialidad Obtiene la etiqueta de confidencialidad de un mensaje.
seriesId Obtiene el identificador de la serie a la que pertenece una instancia.
subject Obtiene la descripción que aparece en el campo Asunto de un elemento.
to Obtiene los destinatarios en la línea Para de un mensaje.
unloadAsync(callback?: (asyncResult: Office.AsyncResult<void>) => void) Cuando se seleccionan varios elementos de correo, se cierra el elemento cargado para que se pueda cargar otro elemento de correo seleccionado para su procesamiento.
unloadAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Cuando se seleccionan varios elementos de correo, se cierra el elemento cargado para que se pueda cargar otro elemento de correo seleccionado para su procesamiento.
LoadedMessageRead attachments Obtiene los datos adjuntos del elemento como una matriz.
body Obtiene el cuerpo del artículo y su formato.
categorías Obtiene un objeto que proporciona métodos para administrar las categorías del elemento.
cc Obtiene destinatarios en la línea Cc (copia de carbón) de un mensaje.
conversationId Obtiene un identificador de la conversación de correo electrónico que contiene un mensaje determinado.
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.
displayReplyAllFormAsync(formData: string | ReplyFormData, ¿devolución de llamada?: (asyncResult: Office.AsyncResult<void>) => void) Muestra un formulario de respuesta que incluye al remitente y todos los destinatarios del mensaje seleccionado, o al organizador y todos los asistentes del
displayReplyAllFormAsync(formData: string | ReplyFormData, opciones: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Muestra un formulario de respuesta que incluye al remitente y todos los destinatarios del mensaje seleccionado, o al organizador y todos los asistentes del
displayReplyFormAsync(formData: string | ReplyFormData, ¿devolución de llamada?: (asyncResult: Office.AsyncResult<void>) => void) Muestra un formulario de respuesta que incluye solo el remitente del mensaje seleccionado o el organizador de la cita seleccionada.
displayReplyFormAsync(formData: string | ReplyFormData, opciones: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Muestra un formulario de respuesta que incluye solo el remitente del mensaje seleccionado o el organizador de la cita seleccionada.
end Obtiene la fecha y la hora en que finalizará la cita.
from Obtiene la dirección de correo electrónico del remitente de un mensaje.
getAllInternetHeadersAsync(callback?: (asyncResult: Office.AsyncResult<string>) => void) Obtiene todos los encabezados de Internet del mensaje como una cadena.
getAllInternetHeadersAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<string>) => void) Obtiene todos los encabezados de Internet del mensaje como una cadena.
getAsFileAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) Obtiene el mensaje actual en formato EML codificado en base64.
getAsFileAsync(options: Office.AsyncContextOptions, callback: (asyncResult: cadena> Office.AsyncResult<) => void) Obtiene el mensaje actual en formato EML codificado en base64.
getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void) Obtiene un archivo adjunto de un mensaje o cita y lo devuelve como un AttachmentContent objeto.
getAttachmentContentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void) Obtiene un archivo adjunto de un mensaje o cita y lo devuelve como un AttachmentContent objeto.
getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) Obtiene los datos de inicialización pasados cuando el complemento se activa mediante un mensaje accionable.
getInitializationContextAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void) Obtiene los datos de inicialización pasados cuando el complemento se activa mediante un mensaje accionable.
getRegExMatches() Devuelve valores de cadena en el elemento seleccionado que coincidan con las expresiones regulares definidas en un archivo de manifiesto XML.
getRegExMatchesByName(name: string) Devuelve valores de cadena en el elemento seleccionado que coinciden con la expresión regular con nombre definida en un archivo de manifiesto XML.
getSelectedRegExMatches() Devuelve valores de cadena en una coincidencia resaltada que coinciden con las expresiones regulares definidas en un archivo de manifiesto XML.
getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void) Obtiene las propiedades de una cita o un mensaje en una carpeta compartida o un buzón compartido.
getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void) Obtiene las propiedades de una cita o un mensaje en una carpeta compartida o un buzón compartido.
internetMessageId Obtiene el identificador de mensaje de Internet de un mensaje.
itemClass Obtiene la clase de elemento servicios Web Exchange del mensaje seleccionado.
itemId Obtiene el identificador de elemento de servicios Web Exchange
itemType Obtiene el tipo de elemento que representa una instancia.
loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult<CustomProperties>) => void, userContext?: any) Carga de forma asincrónica las propiedades personalizadas de este complemento en el elemento seleccionado.
location Obtiene la ubicación de una convocatoria de reunión.
normalizedSubject Obtiene el asunto de un elemento, con todos los prefijos eliminados (incluidos RE: y FWD:).
notificationMessages Obtiene los mensajes de notificación del elemento.
recurrencia Obtiene el patrón de recurrencia de una cita.
sender Obtiene la dirección de correo electrónico del remitente de un mensaje de correo electrónico.
seriesId Obtiene el identificador de la serie a la que pertenece una instancia.
start Obtiene la fecha y la hora en que comenzará la cita.
subject Obtiene la descripción que aparece en el campo Asunto de un elemento.
to Obtiene los destinatarios en la línea Para de un mensaje.
unloadAsync(callback?: (asyncResult: Office.AsyncResult<void>) => void) Cuando se seleccionan varios elementos de correo, se cierra el elemento cargado para que se pueda cargar otro elemento de correo seleccionado para su procesamiento.
unloadAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Cuando se seleccionan varios elementos de correo, se cierra el elemento cargado para que se pueda cargar otro elemento de correo seleccionado para su procesamiento.
Buzón loadItemByIdAsync(itemId: string, callback: (asyncResult: Office.AsyncResult<LoadedMessageCompose | LoadedMessageRead>) => void) Carga un solo elemento de correo por su Id. de servicios Web Exchange (EWS).
loadItemByIdAsync(itemId: string, options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<LoadedMessageCompose | LoadedMessageRead>) => void) Carga un solo elemento de correo por su Id. de servicios Web Exchange (EWS).
MessageCompose sendAsync(callback?: (asyncResult: Office.AsyncResult<void>) => void) Envía el mensaje que se está redactando.
sendAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Envía el mensaje que se está redactando.
AttachmentType Base 64 El adjunto es un archivo codificado en Base64.
ReplyFormAttachment archivo base64 La cadena codificada en base64 del archivo que se va a adjuntar.
SmartAlertsEventCompletedOptions errorMessageMarkdown Cuando utiliza el método completed para señalar la finalización de un controlador de eventos
SpamReportingEventCompletedOptions commandId Cuando utilice el método completed para indicar que un mensaje notificado ha terminado de procesarse,
datos de contexto Cuando utilice el método completed para indicar que un mensaje notificado ha terminado de procesarse,

Eventos

En la tabla siguiente se enumeran los eventos introducidos en el conjunto de requisitos 1.15. Para obtener una lista de todos los eventos admitidos que se pueden controlar con los addHandlerAsync métodos and removeHandlerAsync , vea Office.EventType.

Evento Descripción Object
InitializationContextChanged El panel de tareas de un complemento se ha abierto desde un mensaje accionable, InsightMessage una notificación, un cuadro de diálogo de alertas inteligentes o un cuadro de diálogo integrado de informes de spam. Elemento

Nota:

Para los eventos compatibles con un complemento de activación basada en eventos, vea Activar complementos con eventos.

Actualizaciones de manifiestos

En la tabla siguiente se enumeran las actualizaciones de manifiestos introducidas en el conjunto de requisitos de buzón 1.15. Para obtener más información sobre los tipos de manifiestos de complementos de Office, vea Manifiesto de complementos de Office.

Característica Manifiesto unificado para Microsoft 365 Manifiesto de solo complemento Descripción
Informes sobre el correo no deseado "extensions.ribbons.spamPreProcessingDialog.spamReportingOptions.type" ReportingOptions Se ha agregado compatibilidad con botones de radio en el cuadro de diálogo de preprocesamiento de un complemento integrado de informes de spam.
Informes sobre el correo no deseado "extensions.ribbons.spamPreProcessingDialog.spamNeverShowAgainOption" PreProcessingDialog Se ha agregado compatibilidad con la casilla "No volver a mostrar este mensaje" en el cuadro de diálogo de preprocesamiento de un complemento integrado de informes de spam.

Vea también

  • Last updated on