Obter e configurar dados de item do Outlook em formulários de leitura ou composição

A partir da versão 1.1 do esquema dos manifestos dos suplementos do Office, o Outlook pode ativar suplementos quando o usuário está visualizando ou compondo um item. Dependendo da ativação do suplemento ser em um formulário de leitura ou de composição, as propriedades que estão disponíveis para o suplemento no item também variam.

Por exemplo, as propriedades dateTimeCreated e dateTimeModified são definidas somente para um item que já foi enviado (o item é visualizado em um formulário de leitura), mas não quando o item está sendo criado (em um formulário de composição). Outro exemplo é a propriedade bcc, que só é significativa quando uma mensagem está sendo criada (em um formulário de composição) e não está acessível ao usuário em um formulário de leitura.

Propriedades de item disponíveis nos formulários de leitura e de redação

A Tabela 1 mostra as propriedades no nível do item na API JavaScript do Office que estão disponíveis em cada modo (leitura e composição) dos suplementos de email. Normalmente, essas propriedades disponíveis em formulários de leitura são somente leitura e aquelas disponíveis em formulários de composição são de leitura/gravação, com exceção das propriedades itemId, conversationId e itemType , que são sempre somente leitura independentemente.

Para as propriedades do nível de item restantes disponíveis em formulários de composição, como o suplemento e o usuário podem estar lendo ou gravando a mesma propriedade ao mesmo tempo, os métodos para obtê-los ou defini-los s no modo redigir são assíncronos e, portanto, o tipo de objeto retornado por essas propriedades também podem ser diferentes entre os formulários de composição e de leitura. Para saber mais sobre como usar métodos assíncronos para obter ou definir propriedades de nível de item no modo de composição, confira Obter e definir dados de item em um formulário de composição no Outlook.

Tabela 1. Propriedades de item disponíveis nos formulários de leitura e de redação


Tipo de item Propriedade Tipo de propriedade nos formulários de leitura Tipo de propriedade em formulários de redação
Compromissos e mensagens dateTimeCreated Objeto JavaScript Date Propriedade não disponível
Compromissos e mensagens dateTimeModified Objeto JavaScript Date Propriedade não disponível
Compromissos e mensagens itemClass String Propriedade não disponível
Compromissos e mensagens itemId String Propriedade não disponível
Compromissos e mensagens itemType Cadeia de caracteres na enumeração ItemType Cadeia de caracteres na enumeração ItemType (somente leitura)
Compromissos e mensagens attachments AttachmentDetails Propriedade não disponível
Compromissos e mensagens body Body Body
Compromissos e mensagens normalizedSubject String Propriedade não disponível
Compromissos e mensagens subject String Subject
Compromissos end Objeto JavaScript Date Time
Compromissos location String Location
Compromissos optionalAttendees EmailAddressDetails Recipients
Compromissos organizer EmailAddressDetails Organizador
Compromissos requiredAttendees EmailAddressDetails Recipients
Compromissos start Objeto JavaScript Date Time
Mensagens bcc Propriedade não disponível Destinatários
Mensagens cc EmailAddressDetails Destinatários
Mensagens conversationId String Cadeia de caracteres (somente leitura)
Mensagens from EmailAddressDetails De
Mensagens internetMessageId Inteiro Propriedade não disponível
Mensagens sender EmailAddressDetails Propriedade não disponível
Mensagens to EmailAddressDetails Destinatários

Usar tokens de retorno de chamada do Exchange Server de um suplemento de leitura

Se o suplemento do Outlook é ativado nos formulários de leitura, você pode obter um token de retorno de chamada do Exchange. Esse token pode ser usado no código do lado do servidor para acessar o item completo via EWS (Serviços Web do Exchange).

Ao especificar a permissão do item de leitura no manifesto de suplemento, você pode usar o método mailbox.getCallbackTokenAsync para obter um token de retorno de chamada do Exchange, a propriedade mailbox.ewsUrl para obter a URL do ponto de extremidade EWS para a caixa de correio do usuário e item.itemId para obter a ID do EWS para o item selecionado. Você pode então passar o token de retorno de chamada, a URL de ponto de extremidade de EWS e a ID de item EWS para código do lado do servidor a fim de acessar a operação GetItem e obter mais propriedades do item.

Acessar os EWS de um suplemento de leitura ou de redação

Você também pode usar o método mailbox.makeEwsRequestAsync para acessar as operações do EWS (Serviços Web do Exchange) GetItem e UpdateItem diretamente do suplemento. Você pode usar essas operações para obter e definir muitas propriedades de um item especificado. Esse método está disponível para suplementos do Outlook, independentemente de o suplemento ter sido ativado em um formulário de leitura ou composição, desde que você especifique a permissão de caixa de correio de leitura/gravação no manifesto de suplemento. Para obter mais informações sobre a permissão de caixa de correio de leitura/gravação , consulte Noções básicas sobre as permissões de suplemento do Outlook

Para saber mais sobre o uso de makeEwsRequestAsync para acessar as operações EWS, confira Chamar serviços Web de um suplemento do Outlook.

Confira também