Requisitos da API do suplemento do Outlook definidos 1.15

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 da versão 1.15

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

Lista de APIs

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

Classe Campos Descrição
AppointmentCompose sendAsync(callback?: (asyncResult: Office.AsyncResult<void>) => void) Envia o compromisso que está sendo composto.
sendAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Envia o compromisso que está sendo composto.
InitializationContextChangedEventArgs initializationContextData Representa os dados a serem passados para o painel de tarefas de um suplemento a partir de uma mensagem acionável, mensagem de notificação, caixa de diálogo Alertas Inteligentes ou aplicativo
tipo Representa o tipo do evento.
LoadedMessageCompose bcc Coloca os destinatários na linha Cco (cópia oculta) de uma mensagem.
body Obtém o corpo e o formato do item.
Categorias Obtém um objeto que fornece métodos para gerenciar as categorias do item.
cc Recebe os destinatários na linha Cc (cópia carbono) de uma mensagem.
conversationId Obtém um identificador da conversa de email que contém uma mensagem específica.
delayDeliveryTime Obtém a data e a hora de entrega atrasadas de uma mensagem.
from Obtém o endereço de email do remetente de uma mensagem.
getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void) Obtém um anexo de uma mensagem ou compromisso e o retorna como um AttachmentContent objeto.
getAttachmentContentAsync(attachmentId: string, opções: Office.AsyncContextOptions, retorno de chamada?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void) Obtém um anexo de uma mensagem ou compromisso e o retorna como um AttachmentContent objeto.
getAttachmentsAsync(callback?: (asyncResult: Office.AsyncResult<AttachmentDetailsCompose[]>) => void) Obtém os anexos do item como uma matriz.
getAttachmentsAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<AttachmentDetailsCompose[]>) => void) Obtém os anexos do item como uma matriz.
getComposeTypeAsync(callback: (asyncResult: Office.AsyncResult) => void) Especifica o tipo de redação da mensagem e seu tipo de coerção.
getComposeTypeAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void) Especifica o tipo de redação da mensagem e seu tipo de coerção.
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.
getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) Recebe dados de inicialização passados quando o suplemento é ativado por uma mensagem acionável.
getInitializationContextAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void) Recebe dados de inicialização passados quando o suplemento é ativado por uma mensagem acionável.
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.
getItemIdAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) Obtém de forma assíncrona a ID de um item salvo.
getItemIdAsync(opções: Office.AsyncContextOptions, retorno de chamada: (asyncResult: Office.AsyncResult<string>) => void) Obtém de forma assíncrona o identificador de item do EWS (Serviços Web do Exchange)
getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void) Obtém as propriedades de um compromisso ou mensagem em uma pasta compartilhada ou caixa de correio compartilhada.
getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void) Obtém as propriedades de um compromisso ou mensagem em uma pasta compartilhada ou caixa de correio compartilhada.
inReplyTo Obtém a ID da mensagem original que está sendo respondida pela mensagem atual.
internetHeaders Obtém os cabeçalhos personalizados da Internet de uma mensagem.
isClientSignatureEnabledAsync(callback: (asyncResult: Office.AsyncResult<boolean>) => void) Obtém se a assinatura do cliente está habilitada.
isClientSignatureEnabledAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<boolean>) => void) Obtém se a assinatura do cliente está habilitada.
itemType Obtém o tipo de item que representa uma instância.
loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult<CustomProperties>) => void, userContext?: any) Carrega de forma assíncrona as propriedades personalizadas para esse suplemento no item selecionado.
notificationMessages Obtém as mensagens de notificação do item.
saveAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) Salva de forma assíncrona a mensagem atual como um rascunho.
saveAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void) Salva de forma assíncrona a mensagem atual como um rascunho.
sensitivityLabel Obtém o rótulo de confidencialidade de uma mensagem.
seriesId Obtém a ID da série à qual uma instância pertence.
subject Obtém a descrição que aparece no campo de assunto de um item.
to Coloca os destinatários na linha Para de uma mensagem.
unloadAsync(callback?: (asyncResult: Office.AsyncResult<void>) => void) Quando vários itens de email são selecionados, fecha o item carregado no momento, para que outro item de email selecionado possa ser carregado para processamento.
unloadAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Quando vários itens de email são selecionados, fecha o item carregado no momento, para que outro item de email selecionado possa ser carregado para processamento.
LoadedMessageRead attachments Obtém os anexos do item como uma matriz.
body Obtém o corpo do item e seu formato.
Categorias Obtém um objeto que fornece métodos para gerenciar as categorias do item.
cc Recebe os destinatários na linha Cc (cópia carbono) de uma mensagem.
conversationId Obtém um identificador da conversa de email que contém uma mensagem específica.
dateTimeCreated Obtém a data e a hora em que um item foi criado.
dateTimeModified Obtém a data e a hora em que um item foi alterado pela última vez.
displayReplyAllFormAsync(formData: string | ReplyFormData, retorno de chamada?: (asyncResult: Office.AsyncResult<void>) => void) Exibe um formulário de resposta que inclui o remetente e todos os destinatários da mensagem selecionada ou o organizador e todos os participantes da mensagem
displayReplyAllFormAsync(formData: string | ReplyFormData, opções: Office.AsyncContextOptions, retorno de chamada?: (asyncResult: Office.AsyncResult<void>) => void) Exibe um formulário de resposta que inclui o remetente e todos os destinatários da mensagem selecionada ou o organizador e todos os participantes da mensagem
displayReplyFormAsync(formData: string | ReplyFormData, retorno de chamada?: (asyncResult: Office.AsyncResult<void>) => void) Exibe um formulário de resposta que inclui o remetente da mensagem selecionada ou o organizador do compromisso selecionado.
displayReplyFormAsync(formData: string | ReplyFormData, opções: Office.AsyncContextOptions, retorno de chamada?: (asyncResult: Office.AsyncResult<void>) => void) Exibe um formulário de resposta que inclui o remetente da mensagem selecionada ou o organizador do compromisso selecionado.
end Obtém a data e a hora em que o compromisso deve terminar.
from Obtém o endereço de email do remetente de uma mensagem.
getAllInternetHeadersAsync(callback?: (asyncResult: Office.AsyncResult<string>) => void) Obtém todos os cabeçalhos da Internet para a mensagem como uma cadeia de caracteres.
getAllInternetHeadersAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<string>) => void) Obtém todos os cabeçalhos da Internet para a mensagem como uma cadeia de caracteres.
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.
getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void) Obtém um anexo de uma mensagem ou compromisso e o retorna como um AttachmentContent objeto.
getAttachmentContentAsync(attachmentId: string, opções: Office.AsyncContextOptions, retorno de chamada?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void) Obtém um anexo de uma mensagem ou compromisso e o retorna como um AttachmentContent objeto.
getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) Recebe dados de inicialização passados quando o suplemento é ativado por uma mensagem acionável.
getInitializationContextAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void) Recebe dados de inicialização passados quando o suplemento é ativado por uma mensagem acionável.
getRegExMatches() Retorna valores de cadeia de caracteres no item selecionado que correspondem às expressões regulares definidas em um arquivo de manifesto XML.
getRegExMatchesByName(name: string) Retorna valores de cadeia de caracteres no item selecionado que correspondem à expressão regular nomeada definida em um arquivo de manifesto XML.
getSelectedRegExMatches() Retorna valores de cadeia de caracteres em uma correspondência realçada que correspondem às expressões regulares definidas em um arquivo de manifesto XML.
getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void) Obtém as propriedades de um compromisso ou mensagem em uma pasta compartilhada ou caixa de correio compartilhada.
getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void) Obtém as propriedades de um compromisso ou mensagem em uma pasta compartilhada ou caixa de correio compartilhada.
internetMessageId Obtém o identificador de mensagem de Internet de uma mensagem.
itemClass Obtém a classe de item Serviços Web do Exchange da mensagem selecionada.
itemId Obtém o identificador de item dos Serviços Web do Exchange
itemType Obtém o tipo de item que representa uma instância.
loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult<CustomProperties>) => void, userContext?: any) Carrega de forma assíncrona as propriedades personalizadas para esse suplemento no item selecionado.
location Obtém o local de uma solicitação de reunião.
normalizedSubject Obtém o assunto de um item, com todos os prefixos removidos (incluindo RE: e FWD:).
notificationMessages Obtém as mensagens de notificação do item.
recorrência Obtém o padrão de recorrência de um compromisso.
sender Obtém o endereço de email do remetente de uma mensagem de email.
seriesId Obtém a ID da série à qual uma instância pertence.
start Obtém a data e a hora em que o compromisso deve começar.
subject Obtém a descrição que aparece no campo de assunto de um item.
to Coloca os destinatários na linha Para de uma mensagem.
unloadAsync(callback?: (asyncResult: Office.AsyncResult<void>) => void) Quando vários itens de email são selecionados, fecha o item carregado no momento, para que outro item de email selecionado possa ser carregado para processamento.
unloadAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Quando vários itens de email são selecionados, fecha o item carregado no momento, para que outro item de email selecionado possa ser carregado para processamento.
Caixa de Correio loadItemByIdAsync(itemId: string, callback: (asyncResult: Office.AsyncResult<LoadedMessageCompose | LoadedMessageRead>) => void) Carrega um único item de email por sua ID do Serviços Web do Exchange (EWS).
loadItemByIdAsync(itemId: string, opções: Office.AsyncContextOptions, retorno de chamada: (asyncResult: Office.AsyncResult<LoadedMessageCompose | LoadedMessageRead>) => void) Carrega um único item de email por sua ID do Serviços Web do Exchange (EWS).
MessageCompose sendAsync(callback?: (asyncResult: Office.AsyncResult<void>) => void) Envia a mensagem que está sendo redigida.
sendAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Envia a mensagem que está sendo redigida.
AttachmentType em base64 O anexo é um arquivo codificado em Base64.
ReplyFormAttachment arquivo base64 A cadeia de caracteres codificada em Base64 do arquivo a ser anexado.
SmartAlertsEventCompletedOptions errorMessageMarkdown Quando você usa o método completed para sinalizar a conclusão de um manipulador de eventos
SpamReportingEventCompletedOptions commandId Quando você usa o método concluído para sinalizar que uma mensagem relatada concluiu o processamento,
contextData 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.15. 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
InitializationContextChanged O painel de tarefas de um suplemento foi aberto a partir de uma mensagem acionável, InsightMessage notificação, caixa de diálogo Alertas Inteligentes ou caixa de diálogo integrada de relatórios de spam. 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.15. 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.spamPreProcessingDialog.spamReportingOptions.type" ReportingOptions Foi adicionado suporte para botões de opção na caixa de diálogo de pré-processamento de um suplemento integrado de relatórios de spam.
Relatório de spam "extensions.ribbons.spamPreProcessingDialog.spamNeverShowAgainOption" PreProcessingDialog Adicionado suporte para a caixa de seleção "Não mostrar esta mensagem novamente" na caixa de diálogo de pré-processamento de um suplemento integrado de relatório de spam.

Confira também

  • Last updated on