Configurações de aplicativo persistentes no EWS no Exchange

Artigo
03/29/2023

Saiba mais sobre as diferentes opções que a API Gerenciada do EWS ou o aplicativo EWS podem usar para criar configurações persistentes de aplicativo personalizado no Exchange.

A maneira mais fácil de manter as configurações personalizadas do cliente em sincronização para uma caixa de correio, ou pastas e itens em uma caixa de correio, é armazenar configurações de aplicativo em um servidor exchange. Você pode garantir que essas configurações persistam para uma caixa de correio usando uma das seguintes opções:

Objetos de configuração do usuário
Propriedades estendidas
Itens personalizados

Quais são as minhas opções para criar configurações de aplicativo persistentes?

Os objetos de configuração do usuário são sua melhor opção para armazenar configurações para seus aplicativos cliente EWS. Você também pode usar propriedades de extensão ou itens personalizados ou uma combinação dos três. Escolha sua opção com base no escopo de suas configurações e se suas configurações precisam estar disponíveis para outros aplicativos.

Tabela 1. Opções recomendadas para criar configurações de aplicativo persistentes com base no escopo

Configuração do escopo	Usar...	Acessado por
Item	Uma propriedade estendida em um item existente.	Qualquer aplicativo EWS. Somente clientes EWS que sabem que o identificador de propriedade podem acessar uma propriedade estendida.
Folder	Um objeto de configuração de usuário na pasta de destino. Essa é uma boa maneira de salvar as configurações de exibição de uma pasta.	Qualquer aplicativo EWS.
Mailbox	Um objeto de configuração de usuário na pasta msgrootfolder padrão.	Qualquer aplicativo EWS.

Objetos de configuração do usuário

Objetos de configuração do usuário são itens especiais associados a pastas em uma caixa de correio. Objetos de configuração de usuário, também conhecidos como itens associados à pasta, normalmente são a melhor opção para manter as configurações do aplicativo, especialmente se as informações de configuração estiverem associadas a uma pasta ou uma caixa de correio. Normalmente, eles não são exibidos para usuários finais. Como eles podem armazenar nativamente fluxos de dados e dicionários de dados, eles são ideais para armazenar informações de configuração. A melhor maneira de usar objetos de configuração do usuário é armazenar um conjunto de configurações em um documento XML e, em seguida, salvar essas informações em uma das propriedades do fluxo de configuração do usuário.

Os objetos de configuração do usuário são acessados de forma diferente dos outros tipos de item armazenados em uma caixa de correio. Você pode usar o método folder.FindItems EWS Managed API ou a operação FindItem EWS para encontrar todos os itens, mas você deve usar a opção de travessia de pesquisa associada para encontrar objetos de configuração do usuário. A travessia de pesquisa associada indica que os resultados da pesquisa devem conter apenas objetos de configuração do usuário. O EWS inclui um conjunto de operações específicas para objetos de configuração do usuário.

Tabela 1. Operações EWS e métodos de API Gerenciada do EWS para trabalhar com objetos de configuração do usuário

Para...	Usar essa operação EWS	Use este método de API Gerenciada do EWS
Criar um objeto de configuração de usuário	Operação CreateUserConfiguration	UserConfiguration.Save
Obter um objeto de configuração de usuário	Operação GetUserConfiguration	UserConfiguration.Bind UserConfiguration.Load
Atualizar um objeto de configuração de usuário	Operação UpdateUserConfiguration	UserConfiguration.Update
Excluir um objeto de configuração de usuário	Operação DeleteUserConfiguration	UserConfiguration.Delete

Observação

Os objetos de configuração do usuário criados usando o EWS têm um prefixo ItemClass que começa com "IPM. Configuração.". O ItemClass de um objeto de configuração de usuário é o prefixo de objeto de configuração do usuário e o nome do objeto de configuração do usuário. Você pode usar a propriedade API Gerenciada do Item.ItemClass EWS ou o elemento ItemClass EWS para pesquisar objetos de configuração de usuário que você definiu.

Propriedades estendidas

Use propriedades estendidas se quiser armazenar informações de configuração em itens. O EWS, ao contrário do MAPI, não retorna um saco de propriedades para itens. Isso significa que um cliente EWS deve conhecer o identificador de propriedade estendida para localizar e acessar a propriedade estendida. Se você precisar armazenar informações de configuração em itens diferentes de objetos de configuração do usuário, usar propriedades estendidas para criar propriedades personalizadas pode ser a solução para você. Propriedades estendidas permitem que você acesse e armazene informações sobre propriedades que não fazem parte da propriedade padrão definida para um item.

Importante

O esquema de banco de dados do Exchange tem um número finito de propriedades. O número máximo de identificadores de propriedade para um banco de dados do Exchange é 32.767. Se você estiver usando propriedades estendidas para armazenar muitas configurações, sugerimos que você use uma única propriedade estendida para armazenar essas configurações para que você não exceda esse máximo.

Você pode usar o método de API Gerenciada do Item.Update EWS ou a operação UpdateItem EWS para definir propriedades estendidas em objetos de configuração do usuário.

Itens personalizados

Itens personalizados também podem ser usados para armazenar informações. As propriedades de item existentes podem ser reaproveitadas para conter informações de configuração. Ou você pode usar propriedades estendidas para definir suas próprias propriedades para seu aplicativo. O uso de itens personalizados para armazenar a configuração fornece os seguintes benefícios:

Eles funcionam para todas as versões do Exchange que dão suporte ao EWS.
Se você não usar propriedades estendidas no item, o orçamento das propriedades do Exchange não será cobrado.

Onde devo armazenar minhas configurações de aplicativo?

As pastas de caixa de correio e os itens dentro delas estão localizados na pasta mensagem raiz. Essa pasta é identificada pelo valor WellKnownFolderName.msgfolderroot na API Gerenciada do EWS. Em termos MAPI, isso é o equivalente à sub-árvore IPM de uma caixa de correio. Os objetos de configuração do usuário geralmente são usados para criar configurações baseadas em interface do usuário, de modo que um aplicativo possa renderizar as configurações de exibição com base na pasta que um usuário está acessando. As configurações de exibição baseadas em pasta geralmente são definidas em um objeto de configuração do usuário associado à pasta. Mas, às vezes, talvez você queira tornar suas configurações globais para seu aplicativo. Nesse caso, você pode armazenar suas configurações na pasta mensagem raiz.

A maioria dos usuários não está ciente e normalmente não acessa a pasta de caixa de correio raiz. Essa pasta é identificada pelo valor WellKnownFolderName.root na API Gerenciada do EWS. Em termos MAPI, isso é o equivalente à sub-árvore não IPM de uma caixa de correio. As informações que os usuários finais não acessam diretamente são armazenadas na pasta caixa de correio raiz. Talvez você queira armazenar sua configuração de aplicativo nesta pasta porque os aplicativos cliente normalmente não a acessam.

Diferenças de versão

Os objetos de configuração do usuário estão disponíveis em Exchange Online, Exchange Online como parte de Office 365 e versões do Exchange a partir do Exchange 2010.