Conjunto de requisitos de API para suplementos do Outlook versão 1.1

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. A API JavaScript do Outlook 1.1 (Caixa de Correio 1.1) é a primeira versão da API.

Observação

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

Novidades na versão 1.1

O conjunto de requisitos de caixa de correio 1.1 inclui todos os conjuntos de requisitos de API comum com suporte no Outlook. Ele adicionou os seguintes recursos.

  • Adicionados métodos para obter ou definir o corpo de mensagens e compromissos. Para obter mais informações, consulte Obter ou definir o corpo de uma mensagem ou compromisso no Outlook.

  • Foram adicionados métodos para adicionar, obter e remover anexos de mensagens e compromissos que estão sendo redigidos. Para obter mais informações, consulte Gerenciar os anexos de um item em um formulário redigido no Outlook.

  • Adicionados métodos para obter ou definir o assunto das mensagens e compromissos que estão sendo redigidos. Para obter mais informações, consulte Obter ou definir o assunto ao compor um compromisso ou mensagem no Outlook.

  • Adicionados métodos para obter ou definir o local dos compromissos que estão sendo compostos. Para obter mais informações, consulte Obter ou definir o local ao compor um compromisso no Outlook.

  • Adicionados métodos para obter ou definir a hora de início e término dos compromissos que estão sendo compostos. Para obter mais informações, consulte Obter ou definir o horário ao compor um compromisso no Outlook.

  • Adicionados métodos para obter ou definir os destinatários (Para, Cc, Cco) das mensagens que estão sendo compostas. Para obter mais informações, consulte Obter, definir ou adicionar destinatários a um compromisso ou mensagem no Outlook.

  • Adicionados métodos para exibir formulários de resposta e novos formulários de compromisso.

  • Métodos adicionados para exibir mensagens e compromissos existentes.

  • Foi adicionada a capacidade de fazer solicitações de Serviços Web do Exchange (EWS) diretamente de um suplemento.

    Importante

    Os tokens de identidade de usuário e tokens de retorno de chamada herdados do Exchange Online não têm mais suporte e estão desativados em todos os locatários do Microsoft 365. Se um suplemento do Outlook exigir acesso de usuário delegado ou identidade de usuário, recomendamos o uso da MSAL (Biblioteca de Autenticação da Microsoft) e da autenticação de aplicativo aninhado (NAA). Os tokens de identidade do usuário do Exchange ainda têm suporte para o Exchange local.

  • Adicionado suporte para propriedades personalizadas e configurações de roaming para armazenar dados de suplemento. Para obter mais informações, consulte Obter e definir metadados de suplemento para um suplemento do Outlook.

  • Foram adicionados métodos para detectar e extrair entidades (como endereços, números de telefone e URLs) de corpos de item.

    Importante

    Esse valor de elemento ou atributo é documentado para ajudar os desenvolvedores a solucionar problemas de suplementos contextuais existentes do Outlook. Recomendamos que você não crie novos suplementos contextuais do Outlook.

    • Os suplementos contextuais do Outlook baseados em entidades foram desativados.
    • Cenários que antes exigiam regras de expressão regular em suplementos contextuais agora podem ser implementados com suplementos do Outlook baseados em eventos, que são ativados automaticamente em resposta a eventos como a criação de uma nova mensagem ou reunião. O JavaScript tem suporte integrado para expressões regulares, e você também pode fazer referência a bibliotecas JavaScript que fornecem funcionalidades avançadas de expressões regulares. Ao contrário dos complementos contextuais, os suplementos baseados em eventos podem funcionar em contextos de composição, bem como no modo de leitura.

Lista de APIs

A tabela a seguir lista as APIs introduzidas no conjunto de requisitos de Caixa de correio 1.1. 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.1, consulte APIs do Outlook.

Classe Campos Descrição
AppointmentCompose addFileAttachmentAsync(uri: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void) Adiciona um arquivo a uma mensagem ou um compromisso como um anexo.
addFileAttachmentAsync(uri: string, attachmentName: string, options: Office.AsyncContextOptions & { isInline: boolean }, callback?: (asyncResult: Office.AsyncResult<string>) => void) Adiciona um arquivo a uma mensagem ou um compromisso como um anexo.
addItemAttachmentAsync(itemId: any, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void) Adiciona um item do Exchange, como uma mensagem, como anexo na mensagem ou no compromisso.
addItemAttachmentAsync(itemId: any, attachmentName: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<string>) => void) Adiciona um item do Exchange, como uma mensagem, como anexo na mensagem ou no compromisso.
body Obtém um objeto que fornece métodos para manipular o corpo de um item.
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 ou define o local de um compromisso.
removeAttachmentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult<void>) => void) Remove um anexo de uma mensagem ou de um compromisso.
removeAttachmentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Remove um anexo de uma mensagem ou de um compromisso.
Formulário de Compromisso body Define o corpo do compromisso.
end Define a data e a hora em que o compromisso deve terminar.
location Define o local do compromisso.
optionalAttendees Define os participantes opcionais do compromisso.
requiredAttendees Define os participantes necessários do compromisso.
resources Define os recursos do compromisso.
start Define a data e a hora em que o compromisso deve começar.
subject Define a descrição que aparece no campo Título do compromisso.
AppointmentRead body Obtém um objeto que fornece métodos para manipular o corpo de um item.
dateTimeModified Obtém a data e a hora em que um item foi alterado pela última vez.
displayReplyAllForm(formData: string | ReplyFormData) 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
displayReplyForm(formData: string | ReplyFormData) Exibe um formulário de resposta que inclui o remetente da mensagem selecionada ou o organizador do compromisso selecionado.
getEntities() Obtém as entidades encontradas no corpo do item selecionado.
getEntitiesByType(entityType: MailboxEnums.EntityType | string) Obtém uma matriz de todas as entidades do tipo de entidade especificado encontradas no corpo do item selecionado.
getFilteredEntitiesByName(name: string) Retorna entidades conhecidas no item selecionado que passam o filtro nomeado definido em um arquivo de manifesto somente de suplemento.
getRegExMatches() Retorna valores de cadeia de caracteres no item selecionado que correspondem às expressões regulares definidas em um arquivo de manifesto somente de suplemento.
getRegExMatchesByName(name: string) Retorna valores de cadeia de caracteres no item selecionado que correspondem à expressão regular nomeada definida em um arquivo de manifesto somente de suplemento.
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 um compromisso.
AttachmentDetails attachmentType Obtém um valor que indica o tipo do anexo.
contentType Obtém o tipo de conteúdo MIME do anexo.
id Obtém a ID do Exchange do anexo.
isInline Obtém um valor que indica se o anexo aparece como uma imagem no corpo do item em vez de na lista de anexos.
name Obtém o nome de arquivo do anexo.
size Obtém o tamanho do anexo em bytes.
Body getTypeAsync(callback?: (asyncResult: Office.AsyncResult<Office.CoercionType>) => void) Obtém um valor que indica se o conteúdo está em formato HTML ou texto.
getTypeAsync(opções: Office.AsyncContextOptions, retorno de chamada?: (asyncResult: Office.AsyncResult<Office.CoercionType>) => void) Obtém um valor que indica se o conteúdo está em formato HTML ou texto.
prependAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void) Adiciona o conteúdo especificado ao início do corpo do item.
prependAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Adiciona o conteúdo especificado ao início do corpo do item.
setSelectedDataAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void) Substitui a seleção no corpo pelo texto especificado.
setSelectedDataAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Substitui a seleção no corpo pelo texto especificado.
CustomProperties get(name: string) Retorna o valor da propriedade personalizada especificada.
remove(name: string) Remove a propriedade especificada do conjunto de propriedades personalizadas.
saveAsync(asyncContext?: any) Salva propriedades personalizadas em uma mensagem ou compromisso.
saveAsync(callback: (asyncResult: Office.AsyncResult<void>) => void, asyncContext?: any) Salva propriedades personalizadas em uma mensagem ou compromisso.
set(name: string, value: string) Define a propriedade especificada com o valor especificado.
Diagnóstico OWAView Obtém uma cadeia de caracteres que representa a exibição atual do Outlook na Web.
hostName Obtém uma cadeia de caracteres que representa o tipo de cliente do Outlook.
hostVersion Obtém uma cadeia de caracteres que representa a versão do cliente Outlook ou do Exchange Server (por exemplo, "15.0.468.0").
Location getAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) Obtém o local de um compromisso.
getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void) Obtém o local de um compromisso.
setAsync(location: string, callback?: (asyncResult: Office.AsyncResult<void>) => void) Define o local de um compromisso.
setAsync(location: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Define o local de um compromisso.
Caixa de Correio displayAppointmentForm(itemId: string) Exibe um compromisso de calendário existente.
displayMessageForm(itemId: string) Exibe uma mensagem existente.
displayNewAppointmentForm(parâmetros: AppointmentForm) Exibe um formulário para criar um compromisso no calendário.
ewsUrl Obtém a URL do ponto de extremidade dos Serviços Web do Exchange (EWS) para esta conta de email.
makeEwsRequestAsync(data: any, callback: (asyncResult: Office.AsyncResult<string>) => void, userContext?: any) Faz uma solicitação assíncrona para um serviço EWS (Serviços Web do Exchange) no servidor Exchange que hospeda a caixa de correio do usuário.
MessageCompose addFileAttachmentAsync(uri: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void) Adiciona um arquivo a uma mensagem ou um compromisso como um anexo.
addFileAttachmentAsync(uri: string, attachmentName: string, options: Office.AsyncContextOptions & { isInline: boolean }, callback?: (asyncResult: Office.AsyncResult<string>) => void) Adiciona um arquivo a uma mensagem ou um compromisso como um anexo.
addItemAttachmentAsync(itemId: any, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void) Adiciona um item do Exchange, como uma mensagem, como anexo na mensagem ou no compromisso.
addItemAttachmentAsync(itemId: any, attachmentName: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<string>) => void) Adiciona um item do Exchange, como uma mensagem, como anexo na mensagem ou no compromisso.
bcc Obtém um objeto que fornece métodos para obter ou atualizar os destinatários na linha Cco (com cópia oculta) de uma mensagem.
body Obtém um objeto que fornece métodos para manipular o corpo de um item.
loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult<CustomProperties>) => void, userContext?: any) Carrega de forma assíncrona as propriedades personalizadas para esse suplemento no item selecionado.
removeAttachmentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult<void>) => void) Remove um anexo de uma mensagem ou de um compromisso.
removeAttachmentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Remove um anexo de uma mensagem ou de um compromisso.
MessageRead body Obtém um objeto que fornece métodos para manipular o corpo de um item.
dateTimeModified Obtém a data e a hora em que um item foi alterado pela última vez.
displayReplyAllForm(formData: string | ReplyFormData) 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
displayReplyForm(formData: string | ReplyFormData) Exibe um formulário de resposta que inclui o remetente da mensagem selecionada ou o organizador do compromisso selecionado.
getEntities() Obtém as entidades encontradas no corpo do item selecionado.
getEntitiesByType(entityType: MailboxEnums.EntityType | string) Obtém uma matriz de todas as entidades do tipo de entidade especificado encontradas no corpo do item selecionado.
getFilteredEntitiesByName(name: string) Retorna entidades conhecidas no item selecionado que passam o filtro nomeado definido em um arquivo de manifesto somente de suplemento.
getRegExMatches() Retorna valores de cadeia de caracteres no item selecionado que correspondem às expressões regulares definidas em um arquivo de manifesto somente de suplemento.
getRegExMatchesByName(name: string) Retorna valores de cadeia de caracteres no item selecionado que correspondem à expressão regular nomeada definida em um arquivo de manifesto somente de suplemento.
loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult<CustomProperties>) => void, userContext?: any) Carrega de forma assíncrona as propriedades personalizadas para esse suplemento no item selecionado.
AttachmentType Nuvem O anexo é armazenado em um local de nuvem, como o OneDrive.
Arquivo O anexo é um arquivo.
Item O anexo é um item do Exchange.
RecipientType DistributionList Especifica que o destinatário é uma lista de distribuição contendo uma lista de endereços de email.
Usuário Externo Especifica que o destinatário é um endereço de email SMTP que não está no servidor Exchange.
Outros Especifica que o destinatário não é um dos outros tipos de destinatário.
Usuário Especifica que o destinatário é um endereço de email SMTP no servidor Exchange.
Destinatários addAsync(recipients: Array<string | Usuário de E-mail | EmailAddressDetails>, retorno de chamada?: (asyncResult: Office.AsyncResult<void>) => void) Adiciona uma lista de destinatários aos destinatários existentes para um compromisso ou uma mensagem.
addAsync(recipients: Array<string | Usuário de E-mail | EmailAddressDetails>, opções: Office.AsyncContextOptions, retorno de chamada?: (asyncResult: Office.AsyncResult<void>) => void) Adiciona uma lista de destinatários aos destinatários existentes para um compromisso ou uma mensagem.
getAsync(callback: (asyncResult: Office.AsyncResult<EmailAddressDetails[]>) => void) Obtém uma lista de destinatários para um compromisso ou uma mensagem.
getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<EmailAddressDetails[]>) => void) Obtém uma lista de destinatários para um compromisso ou uma mensagem.
setAsync(recipients: Array<string | Usuário de E-mail | EmailAddressDetails>, retorno de chamada: (asyncResult: Office.AsyncResult<void>) => void) Define uma lista de destinatários para um compromisso ou uma mensagem.
setAsync(recipients: Array<string | Usuário de E-mail | EmailAddressDetails>, opções: Office.AsyncContextOptions, retorno de chamada: (asyncResult: Office.AsyncResult<void>) => void) Define uma lista de destinatários para um compromisso ou uma mensagem.
ReplyFormAttachment embutido Se for true, indica que o anexo será mostrado embutido no corpo da mensagem e não deve ser exibido na lista de anexos.
itemId A ID do item EWS do anexo.
name Uma cadeia de caracteres que contém o nome do anexo, até 255 caracteres de comprimento.
type Indica o tipo de anexo.
url O URI do local para o arquivo.
ReplyFormData callback Quando a chamada de exibição de resposta é concluída, a função passada no parâmetro de retorno de chamada é chamada com um único parâmetro,
html Corpo Uma cadeia de caracteres que contém texto e HTML e que representa o corpo do formulário de resposta.
options Um literal de objeto que contém a asyncContext propriedade.
RoamingSettings get(name: string) Recupera a configuração especificada.
remove(name: string) Remove a configuração especificada.
saveAsync(callback?: (asyncResult: Office.AsyncResult<void>) => void) Salva as configurações.
set(name: string, value: any) Define ou cria a configuração especificada.
Assunto getAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) Obtém o assunto de um compromisso ou uma mensagem.
getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void) Obtém o assunto de um compromisso ou uma mensagem.
setAsync(subject: string, callback?: (asyncResult: Office.AsyncResult<void>) => void) Define o assunto de um compromisso ou uma mensagem.
setAsync(subject: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Define o assunto de um compromisso ou uma mensagem.
Time getAsync(callback: (asyncResult: Office.AsyncResult<Date>) => void) Obtém a hora de início ou de término de um compromisso.
getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<Date>) => void) Obtém a hora de início ou de término de um compromisso.
setAsync(dateTime: Date, callback?: (asyncResult: Office.AsyncResult<void>) => void) Define a hora de início ou de término de um compromisso.
setAsync(dateTime: Date, opções: Office.AsyncContextOptions, retorno de chamada?: (asyncResult: Office.AsyncResult<void>) => void) Define a hora de início ou de término de um compromisso.

Confira também

  • Última atualização em