Nota:
El acceso a esta página requiere autorización. Puede intentar iniciar sesión o cambiar directorios.
El acceso a esta página requiere autorización. Puede intentar cambiar los directorios.
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. La API de JavaScript 1.1 de Outlook (buzón 1.1) es la primera versión de la API.
Nota:
Esta documentación es para un conjunto de requisitos que no sea el último conjunto de requisitos.
Novedades de 1.1
El conjunto de requisitos de buzón 1.1 incluye todos los conjuntos de requisitos de API comunes admitidos en Outlook. Se han agregado las siguientes características.
Se han agregado métodos para obtener o establecer el cuerpo de mensajes y citas. Para obtener más información, consulte Obtener o establecer el cuerpo de un mensaje o una cita en Outlook.
Se han agregado métodos para agregar, obtener y quitar datos adjuntos de mensajes y citas que se están redactando. Para obtener más información, vea Administrar los datos adjuntos de un elemento en un formulario de redacción en Outlook.
Se han agregado métodos para obtener o establecer el asunto de los mensajes y citas que se están redactando. Para obtener más información, consulte Obtener o establecer el asunto al redactar una cita o un mensaje en Outlook.
Se han agregado métodos para obtener o establecer la ubicación de las citas que se están redactando. Para obtener más información, consulte Obtener o establecer la ubicación al redactar una cita en Outlook.
Se han agregado métodos para obtener o establecer la hora de inicio y la hora de finalización de las citas que se están redactando. Para obtener más información, vea Obtener o establecer la hora al redactar una cita en Outlook.
Se han agregado métodos para obtener o establecer los destinatarios (Para, CC, CCO) de los mensajes que se están redactando. Para obtener más información, consulte Obtener, establecer o agregar destinatarios a una cita o mensaje en Outlook.
Se han agregado métodos para mostrar formularios de respuesta y nuevos formularios de citas.
Se han agregado métodos para mostrar mensajes y citas existentes.
Se ha agregado la capacidad de realizar solicitudes de servicios Web Exchange (EWS) directamente desde un complemento.
Importante
Los tokens de identidad de usuario y los tokens de devolución de llamada de Exchange Online heredados ya no se admiten y están desactivados en todos los inquilinos de Microsoft 365. Si un complemento de Outlook requiere acceso de usuario delegado o identidad de usuario, se recomienda usar MSAL (Biblioteca de autenticación de Microsoft) y la autenticación de aplicaciones anidadas (NAA). Los tokens de identidad de usuario de Exchange aún se admiten para Exchange local.
Se ha agregado compatibilidad con propiedades personalizadas y configuración de itinerancia para almacenar datos de complementos. Para obtener más información, vea Obtener y establecer metadatos de complemento para un complemento de Outlook.
Se han agregado métodos para detectar y extraer entidades (como direcciones, números de teléfono y direcciones URL) de los cuerpos de los elementos.
Importante
Los complementos contextuales de Outlook basados en entidades han sido retirados. Como solución alternativa, implemente reglas de expresión regular en el complemento contextual. Para obtener instrucciones sobre cómo implementar estas reglas, vea Complementos contextuales de Outlook.
Lista de API
En la tabla siguiente se enumeran las API introducidas en el conjunto de requisitos de buzón 1.1. Para ver la documentación de referencia de API para todas las API admitidas por el conjunto de requisitos de buzón 1.1, consulte API de Outlook.
| Clase | Campos | Descripción |
|---|---|---|
| AppointmentCompose | addFileAttachmentAsync(uri: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void) | Agrega un archivo a un mensaje o cita como datos adjuntos. |
| addFileAttachmentAsync(uri: string, attachmentName: string, options: Office.AsyncContextOptions & { isInline: boolean }, callback?: (asyncResult: Office.AsyncResult<string>) => void) | Agrega un archivo a un mensaje o cita como datos adjuntos. | |
| addItemAttachmentAsync(itemId: any, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void) | Agrega un elemento de Exchange (por ejemplo, un mensaje) como datos adjuntos al mensaje o a la cita. | |
| addItemAttachmentAsync(itemId: any, attachmentName: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<string>) => void) | Agrega un elemento de Exchange (por ejemplo, un mensaje) como datos adjuntos al mensaje o a la cita. | |
| body | Obtiene un objeto que proporciona métodos para manipular el cuerpo de un elemento. | |
| 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 o establece la ubicación de una cita. | |
| removeAttachmentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Quita los datos adjuntos de un mensaje o cita. | |
| removeAttachmentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Quita los datos adjuntos de un mensaje o cita. | |
| Formulario de cita | body | Establece el cuerpo de la cita. |
| end | Establece la fecha y la hora en que finalizará la cita. | |
| location | Establece la ubicación de la cita. | |
| optionalAttendees | Establece los asistentes opcionales de la cita. | |
| requiredAttendees | Establece los asistentes necesarios para la cita. | |
| resources | Establece los recursos de la cita. | |
| start | Establece la fecha y la hora en que comenzará la cita. | |
| subject | Establece la descripción que aparece en el campo Título de la cita. | |
| AppointmentRead | body | Obtiene un objeto que proporciona métodos para manipular el cuerpo de un elemento. |
| dateTimeModified | Obtiene la fecha y hora en que se modificó por última vez un elemento. | |
| displayReplyAllForm(formData: string | ReplyFormData) | Muestra un formulario de respuesta que incluye al remitente y todos los destinatarios del mensaje seleccionado, o al organizador y todos los asistentes del | |
| displayReplyForm(formData: string | ReplyFormData) | 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: MailboxEnums.EntityType | string) | Obtiene una matriz de todas las entidades del tipo de entidad especificado encontrado en el cuerpo del elemento seleccionado. | |
| getFilteredEntitiesByName(name: string) | Devuelve entidades conocidas en el elemento seleccionado que pasan el filtro con nombre definido en un archivo de manifiesto sólo de complemento. | |
| getRegExMatches() | Devuelve valores de cadena en el elemento seleccionado que coincidan con las expresiones regulares definidas en un archivo de manifiesto solo de complemento. | |
| 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 solo de complemento. | |
| 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 cita. | |
| AttachmentDetails | attachmentType | Obtiene un valor que indica el tipo de datos adjuntos. |
| contentType | Obtiene el tipo de contenido MIME de los datos adjuntos. | |
| id | Obtiene el identificador de datos de adjuntos de Exchange de los datos adjuntos. | |
| isInline | Obtiene un valor que indica si los datos adjuntos aparecen como una imagen en el cuerpo del elemento en lugar de en la lista de datos adjuntos. | |
| name | Obtiene el nombre de los datos adjuntos | |
| size | Obtiene el tamaño de los datos adjuntos en bytes. | |
| Cuerpo | getTypeAsync(callback?: (asyncResult: Office.AsyncResult<Office.CoercionType>) => void) | Obtiene un valor que indica si el contenido tiene formato de texto o HTML. |
| getTypeAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<Office.CoercionType>) => void) | Obtiene un valor que indica si el contenido tiene formato de texto o HTML. | |
| prependAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Agrega el contenido especificado al principio del cuerpo del elemento. | |
| prependAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Agrega el contenido especificado al principio del cuerpo del elemento. | |
| setSelectedDataAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Reemplaza la selección que se ha realizado en el cuerpo por el texto especificado. | |
| setSelectedDataAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Reemplaza la selección que se ha realizado en el cuerpo por el texto especificado. | |
| CustomProperties | get(nombre: cadena) | Devuelve el valor de la propiedad personalizada especificada. |
| eliminar(nombre: cadena) | Elimina la propiedad especificada de la colección de propiedades personalizadas. | |
| saveAsync(asyncContext?: any) | Guarda las propiedades personalizadas en un mensaje o cita. | |
| saveAsync(callback: (asyncResult: Office.AsyncResult<void>) => void, asyncContext?: any) | Guarda las propiedades personalizadas en un mensaje o cita. | |
| set(name: string, value: string) | Configura la propiedad especificada al valor especificado. | |
| Diagnóstico | OWAView | Obtiene una cadena que representa la vista actual de Outlook en la Web. |
| hostName | Obtiene una cadena que representa el tipo de cliente de Outlook. | |
| hostVersion | Obtiene una cadena que representa la versión del cliente de Outlook o de Exchange Server (por ejemplo, "15.0.468.0"). | |
| Ubicación | getAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) | Obtiene la ubicación de una cita. |
| getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void) | Obtiene la ubicación de una cita. | |
| setAsync(location: string, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Establece la ubicación de una cita. | |
| setAsync(location: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Establece la ubicación de una cita. | |
| Buzón | displayAppointmentForm(itemId: string) | Muestra una cita de calendario existente. |
| displayMessageForm(itemId: string) | Muestra un mensaje existente. | |
| displayNewAppointmentForm(parameters: AppointmentForm) | Muestra un formulario para crear una cita de calendario. | |
| ewsUrl | Obtiene la dirección URL del punto de conexión de Servicios Web Exchange (EWS) para esta cuenta de correo electrónico. | |
| makeEwsRequestAsync(data: any, callback: (asyncResult: Office.AsyncResult<string>) => void, userContext?: any) | Realiza una solicitud asincrónica a un servicio de servicios Web Exchange (EWS) en el servidor de Exchange que hospeda el buzón del usuario. | |
| MessageCompose | addFileAttachmentAsync(uri: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void) | Agrega un archivo a un mensaje o cita como datos adjuntos. |
| addFileAttachmentAsync(uri: string, attachmentName: string, options: Office.AsyncContextOptions & { isInline: boolean }, callback?: (asyncResult: Office.AsyncResult<string>) => void) | Agrega un archivo a un mensaje o cita como datos adjuntos. | |
| addItemAttachmentAsync(itemId: any, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void) | Agrega un elemento de Exchange (por ejemplo, un mensaje) como datos adjuntos al mensaje o a la cita. | |
| addItemAttachmentAsync(itemId: any, attachmentName: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<string>) => void) | Agrega un elemento de Exchange (por ejemplo, un mensaje) como datos adjuntos al mensaje o a la cita. | |
| bcc | Obtiene un objeto que proporciona métodos para obtener o actualizar los destinatarios en la línea de CCO (copia carbón oculta) de un mensaje. | |
| body | Obtiene un objeto que proporciona métodos para manipular el cuerpo de un elemento. | |
| loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult<CustomProperties>) => void, userContext?: any) | Carga de forma asincrónica las propiedades personalizadas de este complemento en el elemento seleccionado. | |
| removeAttachmentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Quita los datos adjuntos de un mensaje o cita. | |
| removeAttachmentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Quita los datos adjuntos de un mensaje o cita. | |
| MessageRead | body | Obtiene un objeto que proporciona métodos para manipular el cuerpo de un elemento. |
| dateTimeModified | Obtiene la fecha y hora en que se modificó por última vez un elemento. | |
| displayReplyAllForm(formData: string | ReplyFormData) | Muestra un formulario de respuesta que incluye al remitente y todos los destinatarios del mensaje seleccionado, o al organizador y todos los asistentes del | |
| displayReplyForm(formData: string | ReplyFormData) | 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: MailboxEnums.EntityType | string) | Obtiene una matriz de todas las entidades del tipo de entidad especificado encontrado en el cuerpo del elemento seleccionado. | |
| getFilteredEntitiesByName(name: string) | Devuelve entidades conocidas en el elemento seleccionado que pasan el filtro con nombre definido en un archivo de manifiesto sólo de complemento. | |
| getRegExMatches() | Devuelve valores de cadena en el elemento seleccionado que coincidan con las expresiones regulares definidas en un archivo de manifiesto solo de complemento. | |
| 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 solo de complemento. | |
| loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult<CustomProperties>) => void, userContext?: any) | Carga de forma asincrónica las propiedades personalizadas de este complemento en el elemento seleccionado. | |
| AttachmentType | Nube | Los datos adjuntos se almacenan en una ubicación en la nube, como OneDrive. |
| Archivo | Los datos adjuntos son un archivo. | |
| Elemento | Los datos adjuntos son un elemento de Exchange. | |
| RecipientType | DistributionList | Especifica que el destinatario es una lista de distribución que contiene una lista de direcciones de correo electrónico. |
| Usuario externo | Especifica que el destinatario es una dirección de correo electrónico SMTP que no está en el servidor de Exchange. | |
| Otros | Especifica que el destinatario no es uno de los otros tipos de destinatarios. | |
| Usuario | Especifica que el destinatario es una dirección de correo electrónico SMTP del servidor de Exchange. | |
| Destinatarios | addAsync(recipients: Array<string | EmailUser | EmailAddressDetails>, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Agrega una lista de destinatarios a los destinatarios existentes de un mensaje o una cita. |
| addAsync(recipients: Array<string | EmailUser | EmailAddressDetails>, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Agrega una lista de destinatarios a los destinatarios existentes de un mensaje o una cita. | |
| getAsync(callback: (asyncResult: Office.AsyncResult<EmailAddressDetails[]>) => void) | Obtiene una lista de destinatarios para un mensaje o una cita. | |
| getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<EmailAddressDetails[]>) => void) | Obtiene una lista de destinatarios para un mensaje o una cita. | |
| setAsync(recipients: Array<string | EmailUser | EmailAddressDetails>, devolución de llamada: (asyncResult: Office.AsyncResult<void>) => void) | Establece una lista de destinatarios para una cita o un mensaje. | |
| setAsync(recipients: Array<string | EmailUser | EmailAddressDetails>, opciones: Office.AsyncContextOptions, devolución de llamada: (asyncResult: Office.AsyncResult<anulado>) => anulado) | Establece una lista de destinatarios para una cita o un mensaje. | |
| ReplyFormAttachment | En línea | Si es verdadero, indica que los datos adjuntos se mostrarán en línea en el cuerpo del mensaje y no deberían mostrarse en la lista de datos adjuntos. |
| itemId | El identificador de elemento de EWS de los datos adjuntos. | |
| name | Una cadena que contiene el nombre de los datos adjuntos, hasta 255 caracteres de longitud. | |
| type | Indica el tipo de datos adjuntos. | |
| url | El URI de la ubicación del archivo. | |
| ReplyFormData | callback | Cuando se completa la llamada de visualización de respuesta, se llama a la función pasada en el parámetro de devolución de llamada con un solo parámetro, |
| htmlBody | Una cadena que contiene texto y HTML y que representa el cuerpo del formulario de respuestas. | |
| options | Un literal de objeto que contiene la asyncContext propiedad. |
|
| RoamingSettings | get(nombre: cadena) | Recupera la configuración especificada. |
| eliminar(nombre: cadena) | Elimina la configuración especificada. | |
| saveAsync(callback?: (asyncResult: Office.AsyncResult<void>) => void) | Guarda la configuración. | |
| set(name: string, value: any) | Define o crea la configuración especificada. | |
| Asunto | getAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) | Obtiene el asunto de una cita o un mensaje. |
| getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void) | Obtiene el asunto de una cita o un mensaje. | |
| setAsync(subject: string, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Establece el asunto de una cita o un mensaje. | |
| setAsync(subject: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Establece el asunto de una cita o un mensaje. | |
| Time | getAsync(callback: (asyncResult: Office.AsyncResult<Date>) => void) | Obtiene la hora de inicio o finalización de una cita. |
| getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<Date>) => void) | Obtiene la hora de inicio o finalización de una cita. | |
| setAsync(dateTime: Date, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Establece la hora de inicio o finalización de una cita. | |
| setAsync(dateTime: Date, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Establece la hora de inicio o finalización de una cita. |
Vea también
Colaborar con nosotros en GitHub
El origen de este contenido se puede encontrar en GitHub, donde también puede crear y revisar problemas y solicitudes de incorporación de cambios. Para más información, consulte nuestra guía para colaboradores.