Conjuntos de requisitos de la API de JavaScript de Outlook

Los complementos de Outlook declaran qué versiones de API necesitan en su manifiesto. El marcado varía en función de si usa el formato de manifiesto de solo complemento o el manifiesto unificado para Microsoft 365.

"extensions": [
{
  "requirements": {
    "capabilities": [
      {
        "name": "Mailbox", "minVersion": "1.1"
      }
    ]
  },
  ...
}

<Requirements>
  <Sets>
    <Set Name="Mailbox" MinVersion="1.1" />
  </Sets>
</Requirements>

Todas las API de Outlook pertenecen al conjunto de Mailboxrequisitos. El conjunto de requisitos Mailbox tiene versiones y cada nuevo conjunto de API que publicamos pertenece a una versión posterior del conjunto. No todos los clientes de Outlook admiten el conjunto más reciente de API, pero si un cliente de Outlook declara compatibilidad con un conjunto de requisitos, por lo general admite todas las API de ese conjunto de requisitos (consulte la documentación de una API o característica específica para ver si hay excepciones).

Establecer una versión mínima del conjunto de requisitos en los controles de manifiesto en los que el cliente de Outlook aparecerá el complemento. Si un cliente no admite el conjunto de requisitos mínimos, no carga el complemento. Por ejemplo, si se especifica la versión 1.3 del conjunto de requisitos, esto significa que el complemento no se mostrará en ningún cliente de Outlook que no admita al menos la versión 1.3.

Uso de API de conjuntos de requisitos posteriores

Establecer un conjunto de requisitos no limita las API disponibles que el complemento puede usar. Por ejemplo, si el complemento especifica el conjunto de requisitos "Buzón 1.1", pero se ejecuta en un cliente de Outlook que admite "Buzón 1.3", el complemento puede usar las API del conjunto de requisitos "Buzón 1.3".

Para usar una API más reciente, los desarrolladores pueden comprobar si una aplicación en concreto es compatible con el conjunto de requisitos mediante las siguientes acciones:

if (Office.context.requirements.isSetSupported('Mailbox', '1.3')) {
  // Perform actions.
}
else {
  // Provide alternate flow/logic.
}

Como alternativa, los desarrolladores pueden comprobar si existe una nueva API con la técnica estándar de JavaScript.

if (item.somePropertyOrMethod !== undefined) {
  // Use item.somePropertyOrMethod.
  item.somePropertyOrMethod;
}

Dichos controles no son necesarios para ninguna API que esté presente en la versión del conjunto de requisitos especificada en el manifiesto.

Elección de un conjunto de requisitos mínimos

Los desarrolladores deben usar el conjunto de requisitos más antiguo que contenga el conjunto fundamental de las API para su escenario, sin el que no funcionará el complemento.

Conjuntos de requisitos admitidos por los servidores de Exchange y los clientes de Outlook

En esta sección, se indica el rango de los conjuntos de requisitos admitidos por los clientes de Exchange Server y Outlook. Para obtener más información sobre los requisitos de servidor y cliente para ejecutar los complementos de Outlook, consulte Requisitos de complementos de Outlook.

Soporte técnico de Exchange Server

Los siguientes servidores admiten complementos de Outlook.

Compatibilidad con el cliente de Outlook

Los complementos son compatibles con Outlook en las siguientes plataformas.

Compatibilidad con versiones para conjuntos de requisitos en Outlook clásico en Windows

En la tabla siguiente se muestra la compatibilidad con versiones para conjuntos de requisitos de buzón más recientes en Outlook clásico en Windows con una suscripción de Microsoft 365 o una licencia perpetua comercial.

Para obtener más información sobre la versión de cliente, vea la página historial de actualizaciones de Microsoft 365 u Office 2024 y cómo buscar la versión del cliente de Office y el canal de actualización.

Referencia a la biblioteca de producción de la API de JavaScript de Office

Para usar las API en cualquiera de los conjuntos de requisitos numerados, debe hacer referencia a la biblioteca de producción en la red de entrega de contenido (CDN) de Office.js. Para obtener información sobre cómo usar las API de versión preliminar, consulte Probar API de versión preliminar.

Api de versión preliminar de prueba

Las nuevas API de JavaScript de Outlook primero se presentan en "versión preliminar" y, luego, pasan a formar parte de un conjunto de requisitos numerados específico después de que se realicen suficientes pruebas y se adquieran suficientes comentarios de los usuarios. Para proporcionar comentarios sobre una API en versión preliminar, use el mecanismo de comentarios al final de la página web donde se proporciona documentación para la API.

Para más información sobre las API en versión preliminar, vea Conjunto de requisitos para la versión preliminar de la API de Outlook.