Conjunto de requisitos de API do suplemento do Outlook 1.14

O subconjunto da API do suplemento do Outlook da API JavaScript do Office inclui objetos, métodos, propriedades e eventos que você pode usar em um suplemento do Outlook.

Observação

Esta documentação destina-se a um conjunto de requisitos que não seja o mais recente.

Novidades na versão 1.14

O conjunto de requisitos de caixa de correio 1.14 inclui todos os recursos do conjunto de requisitos 1.13. Ele adicionou os seguintes recursos.

  • Adicionado o recurso integrado de relatório de spam .
  • Adicionado um método para obter a codificação Base64 de uma mensagem.
  • Adicionado um método para obter a URL do tempo de execução JavaScript de um suplemento.
  • Adicionado suporte para personalizar o texto do botão e configurar um painel de tarefas para a opção Não enviar de um diálogo de Alertas Inteligentes .
  • Suporte adicionado para substituir a opção de modo de envio de um suplemento de Alertas Inteligentes em tempo de execução.
  • Membros adicionados para obter propriedades adicionais de uma mensagem no modo de redação.
  • Adicionado um método para fechar uma mensagem atual sendo composta com a opção de descartar alterações não salvas.
  • Adicionadas propriedades de item de email adicionais para o recurso de seleção múltipla de item .
  • Adicionado suporte para identificar o tema atual do Office de um cliente Outlook.
  • Adicionado suporte para obter e definir o nível de confidencialidade de um compromisso.

Lista de APIs

A tabela a seguir lista as APIs introduzidas no conjunto de requisitos de Caixa de correio 1.14. Para exibir a documentação de referência da API para todas as APIs compatíveis com o conjunto de requisitos de Caixa de correio 1.14 ou anterior, consulte APIs do Outlook.

Classe Campos Descrição
AppointmentCompose Confidencialidade Obtém ou define o nível de confidencialidade de um compromisso.
AppointmentRead Confidencialidade Fornece o valor de confidencialidade do compromisso.
Evento de caixa de correio completed(options?: SmartAlertsEventCompletedOptions | SpamReportingEventCompletedOptions) Indica que o suplemento baseado em eventos, geração de relatórios de spam ou de descriptografia concluiu o processamento de um evento.
MessageCompose closeAsync(callback?: (asyncResult: Office.AsyncResult<void>) => void) Fecha a nova mensagem atual que está sendo composta.
closeAsync(options: Office.AsyncContextOptions & { discardItem: boolean }, callback?: (asyncResult: Office.AsyncResult<void>) => void) Fecha a mensagem atual que está sendo composta com a opção de descartar alterações não salvas.
getConversationIndexAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) Obtém a posição codificada em Base64 da mensagem atual em um thread de conversa.
getConversationIndexAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void) Obtém a posição codificada em Base64 da mensagem atual em um thread de conversa.
getItemClassAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) Obtém a classe de item Serviços Web do Exchange da mensagem selecionada.
getItemClassAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void) Obtém a classe de item Serviços Web do Exchange da mensagem selecionada.
inReplyTo Obtém a ID da mensagem de Internet da mensagem original que está sendo respondida pela mensagem atual.
MessageRead getAsFileAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) Obtém a mensagem atual no formato EML codificada em Base64.
getAsFileAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void) Obtém a mensagem atual no formato EML codificada em Base64.
AppointmentSensitivityType Confidencial Trate o item como confidencial.
Normal O item não precisa de tratamento especial.
Personal Trate o item como pessoal.
Private Trate o item como privado.
MoveSpamItemTo CustomFolder Especifica que uma mensagem relatada é movida para uma pasta personalizada na caixa de correio.
Pasta DeletedItemsFolder Especifica que uma mensagem relatada é movida para a pasta Itens Excluídos da caixa de correio.
Pasta de lixo eletrônico Especifica que uma mensagem relatada é movida para a pasta Lixo Eletrônico de Email da caixa de correio.
NoMove Especifica que uma mensagem relatada permanece em sua pasta atual na caixa de correio.
SendModeOverride PromptUser Fornece a opção Enviar Mesmo Assim em uma caixa de diálogo de Alertas Inteligentes quando o item de email não atende às condições do suplemento baseado em evento.
OfficeThemeChangedEventArgs officeTheme Obtém o tema atualizado do Office.
tipo Obtém o tipo do evento.
SelectedItemDetails conversationId O identificador da conversa de mensagem que contém a mensagem que está selecionada no momento.
hasAttachment Retorna true se a mensagem selecionada no momento contém um anexo.
internetMessageId O identificador de mensagem da Internet da mensagem que está selecionado no momento.
Sensitivity getAsync(callback: (asyncResult: Office.AsyncResult<MailboxEnums.AppointmentSensitivityType>) => void) Obtém o nível de confidencialidade de um compromisso.
getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<MailboxEnums.AppointmentSensitivityType>) => void) Obtém o nível de confidencialidade de um compromisso.
setAsync(sensitivity: MailboxEnums.AppointmentSensitivityType | string, callback?: (asyncResult: Office.AsyncResult<void>) => void) Define o nível de confidencialidade de um compromisso.
setAsync(sensitivity: MailboxEnums.AppointmentSensitivityType | string, opções: Office.AsyncContextOptions, retorno de chamada?: (asyncResult: Office.AsyncResult<void>) => void) Define o nível de confidencialidade de um compromisso.
SmartAlertsEventCompletedOptions cancelLabel Quando você usa o método concluído para sinalizar a conclusão de um manipulador de eventos e define sua allowEvent propriedade como false,
commandId Quando você usa o método concluído para sinalizar a conclusão de um manipulador de eventos e define sua allowEvent propriedade como false,
contextData Quando você usa o método concluído para
sendModeOverride Quando você usa o método completed para sinalizar a conclusão de um manipulador de eventos
SpamReportingEventArgs freeText O texto fornecido pelo usuário na caixa de diálogo de pré-processamento de um suplemento de relatório de spam.
options Retorna true para cada opção de relatório selecionada pelo usuário na caixa de diálogo de pré-processamento de um suplemento de relatório de spam.
type O tipo de evento que foi gerado.
SpamReportingEventCompletedOptions folderName Quando você usa o método concluído para sinalizar que uma mensagem relatada concluiu o processamento,
moveItemTo Quando você usa o método concluído para sinalizar que uma mensagem relatada concluiu o processamento,
onErrorDeleteItem Quando definido como true, exclui uma mensagem relatada se ocorrer um erro enquanto a mensagem é processada.
postProcessingAction Quando você usa o método concluído para sinalizar que uma mensagem relatada concluiu o processamento,
showPostProcessingDialog Quando você usa o método concluído para sinalizar que uma mensagem relatada concluiu o processamento,

Eventos

A tabela a seguir lista os eventos introduzidos no conjunto de requisitos 1.14. Para obter uma lista de todos os eventos com suporte que podem ser manipulados usando os addHandlerAsync métodos and removeHandlerAsync , confira Office.EventType.

Evento Descrição Objeto
OfficeThemeChanged O tema do Office foi alterado no Outlook. Mailbox
Relatórios de Spam Uma mensagem não solicitada foi relatada. Item

Observação

Para eventos com suporte em um suplemento de ativação baseada em eventos, consulte Ativar suplementos com eventos.

Atualizações de manifesto

A tabela a seguir lista as atualizações de manifesto introduzidas no conjunto de requisitos de caixa de correio 1.14. Para saber mais sobre os tipos de manifestos de Suplementos do Office, consulte Manifesto de Suplementos do Office.

Recurso Manifesto unificado para o Microsoft 365 Manifesto somente do suplemento Descrição
Relatório de spam "extensions.ribbons.contexts" matriz que contém "spamReportingOverride" ReportPhishingCommandSurface Ativa um suplemento de relatório de spam em uma seção proeminente da faixa de opções do Outlook.
Relatório de spam "extensions.ribbons.spamPreProcessingDialog" ReportPhishingCustomization Configura o botão da faixa de opções e a caixa de diálogo de pré-processamento de um suplemento de relatório de spam.

Confira também

  • Last updated on