Usar a API REST de Email do Outlook

  • Artigo

O Microsoft Graph permite que o seu aplicativo obtenha acesso autorizado aos dados de email do Outlook do usuário em uma conta pessoal ou da organização. Com as permissões de email delegadas ou de aplicativo apropriadas, seu aplicativo pode acessar os dados de email do usuário conectado ou de qualquer usuário em um locatário. Para obter mais informações sobre tokens de acesso, registro de aplicativo e permissões delegadas e de aplicativo, confira Noções básicas de autenticação e autorização.

A API do Microsoft Graph é compatível com o acesso aos dados nas caixas de correio principais e em caixas de correio compartilhadas do usuário. Os dados podem ser calendário, email ou contatos pessoais na nuvem no Exchange Online como parte do Microsoft 365, ou no Exchange no local em uma implantação híbrida.

A API não é compatível com o acesso às caixas de correio de arquivo morto no local, não no Exchange Online, nem no Exchange Server.

Usar a API REST do email

As solicitações de API de email são realizadas em nome de um usuário que pode ser identificado pela propriedade id do usuário (um GUID exclusivo), endereço de email ou alias do atalho do me para o usuário conectado.

Email mensagens são representadas pelo recurso de mensagem e organizadas em um mailFolder. As mensagens e as pastas de email são identificadas por sua propriedade id , obtêveis de GET operações.

Importante

Em geral, não assuma que os IDs das mensagens e das pastas de correio são exclusivos e sempre permanecem os mesmos em uma caixa de correio. Eles podem mudar após determinadas ações, como copiar ou mover. Você pode optar por usar as IDs imutáveis para manter a mesma ID, desde que a mensagem permaneça na mesma caixa de correio, com exceção de envio de uma mensagem de rascunho e alguns outros cenários. Confira tempo de vida das IDs imutáveis para obter detalhes.

Os corpos de mensagens podem estar no formato HTML ou no formato de texto.

Você pode usar nomes comuns, como Inbox, Drafts, SentItems ou DeletedItems, para identificar certas pastas de email que existem por padrão para todos os usuários. Confira uma lista de nomes de pasta comuns com suporte em Tipo de recurso mailFolder.

Por exemplo, você pode obter mensagem na pasta Itens enviados do Outlook do usuário conectado, sem primeiro obter o ID da pasta:

GET /me/mailFolders('SentItems')/messages?$select=sender,subject

Casos de uso comuns

O recurso message expõe propriedades como categories, conversationId, flag e importance que correspondem a recursos disponíveis na interface do usuário, permitindo que os aplicativos automatizem ou integrem a experiência de usuário interna do Outlook.

A API do Microsoft Graph também fornece métodos e ações que ofereçam suporte a casos de uso comuns de mensagens.

Casos de uso Recursos REST Confira também
Ações centradas no usuário
Rascunho, ler, responder, encaminhar, enviar, atualizar ou excluir mensagens message Métodos de mensagem
Delegar outro usuário para enviar mensagens em nome do proprietário da caixa de correio message Configurar as propriedades from e sender em uma message
Permitir que o usuário visualize as mensagens mais importantes primeiro inferenceClassificationOverride Caixa de Entrada Prioritária
Consular mensagens e obtê-las em uma pasta de pesquisa mailSearchFolder Métodos de mailSearchFolder
Obter o conteúdo MIME de uma mensagem ou de um anexo de mensagem Mensagem Obter conteúdo de MIME
Enviar mensagens com conteúdo MIME mensagem Enviar conteúdo de MIME
Adicionar, obter ou excluir anexos de uma mensagem attachment,
fileAttachment,
itemAttachment,
referenceAttachment,
message		 Métodos de anexo
Acessar as opções de idioma e fuso horário para um usuário localeInfo,
timeZoneInformation		 supportedLanguages,
supportedTimeZones
Obter ou atualizar resposta automática, localidade, fuso horário ou horário de trabalho de um usuário mailboxSettings,
automaticRepliesSetting,
localeInfo,
workingHours		 Obter configurações da caixa de correio do usuário,
Atualizar configurações da caixa de correio do usuários
Obter MailTips do status especial de outros destinatários, como ausência temporária user,
mailTips		 Get MailTips
Gerenciamento de pasta e email
Organizar mensagens em uma hierarquia de pasta de email mailFolder Métodos de mailFolder
Categorizar mensagens outlookCategory Métodos de outlookCategory
Usar regras de Caixa de Entrada para automatizar ações como encaminhar mensagens de entrada específicas messageRule Métodos de messageRule
Obter cabeçalhos de mensagens da Internet de uma mensagem message Obter a propriedade internetMessageHeaders de uma mensagem.
Pesquisar e filtrar mensagens message Parâmetros de consulta
Receber notificações de alterações para as mensagens em uma pasta subscription Trabalhando com webhooks no Microsoft Graph
Sincronizar mensagens ou a hierarquia da pasta de email message Obter as alterações incrementais para as mensagens em uma pasta
Desenvolvimento de aplicativo
Adicionar dados de aplicativos personalizados como cabeçalhos de mensagens da Internet de uma mensagem message Adicione dados personalizados à propriedade internetMessageHeaders da mensagem.
Adicionar dados personalizados de aplicativo a uma mensagem usando extensões openTypeExtension,
schemaExtension		 Adicionar dados personalizados a recursos usando extensões
Acessar dados personalizados para propriedades subexpostas de MAPI do Outlook singleValueLegacyExtendedProperty,
multiValueLegacyExtendedProperty		 Visão geral das propriedades estendidas do Outlook

Próximas etapas

A API de email pode permitir novas formas de envolvimento com os usuários: