Observação
O acesso a essa página exige autorização. Você pode tentar entrar ou alterar diretórios.
O acesso a essa página exige autorização. Você pode tentar alterar os diretórios.
Os suplementos do Outlook declaram quais versões de API eles exigem em seu manifesto. A marcação varia dependendo se você está usando o formato de manifesto somente suplemento ou o manifesto unificado para Microsoft 365.
A versão da API é especificada pela propriedade "extensions.requirements.capabilities". Defina a propriedade "capabilities.name" como "Caixa de Correio" e a propriedade "capabilities.minVersion" como o conjunto mínimo de requisitos de API que dá suporte aos cenários do suplemento.
Por exemplo, o trecho de código de manifesto a seguir indica um conjunto mínimo de requisitos de 1.1.
"extensions": [
{
"requirements": {
"capabilities": [
{
"name": "Mailbox", "minVersion": "1.1"
}
]
},
...
}
Todas as APIs do Outlook pertencem ao Mailboxconjunto de requisitos. O conjunto de requisitos Mailbox tem versões, e cada novo conjunto de APIs que lançamos pertence a uma versão superior. Nem todos os clientes do Outlook são compatíveis com o conjunto mais recente de APIs, mas se um cliente Outlook declara suporte para um conjunto de requisitos, geralmente ele dá suporte a todas as APIs nesse conjunto de requisitos (Marque a documentação de uma API ou recurso específico para ver se há exceções).
O conjunto de requisitos mínimos especificado no manifesto determina quais clientes do Outlook podem carregar o suplemento. Se o cliente Outlook não der suporte pelo menos à versão especificada, o suplemento não será carregado. Por exemplo, se você especificar a versão do conjunto de requisitos como 1.3, o suplemento só aparecerá em clientes do Outlook que dão suporte à versão 1.3 ou superior.
Observação
Embora o Outlook no Android e no iOS dê suporte até o conjunto de requisitos 1.5, seu suplemento móvel agora pode implementar algumas APIs de conjuntos de requisitos posteriores. Para obter mais informações sobre quais APIs são suportadas no Outlook mobile, consulte APIs JavaScript do Outlook suportadas no Outlook em dispositivos móveis.
Usar APIs de conjuntos de requisitos posteriores
A definição de um conjunto de requisitos não limita as APIs disponíveis que o suplemento pode usar. Por exemplo, se o suplemento especificar o conjunto de requisitos "Caixa de Correio 1.1", mas estiver em execução em um cliente Outlook que dê suporte a "Caixa de Correio 1.3", o suplemento poderá usar APIs do conjunto de requisitos "Caixa de Correio 1.3".
Para usar uma API mais recente, os desenvolvedores podem verificar se um determinado aplicativo oferece suporte ao conjunto de requisitos fazendo o seguinte:
if (Office.context.requirements.isSetSupported('Mailbox', '1.3')) {
// Perform actions.
}
else {
// Provide alternate flow/logic.
}
Como alternativa, os desenvolvedores podem verificar a existência de uma API mais recente usando a técnica JavaScript padrão.
if (item.somePropertyOrMethod !== undefined) {
// Use item.somePropertyOrMethod.
item.somePropertyOrMethod;
}
Nenhuma verificação desse tipo é necessária para qualquer API que esteja presente na versão do conjunto de requisitos especificada no manifesto.
Escolha um conjunto de requisitos mínimos
Os desenvolvedores devem usar o conjunto de requisitos mínimos que contém o conjunto essencial de APIs para seu cenário, sem o qual o suplemento não funcionará.
Conjuntos de requisitos suportados pelos Exchange Servers e clientes do Outlook
Nesta seção, vemos a gama de conjuntos de requisitos com suporte do Exchange Server e clientes do Outlook. Para obter detalhes sobre os requisitos de cliente e servidor para executar suplementos do Outlook, confira requisitos dos suplementos do Outlook.
Importante
Se o servidor Exchange de destino e o cliente do Outlook suportarem conjuntos de requisitos diferentes, então você estará restrito ao intervalo de conjunto de requisitos mais baixo. Por exemplo, se um suplemento estiver sendo executado no Outlook 2019 no Windows (maior requisito definido: 1.6) em relação ao Exchange 2016 (maior requisito definido: 1.5), seu suplemento pode estar limitado ao conjunto de requisitos 1.5.
Suporte do Exchange Server
A tabela a seguir lista os servidores Exchange e os conjuntos de requisitos de Caixa de Correio aos quais eles dão suporte. Para que seu suplemento apareça no Outlook hospedado em um ambiente específico do Exchange, a versão especificada como o requisito mínimo definido no manifesto do suplemento deve ser compatível com esse ambiente.
| Produto | Versão Principal do Exchange | Conjuntos de requisitos de API com suporte |
|---|---|---|
| Exchange Online | Versão mais recente |
1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.7, 1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 1.14, 1.15, 1.16 IdentityAPI 1.31 |
| Exchange local | Edição de Assinatura (SE) | 1.1, 1.2, 1.3, 1.4, 1.5 |
| 2019 | 1.1, 1.2, 1.3, 1.4, 1.5 | |
| 2016 | 1.1, 1.2, 1.3, 1.4, 1.5 |
1 Para exigir o conjunto de APIs de identidade 1.3 no código de suplemento do Outlook, Marque se ele tem suporte chamando
isSetSupported('IdentityAPI', '1.3'). Não é permitido declará-lo no manifesto do suplemento do Outlook. Você também pode determinar se a API tem suporte, verificando se ela não éundefined. Para mais detalhes, confira Usar APIs de conjuntos de requisitos posteriores.
Mesmo que um suplemento implemente recursos de conjuntos de requisitos posteriores sem suporte em um ambiente local do Exchange, ele ainda poderá ser adicionado a um cliente Outlook, desde que o conjunto de requisitos mínimos especificado em seu manifesto esteja alinhado com aqueles compatíveis com o Exchange local. No entanto, um recurso implementado só funcionará se o cliente Outlook no qual o suplemento está instalado der suporte ao conjunto de requisitos mínimos necessários para um recurso. Por exemplo, um suplemento de assinatura que especifica 1.5 em seu manifesto será instalado e carregado no ambiente local do Exchange 2019. No entanto, sua chamada para Body.setSignatureAsync, que foi introduzida no conjunto de requisitos 1.10, só será executada se o cliente Outlook em que o suplemento está instalado der suporte à versão 1.10.
Para determinar os conjuntos de requisitos compatíveis com diferentes clientes do Outlook, consulte Suporte ao cliente Outlook. Recomendamos complementar isso com a documentação sobre o recurso específico para quaisquer exceções.
Suporte a cliente Outlook
Os suplementos são compatíveis com o Outlook nas seguintes plataformas.
1 Não há suporte para suplementos no Outlook no Android, no iOS e na Web móvel moderna com contas locais do Exchange. Determinados dispositivos iOS ainda dão suporte a suplementos ao usar contas do Exchange locais com o Outlook na Web clássico. Para obter informações sobre os dispositivos suportados, confira Requisitos para executar Suplementos do Office.
2 Os suplementos não funcionam no Outlook na Web moderno em smartphones iPhone e Android. Para obter informações sobre os dispositivos suportados, confira Requisitos para executar Suplementos do Office.
3 Para exigir a API de identidade definida 1.3 no código do suplemento do Outlook, marque se ela tem suporte chamando .
isSetSupported('IdentityAPI', '1.3')Não é permitido declará-lo no manifesto do suplemento do Outlook. Você também pode determinar se a API tem suporte, verificando se ela não éundefined. Para mais detalhes, confira Usar APIs de conjuntos de requisitos posteriores.4 Para saber mais sobre as versões mínimas com suporte para conjuntos de requisitos recentes no Outlook clássico no Windows com uma assinatura do Microsoft 365 ou uma licença perpétua de varejo, consulte Suporte de versão para conjuntos de requisitos no Outlook clássico no Windows.
5 O suporte para a nova interface do usuário do Mac está disponível na versão 16.38.506 do Outlook. Para mais informações, consulte a seção Suporte de Suplemento no Outlook na nova Interface do Usuário do Mac.
6 Embora o Outlook clássico no Mac não dê suporte ao conjunto de requisitos de caixa de correio 1.9, ele dá suporte ao conjunto de requisitos DialogApi 1.2. Para obter informações sobre a versão e o build mínimos com suporte, consulte Conjuntos de requisitos da API de diálogo.
7 Atualmente, existem considerações adicionais ao projetar e implementar suplementos para clientes móveis. Para obter mais detalhes, consulte considerações de código ao adicionar suporte para comandos de suplemento no Outlook em dispositivos móveis. Embora o Outlook no Android e no iOS dê suporte até o conjunto de requisitos 1.5, seu suplemento móvel agora pode implementar algumas APIs de conjuntos de requisitos posteriores. Para obter mais informações sobre quais APIs são suportadas no Outlook mobile, consulte APIs JavaScript do Outlook suportadas no Outlook em dispositivos móveis.
Dica
É possível distinguir o Outlook clássico do moderno no navegador da Web, verificando sua barra de ferramentas da caixa de correio.
moderno
clássico
Suporte de versão para conjuntos de requisitos no Outlook clássico no Windows
A tabela a seguir lista o suporte de versão para conjuntos de requisitos de Caixa de correio mais recentes no Outlook clássico no Windows com uma assinatura do Microsoft 365 ou uma licença perpétua de varejo.
| Conjunto de requisitos | Versão |
|---|---|
| 1,8 | Versão 1910 (Build 12130.20272) |
| 1.9 | Versão 2008 (Compilação 13127.20296) |
| 1.10 | Versão 2104 (Build 13929.20296) |
| 1.11 | Versão 2110 (build 14527.20226) |
| 1.12 | Versão 2206 (Build 15330.20196) |
| 1.13 | Versão 2304 (Build 16327.20248) |
| 11.4 | Versão 2404 (Build 17530.15000) |
| 1.15 | Versão 2412 (Build 18324.20172) |
| 1.16 | Versão 2602 (Build 19725.20126) |
Para obter mais detalhes sobre a versão do cliente, confira a página do histórico de atualizações do Microsoft 365 ou do Office 2024 e saiba como encontrar a versão do cliente do Office e o canal de atualização.
Observação
No Outlook, cada canal de atualização recebe atualizações em uma taxa diferente. Para verificar se o canal dá suporte a uma versão ou build específico, consulte Histórico de atualizações do Microsoft 365 Apps. Para obter uma comparação dos diferentes canais de atualização, consulte Visão geral dos canais de atualização do Microsoft 365 Apps.
Referenciar a biblioteca de produção da API JavaScript do Office
Para usar APIs em qualquer um dos conjuntos de requisitos numerados, você deve fazer referência à biblioteca de produção na rede de distribuição de conteúdo (CDN) do Office.js. Para obter informações sobre como usar APIs de visualização, consulte Testar APIs de visualização.
Testar APIs de visualização
As novas APIs do JavaScript para Outlook são introduzidas pela primeira vez na "visualização" e, posteriormente, tornam-se parte de um conjunto específico de requisitos numerados, após passarem por vários testes e após a recolha das opiniões de usuários. Para fornecer feedback sobre uma API de visualização, use o mecanismo de feedback no final da página da Web em que a API está documentada.
Observação
As APIs de visualização estão sujeitas a alterações e não se destinam ao uso em um ambiente de produção.
Para saber mais detalhes sobre as APIs de visualização, confira o artigo sobre o conjunto de requisitos da API de visualização do Outlook.
Colaborar conosco no GitHub
A fonte deste conteúdo pode ser encontrada no GitHub, onde você também pode criar e revisar problemas e solicitações de pull. Para obter mais informações, confira o nosso guia para colaboradores.