Referência de recurso para as APIs REST de Email, Calendário, Contatos e Tarefa (versão 2.0)

  • Artigo

Aplica-se a: Exchange Online | Office 365 | Hotmail.com | Live.com | MSN.com | Outlook.com | Passport.com

Este artigo descreve as entidades da API REST, propriedades, tipos complexos, enumerações e parâmetros de consulta OData que podem ser usados com as APIs de Email, Calendário, Contatos e Tarefa do Outlook para acessar os dados da caixa de correio do usuário no Office 365, Hotmail.com, Live.com, MSN.com, Outlook.com e Passport.com.

Observação

Para simplificar a referência, o restante deste artigo usa o Outlook.com para incluir esses domínios de conta da Microsoft.

Veja Usar a API REST do Outlook para obter mais informações comuns a todos os subconjuntos da API REST do Outlook.

Não tem interesse na v2.0 da API? No sumário à esquerda, vá para a seção Referência da API REST do Office 365 e selecione a versão que deseja.

Dica

É possível exibir o documento de metadados completo para o modelo de dados da entidade Email, Calendário, Contatos e Tarefa navegando até o ponto de extremidade $metadata em um navegador da Web (exemplo: https://outlook.office.com/api/v2.0/$metadata).

Anexo

Um arquivo ou item (contato, evento ou mensagem) anexado a um evento, mensagem, ou tarefa. Os recursos correspondentes fileAttachment, itemAttachment e referenceAttachment são derivados do recurso Attachment.

Tipo: Microsoft.OutlookServices.Entity

Propriedade Tipo Descrição Gravável? Filtrável?
ContentType Sequência de caracteres O tipo de MIME do anexo. Sim Não
IsInline Booleano true se o anexo for embutido; caso contrário, false. Sim Sim
LastModifiedDateTime DateTimeOffset Data e hora em que o anexo foi modificado pela última vez. A data e a hora usam o formato ISO 8601 e estão sempre no horário UTC.

Por exemplo, a meia-noite UTC de 1º de janeiro de 2014 ficaria assim: "2014-01-01T00:00:00Z"		 Não Sim
Nome Sequência de caracteres O nome de exibição do anexo. Não precisa ser o nome real do arquivo. Sim Sim
Tamanho Int32 O comprimento do anexo em bytes. Não Não

Calendário

Um calendário que é um contêiner para eventos.

Tipo: Microsoft.OutlookServices.Calendar

Uma coleção de calendários retorna uma matriz de calendários na propriedade valor da resposta OData. Use $count para obter a contagem de entidades na coleção: .../me/calendars/$count

Veja Operações de calendário para ações suportadas.

Propriedade Tipo Descrição Gravável? Filtrável?
CanEdit Booleano Verdadeira se o usuário pode gravar o calendário, falsa caso contrário. Essa propriedade é verdadeira para o usuário que criou o calendário. Esta propriedade também é verdadeira para um usuário com o qual tenha sido compartilhado um calendário e tenha sido concedido acesso de gravação. Não Sim
CanShare Booleano Verdadeira se o usuário tem permissão para compartilhar o calendário, falsa caso contrário. Somente o usuário que criou o calendário pode compartilhá-lo. Não Sim
CanViewPrivateItems Booleano Verdadeira se o usuário pode ler itens do calendário que foram marcados como particulares, falsa caso contrário. Não Sim
ChangeKey Sequência de caracteres Identifica a versão do objeto de calendário. Toda vez que o calendário é alterado, ChangeKey também é alterado. Isso permite que o Exchange aplique alterações na versão correta do objeto. Não Não
Cor CalendarColor Especifica o tema de cores para distinguir o calendário de outros calendários em uma interface do usuário. Os valores de propriedade são: LightBlue=0, LightGreen=1, LightOrange=2, LightGray=3, LightYellow=4, LightTeal=5, LightPink=6, LightBrown=7, LightRed=8, MaxColor=9, Auto=-1 Sim Sim
Id Sequência de caracteres Identificador exclusivo do calendário. Não Não
Nome Sequência de caracteres O nome do calendário. Sim Sim
Owner EmailAddress Se definido, isso representa o usuário que criou ou adicionou o calendário. Para um calendário que o usuário criou ou adicionou, a propriedade Proprietário é definida para o usuário. Para um calendário compartilhado com o usuário, a propriedade Proprietário é definida para a pessoa que compartilhou o calendário com o usuário. Não Sim
CalendarView Coleção (Evento) A visão de calendário para o calendário. Propriedade de navegação. Não Não
Eventos Coleção (Evento) Os eventos no calendário. Propriedade de navegação. Não Não
MultiValueExtendedProperties A coleção Uma coleção de propriedades estendidas de vários valores do tipo MultiValueLegacyExtendedProperty. Essa é uma propriedade de navegação.

Encontre mais informações sobre propriedades estendidas.		 Sim Sim
SingleValueExtendedProperties A coleção Uma coleção de propriedades estendidas de valor único do tipo SingleValueLegacyExtendedProperty. Essa é uma propriedade de navegação.

Encontre mais informações sobre propriedades estendidas.		 Sim Sim

CalendarGroup

Um grupo de calendários.

Observação

O Outlook.com tem suporte apenas para o grupo de calendários padrão que é acessível pelo atalho ../me/calendars. Você não pode excluir esse grupo de calendários.

Tipo: Microsoft.OutlookServices.CalendarGroup

Uma coleção CalendarGroup retorna uma matriz de grupos de calendários na propriedade valor da resposta OData. Use $count para obter a contagem de entidades na coleção: .../me/calendargroups/$count

Veja Operações do CalendarGroup para ações suportadas.

Propriedade Tipo Descrição Gravável? Filtrável?
Nome Sequência de caracteres O nome do grupo. Sim Sim
ChangeKey Sequência de caracteres Descrição Toda vez que o grupo de calendários é alterado, ChangeKey também é alterado. Isso permite que o Exchange aplique alterações na versão correta do objeto. Não Não
ClassId Sequência de caracteres O identificador da classe. Não Sim
Id Sequência de caracteres Os calendários do grupo de calendários. Não Não
Calendários Coleção (Calendário) Os calendários no grupo de calendários. Propriedade de navegação. Não Não

Contato

Um contato, que é um item no Outlook para que os usuários organizem e salvem informações sobre as pessoas e organizações com as quais se comunicam. Os contatos estão contidos em pastas de contatos.

Tipo: Microsoft.OutlookServices.Contact

Uma coleção Contato retorna uma matriz de contatos na propriedade valor da resposta OData. Use $count para obter a contagem de entidades na coleção: .../me/contacts/$count

Veja Operações de contato para ações suportadas.

Propriedade Tipo Descrição Gravável? Filtrável?
AssistantName Sequência de caracteres O nome do assistente do contato. Sim Sim
Birthday datetimeoffset O aniversário do contato. Sim Sim
BusinessAddress PhysicalAddress O endereço comercial do contato. Sim Sim
BusinessHomePage Sequência de caracteres A home page comercial do contato. Sim Sim
BusinessPhones Coleção (Sequência de caracteres) Os números de telefone comerciais do contato. Sim Não
Categorias Coleção (Sequência de caracteres) As categorias associadas ao contato. Sim Não
ChangeKey Sequência de caracteres Identifica a versão do contato. Toda vez que o contato é alterado, ChangeKey também é alterado. Isso permite que o Exchange aplique alterações na versão correta do objeto. Não Não
Children Coleção (Sequência de caracteres) Os nomes dos filhos do contato. Sim Sim
CompanyName Sequência de caracteres O nome da empresa do contato. Sim Sim
Department Sequência de caracteres O departamento do contato. Sim Sim
CreatedDateTime datetimeoffset A hora em que o contato foi criado. Não Sim
LastModifiedDateTime datetimeoffset A hora em que o contato foi modificado. Não Sim
DisplayName Sequência de caracteres O nome para exibição do contato. Sim Sim
EmailAddresses Coleção (EmailAddress) Os endereços de email do contato. Sim Não
Extensões Coleção (Extensão) A coleção de extensões de dados de tipo aberto definida para o contato. Propriedade de navegação. Não Sim
FileAs Sequência de caracteres O nome com o qual o contato está arquivado. Sim Sim
Generation Sequência de caracteres A geração do contato. Sim Sim
GivenName Sequência de caracteres O nome do contato. Sim Sim
HomeAddress PhysicalAddress O endereço residencial do contato. Sim Sim
HomePhones Coleção (Sequência de caracteres) Os números de telefone residenciais do contato. Sim Não
Id Sequência de caracteres O identificador exclusivo do contato. Não Não
ImAddresses Coleção (Sequência de caracteres) Os endereços de mensagens instantâneas do contato. Sim Não
Initials Sequência de caracteres As iniciais do contato. Sim Sim
JobTitle Sequência de caracteres O cargo do contato. Sim Sim
Manager Sequência de caracteres O nome do gerente do contato. Sim Sim
MiddleName Sequência de caracteres O nome do meio do contato. Sim Sim
MobilePhone1 Sequência de caracteres O número de celular do contato. Sim Sim
NickName Sequência de caracteres O apelido do contato. Sim Sim
OfficeLocation Sequência de caracteres O local do escritório do contato. Sim Sim
OtherAddress PhysicalAddress Outros endereços do contato. Sim Sim
ParentFolderId Sequência de caracteres A ID da pasta pai do contato. Não Não
PersonalNotes Sequência de caracteres As anotações do usuário sobre o contato. Sim Sim
Profession Sequência de caracteres A profissão do contato. Sim Sim
SpouseName Sequência de caracteres O nome do cônjuge do contato. Sim Sim
Surname Sequência de caracteres O sobrenome do contato. Sim Sim
Título Sequência de caracteres O título do contato. Sim Não
YomiCompanyName Sequência de caracteres O nome de empresa japonês fonético do contato. Sim Não
YomiGivenName Sequência de caracteres O nome japonês fonético do contato. Sim Não
YomiSurname Sequência de caracteres O sobrenome japonês fonético do contato. Sim Não

As propriedades de navegação MultiValueExtendedProperties e SingleValueExtendedProperties também estão disponíveis para este recurso para representar as coleções dos respectivos tipos de propriedades estendidas definidas para uma instância de recurso. Para mais informações, veja API REST de Propriedades Estendidas.

ContactFolder

Uma pasta que contém contatos.

Tipo: Microsoft.OutlookServices.ContactFolder

Uma coleção ContactFolder retorna uma matriz de pastas de contatos na propriedade valor da resposta OData. Use $count para obter a contagem de entidades na coleção: .../me/contactfolders/$count

Veja Operações de ContactFolder para ações suportadas.

Propriedade Tipo Descrição Gravável? Filtrável?
ChildFolders Coleção (ContactFolder) A coleção de pastas filhas na pasta. Propriedade de navegação. Não Não
Contatos Coleção (Contato) Os contatos na pasta. Propriedade de navegação. Não Não
DisplayName Sequência de caracteres O nome de exibição da pasta. Sim Sim
Id Sequência de caracteres Identificador exclusivo da pasta de contatos. Não Não
ParentFolderId Sequência de caracteres A ID da pasta pai da pasta. Não Não
MultiValueExtendedProperties A coleção Uma coleção de propriedades estendidas de vários valores do tipo MultiValueLegacyExtendedProperty. Essa é uma propriedade de navegação.

Encontre mais informações sobre propriedades estendidas.		 Sim Sim
SingleValueExtendedProperties A coleção Uma coleção de propriedades estendidas de valor único do tipo SingleValueLegacyExtendedProperty. Essa é uma propriedade de navegação.

Encontre mais informações sobre propriedades estendidas.		 Sim Sim

Evento

Um evento em um calendário.

Tipo: Microsoft.OutlookServices.Event

Uma coleção Evento retorna uma matriz de eventos na propriedade valor da resposta OData. Use $count para obter a contagem de entidades na coleção: .../me/events/$count

Veja Operações de Evento para ações suportadas.

Propriedade Tipo Descrição Gravável? Filtrável?
Anexos Coleção (Anexo) A coleção de anexos FileAttachment, ItemAttachmente ReferênciaAttachment para o evento. Propriedade de navegação. Não Não
Attendees Coleção (Participante) A coleção de participantes do evento. Sim Não
Body ItemBody O corpo da mensagem associada ao evento. Sim Não
BodyPreview Sequência de caracteres A visualização da mensagem associada ao evento. Não Não
Calendário Calendário O calendário que contém o evento. Propriedade de navegação. Não Não
Categorias Coleção (Sequência de caracteres) As categorias associadas ao evento. Sim Não
ChangeKey Sequência de caracteres Identifica a versão do objeto event. Toda vez que o evento muda, ChangeKey também muda. Isso permite que o Exchange aplique alterações à versão correta do objeto. Não Não
CreatedDateTime datetimeoffset A data e hora em que o evento foi criado. Não Sim
LastModifiedDateTime datetimeoffset A data e a hora em que o evento foi modificado pela última vez. Não Sim
End DateTimeTimeZone O horário final do evento. Sim Sim
Extensões Coleção (Extensão) A coleção de extensões de dados de tipo aberto definida para o evento. Propriedade de navegação. Não Sim
HasAttachments booleano Definir como verdadeiro se o evento tiver anexos. Não Sim
Id Sequência de caracteres O identificador exclusivo do evento. Não Não
Importance Importance A importância do evento: Low, Normal, High. Sim Sim
Instances Coleção (Evento) As instâncias do evento. Propriedade de navegação. Não Não
iCalUId Sequência de caracteres Um identificador exclusivo que é compartilhado por todas as instâncias de um evento em calendários diferentes. Não Sim
IsAllDay booleano Definir como verdadeiro se o evento durar o dia inteiro. Ajustar esta propriedade requer também o ajuste das propriedades Início e Fim do evento. Sim Sim
IsCancelled booleano Definir como verdadeiro se o evento tiver sido cancelado. Sim Sim
IsOrganizer booleano Definir como verdadeiro se o remetente da mensagem também for o organizador. Sim Sim
IsReminderOn Booleano Definir como verdadeiro se um alerta estiver definido para lembrar o usuário sobre o evento. Sim Sim
Location Location O local do evento. Sim Sim
OnlineMeetingUrl Sequência de caracteres Uma URL para uma reunião online. Sim Não
Organizer Destinatário O organizador do evento. Sim Sim
OriginalEndTimeZone Sequência de caracteres O fuso horário de término que foi definido quando o evento foi criado. Veja DateTimeTimeZone para uma lista de fusos horários válidos. Não Sim
OriginalStartTimeZone Sequência de caracteres O fuso horário de início que foi definido quando o evento foi criado. Veja DateTimeTimeZone para uma lista de fusos horários válidos. Não Sim
Recorrência PatternedRecurrence O padrão de recorrência do evento. Sim Não
ReminderMinutesBeforeStart Int32 O número de minutos antes da hora de início do evento em que o alerta de lembrete ocorre. Sim Não
ResponseRequested booleano Definir como verdadeiro se o remetente quiser receber uma resposta quando o evento for aceito ou recusado. Sim Sim
ResponseStatus ResponseStatus Indica o tipo de resposta enviada em resposta a uma mensagem de evento. Não Sim
Sensitivity Sensitivity Indica o nível de privacidade do evento: Normal = 0, Pessoal = 1, Particular = 2, Confidencial = 3. Sim Sim
SeriesMasterId Sequência de caracteres As categorias atribuídas ao item. Sim Não
ShowAs FreeBusyStatus O status a ser exibido: Livre = 0, Provisório = 1, Ocupado = 2, Ausente = 3, Trabalhando em outro lugar = 4, Desconhecido = -1. Sim Sim
Iniciar DateTimeTimeZone A hora de início do evento. Sim Sim
Tipo EventType O tipo de evento: Instância única = 0, Ocorrência = 1, Exceção = 2, Mestre de Séries = 3. Sim Sim
WebLink Sequência de caracteres A URL para abrir o evento no Outlook Web App.

O evento será aberto no navegador se você estiver conectado à sua caixa de correio por meio do Outlook Web App. Você será solicitado a fazer logon se ainda não estiver conectado no navegador.

Essa URL pode ser acessada de um iFrame.		 Não Não

As propriedades de navegação MultiValueExtendedProperties e SingleValueExtendedProperties também estão disponíveis para este recurso para representar as coleções dos respectivos tipos de propriedades estendidas definidas para uma instância de recurso. Para mais informações, veja API REST de Propriedades Estendidas.

EventMessage

Uma mensagem que representa uma solicitação de reunião, mensagem de cancelamento de reunião, mensagem de aceitação de reunião, mensagem de aceitação temporária de reunião ou mensagem de recusa de reunião.

Tipo base: Mensagem

Normalmente, uma instância EventMessage é encontrada na pasta Caixa de entrada, chegando quando um organizador de evento cria uma reunião ou quando um participante responde a uma solicitação de reunião. Você age de acordo com as mensagens do evento da mesma forma que age em Message, com algumas pequenas diferenças descritas na tabela a seguir.

Ação/Verbo Permissão Descrição
Crie uma mensagem de evento (POST) N/D Não permitido. Resultará em um código de resposta 400.
Atualizar uma mensagem de evento (PATCH) Mail.Write Você pode atualizar as propriedades De, Remetente, ToRecipients, CcRecipients, BccRecipients, ReplyTo, IsDeliveryReceiptRequested, IsReadReceiptRequested, IsDraft, IsRead, Assunto, Corpo, Importância e Categorias.
Excluir uma mensagem de evento (DELETE) Mail.Write Mesma ação como para uma Mensagem.
Mover uma mensagem de evento (POST) Mail.Write Mesma ação como para uma Mensagem.
Copiar uma mensagem de evento (POST) Mail.Write Mesma ação como para uma Mensagem.
Criar um rascunho de mensagem de resposta Mail.Write Mesma ação como para uma Mensagem.
Criar rascunho de mensagem de resposta a todos (POST) Mail.Write Mesma ação como para uma Mensagem.
Criar uma resposta (POST) Mail.Write Mesma ação como para uma Mensagem.
Criar uma resposta a todos (POST) Mail.Write Mesma ação como para uma Mensagem.
Enviar uma mensagem de evento existente (POST) Mail.Write Você só pode enviar uma mensagem de evento em que a propriedade IsDraft tem um valor de verdadeiro. A mensagem é então salva na pasta Itens Enviados.
Criar um rascunho de mensagem de encaminhamento de evento Mail.Write Mesma ação como para uma Mensagem.
Encaminhar uma mensagem de evento Mail.Write Mesma ação como para uma Mensagem.

A instância EventMessage inclui propriedades do tipo base Mensageme as propriedades na tabela a seguir.

Propriedade Tipo Descrição Gravável? Filtrável?
Evento Evento O evento associado à mensagem do evento. A premissa para participantes ou recursos da sala é que o Atendedor de Calendário está configurado para atualizar automaticamente o calendário com um evento quando as mensagens do evento de solicitação de reunião chegarem. Propriedade de navegação. Não Não
MeetingMessageType MeetingMessageType O tipo de mensagem de evento: Nenhum = 0, MeetingRequest = 1, MeetingCancelled = 2, MeetingAccepted = 3, MeetingTentativelyAccepted = 4, MeetingDeclined = 5 Não Sim

EventMessageRequest (versão prévia)

No momento, este recurso está disponível na versão beta. Para saber mais, no sumário à esquerda, vá para a seção Referência da API REST do Office 365 e selecione beta.

Propriedades estendidas

Você pode criar uma propriedade personalizada em uma entidade como MultiValueLegacyExtendedProperty ou SingleValueLegacyExtendedProperty, dependendo dos valores pretendidos para a propriedade.

MultiValueLegacyExtendedProperty

Uma propriedade estendida que pode conter uma coleção de vários valores.

Tipo: Microsoft.OutlookServices.MultiValueLegacyExtendedProperty

Propriedade Tipo Descrição Gravável? Filtrável?
Valor Coleção (Sequência de caracteres) Uma coleção de valores de propriedade. Sim Não
PropertyId Sequência de caracteres O ID da propriedade. Isso é usado para identificar a propriedade. Não Não

SingleValueLegacyExtendedProperty

Uma propriedade estendida que contém um único valor.

Tipo: Microsoft.OutlookServices.SingleValueLegacyExtendedProperty

Propriedade Tipo Descrição Gravável? Filtrável?
Valor Sequência de caracteres Um valor de propriedade. Sim Não
PropertyId Sequência de caracteres O ID da propriedade. Isso é usado para identificar a propriedade. Não Sim

Ao criar uma propriedade estendida, existem várias maneiras de especificar PropertyId. Veja Formatos PropertyId para detalhes.

Veja o Referência da API REST de propriedades estendidas para as operações relacionadas que você pode usar.

FileAttachment

Um arquivo (como um arquivo de texto ou documento do Word) anexado a uma mensagem, evento ou tarefa. A propriedade ContentBytes inclui os conteúdos codificados em base64 do arquivo. Derivado da entidade Anexo.

Tipo: Microsoft.OutlookServices.FileAttachment

Tipo base: Microsoft.OutlookServices.Attachment

Propriedade Tipo Descrição Gravável?
ContentBytes binário O conteúdo binário do arquivo. Não
ContentId Sequência de caracteres A ID do anexo no repositório do Exchange. Não
ContentLocation Sequência de caracteres O URI (Uniform Resource Identifier) que corresponde ao local do conteúdo do anexo. Não
ContentType Sequência de caracteres O tipo de conteúdo do anexo. Sim
LastModifiedDateTime datetimeoffset Data e hora em que o anexo foi modificado pela última vez. Não
Id Sequência de caracteres A ID do anexo. Não
IsInline booleano Definir como verdadeiro se este for um anexo embutido. Sim
Nome Sequência de caracteres O nome que representa o texto que é exibido abaixo do ícone que representa o anexo inserido. Não precisa ser o nome de arquivo real. Sim
Tamanho Int32 O tamanho do anexo em bytes. Não

Pasta/MailFolder

Observação

Na versão v2.0, a entidade e o tipo anteriormente conhecidos como Folder foram renomeados como MailFolder.

Uma pasta na caixa de correio de um usuário, como Caixa de entrada, Rascunhos e Itens Enviados. Pastas podem conter mensagens e outras pastas.

Tipo: Microsoft.OutlookServices.MailFolder

Uma coleção MailFolders retorna uma matriz de pastas na propriedade valor da resposta OData. Use $count para obter a contagem de entidades na coleção: .../me/folders/$count

Veja Operações de pasta para ações suportadas.

Propriedade Tipo Descrição Gravável? Filtrável?
ChildFolderCount Int32 O número de pastas na pasta. Não Sim
ChildFolders Coleção (MailFolder) A coleção de pastas filhas na pasta. Propriedade de navegação. Não Não
DisplayName Sequência de caracteres O nome de exibição da pasta. Sim Sim
Id Sequência de caracteres Identificador exclusivo da pasta. Você pode usar os seguintes nomes conhecidos para acessar a pasta correspondente: Inbox, Drafts, SentItems, DeletedItems. Não Não
Mensagens Coleção (Mensagem) A coleção de mensagens na pasta. Propriedade de navegação. Não Não
ParentFolderId Sequência de caracteres O identificador exclusivo da pasta pai da pasta. Não Não
TotalItemCount Int32 O número de itens na pasta. Não Sim
UnreadItemCount Int32 O número de itens na pasta marcados como não lidos. Não Sim
MultiValueExtendedProperties A coleção Uma coleção de propriedades estendidas de vários valores do tipo MultiValueLegacyExtendedProperty. Essa é uma propriedade de navegação.

Encontre mais informações sobre propriedades estendidas.		 Sim Sim
SingleValueExtendedProperties A coleção Uma coleção de propriedades estendidas de valor único do tipo SingleValueLegacyExtendedProperty. Essa é uma propriedade de navegação.

Encontre mais informações sobre propriedades estendidas.		 Sim Sim

Acessar contagens de itens de forma eficiente

As propriedades TotalItemCount e UnreadItemCount de uma pasta permitem que você calcule convenientemente o número de itens lidos na pasta. Eles permitem que você evite consultas como as seguintes, que podem incorrer em latência significativa:

https://outlook.office.com/api/v2.0/me/mailfolders/inbox/messages?$count=true&$filter=isread%20eq%20false

Pastas no Outlook podem conter mais de um tipo de itens, por exemplo, a Caixa de entrada pode conter itens de solicitação de reunião que são distintos dos itens de email. TotalItemCount e UnreadItemCount incluem itens em uma pasta, independentemente de seus tipos de item.

InferenceClassification

Classificação das mensagens de um usuário para possibilitar a atenção nas mensagens que são mais relevantes ou importantes para o usuário.

Tipo: Microsoft.OutlookServices.InferenceClassification

Propriedade Tipo Descrição Gravável?
Substituições Coleção (InferenceClassificationOverride) Um conjunto de substituições para um usuário sempre classificar mensagens de remetentes específicos de determinadas maneiras, conforme suportado por InferenceClassificationType. Propriedade de navegação. Sim

InferenceClassificationOverride

Representa a substituição de um usuário para definir como classificar as mensagens recebidas de um remetente específico.

Tipo: Microsoft.OutlookServices.InferenceClassificationOverride

Propriedade Tipo Descrição Gravável?
ClassifyAs InferenceClassificationType Especifica como as mensagens recebidas de um remetente específico sempre devem ser classificadas. Focalizado = 0, Outro = 1. Sim
Id Sequência de caracteres O identificador exclusivo da substituição. Não
SenderEmailAddress EmailAddress As informações de endereço de email do remetente para quem a substituição é criada. Sim

ItemAttachment

Uma mensagem, contato ou evento anexado a outra mensagem, evento ou tarefa. Derivado da entidade Anexo.

Tipo: Microsoft.OutlookServices.ItemAttachment

Tipo base: Microsoft.OutlookServices.Attachment

Propriedade Tipo Descrição Gravável?
ContentType Sequência de caracteres O tipo de conteúdo do anexo. Sim
LastModifiedDateTime datetimeoffset Última data e hora em que o anexo foi alterado. Não
Id Sequência de caracteres A ID do anexo. Não
Item Item A mensagem ou evento anexado. Propriedade de navegação. Sim
IsInline booleano Definir como verdadeiro se o anexo estiver embutido, como uma imagem incorporada no corpo do item. Sim
Nome Sequência de caracteres O nome de exibição do anexo. Sim
Tamanho Int32 O tamanho do anexo em bytes. Sim

Menção (versão prévia)

Atualmente, este recurso está disponível somente na versão beta. Para saber mais, no sumário à esquerda, vá para a seção Referência da API REST do Office 365 e selecione beta.

Message

Uma mensagem em uma pasta de caixa de correio.

Tipo: Microsoft.OutlookServices.Message

Uma coleção Mensagem retorna uma matriz de mensagens na propriedade valor da resposta OData. Use $count para obter a contagem de entidades na coleção: .../me/messages/$count

Veja Operações Mensagem para ações suportadas.

Propriedade Tipo Descrição Gravável? Filtrável? Pesquisável?
Anexos Coleção (Anexo) Os anexos FileAttachment e ItemAttachment da mensagem. Propriedade de navegação. Sim Não Sim
BccRecipients Coleção (Destinatário) Os destinatários em Cco da mensagem. Sim Não Sim
Body ItemBody O corpo da mensagem. Sim Não Padrão
BodyPreview Sequência de caracteres Os primeiros 255 caracteres do conteúdo do corpo da mensagem. Não Não Sim
Categorias Coleção (Sequência de caracteres) As categorias associadas à mensagem. Sim Sim Sim
CcRecipients Coleção (Recipient) Os destinatários em cópia da mensagem. Sim Não Sim
ChangeKey Sequência de caracteres A versão da mensagem. Não Não Não
ConversationId Sequência de caracteres A ID da conversa à qual o email pertence. Não Sim Não
CreatedDateTime datetimeoffset A data e a hora em que a mensagem foi criada. Não Sim Não
Extensões Coleção (Extensão) A coleção de extensões de dados de tipo aberto definida para a mensagem. Propriedade de navegação. Não Sim Não
From Destinatário O proprietário da caixa de correio e o remetente da mensagem. Sim Sim Sim
HasAttachments booleano Indica se a mensagem tem anexos. Não Sim Sim
Id Sequência de caracteres O identificador exclusivo da mensagem. Não Não Não
Importance Importance A importância da mensagem: Baixa = 0, Normal = 1, Alta = 2. Sim Sim Sim
InferenceClassification InferenceClassificationType A classificação dessa mensagem para o usuário, com base na relevância ou na importância inferida, ou em uma substituição explícita. Sim Sim Sim
IsDeliveryReceiptRequested booleano Indica se uma confirmação de leitura foi solicitada para a mensagem. Sim Sim Não
IsDraft booleano Indica se a mensagem é um rascunho. Uma mensagem é um rascunho quando ela ainda não foi enviada. Não Sim Não
IsRead booleano Indica se a mensagem foi lida. Sim Sim Não
IsReadReceiptRequested booleano Indica se uma confirmação de leitura foi solicitada para a mensagem. Sim Sim Não
LastModifiedDateTime datetimeoffset A data e a hora em que a mensagem foi alterada pela última vez. Não Sim Não
MultiValueExtendedProperties A coleção Uma coleção de propriedades estendidas de vários valores do tipo MultiValueLegacyExtendedProperty. Essa é uma propriedade de navegação.

Encontre mais informações sobre propriedades estendidas.		 Sim Sim Não
ParentFolderId Sequência de caracteres O identificador exclusivo da pasta pai da mensagem. Não Não Não
ReceivedDateTime datetimeoffset A data e a hora em que a mensagem foi recebida. Não Sim Sim
ReplyTo Coleção (Recipient) Os endereços de email a serem usados ao responder. Não Não Não
Sender Destinatário A conta que é realmente usada para gerar a mensagem. Sim Sim Padrão
SingleValueExtendedProperties A coleção Uma coleção de propriedades estendidas de valor único do tipo SingleValueLegacyExtendedProperty. Essa é uma propriedade de navegação.

Encontre mais informações sobre propriedades estendidas.		 Sim Sim Não
SentDateTime datetimeoffset A data e a hora em que a mensagem foi enviada. Não Sim Não
Subject Sequência de caracteres O assunto da mensagem. Sim Sim Padrão
ToRecipients Coleção (Recipient) Os destinatários To da mensagem. Sim Não Sim
UniqueBody ItemBody O corpo da mensagem que é exclusivo à conversa. Não Não Não
WebLink Sequência de caracteres A URL para abrir a mensagem no Outlook Web App.

Você pode acrescentar um argumento ispopout ao final da URL para alterar como a mensagem é exibida. Se ispopout não houver presente ou estiver definido como 1, a mensagem será mostrada em uma janela pop-up. Se ispopout estiver definido como 0, o navegador mostrará a mensagem no painel de revisão do Outlook Web App.

A mensagem será aberta no navegador se você estiver conectado à sua caixa de correio por meio do Outlook Web App. Você será solicitado a fazer logon se ainda não estiver conectado no navegador.

Essa URL pode ser acessada de um iFrame.		 Não Sim Não

Remover o script da propriedade Body

O corpo da mensagem pode ser HTML ou texto. Se o corpo for HTML, por padrão, qualquer HTML potencialmente inseguro (por exemplo, JavaScript) incorporado na propriedade Body seria removido antes que o conteúdo do corpo fosse retornado em uma resposta REST.

Para obter todo o conteúdo HTML original, inclua o seguinte cabeçalho de solicitação HTTP:

Prefer: outlook.allow-unsafe-html

Configurar as propriedades From e Sender

Quando uma mensagem está sendo redigida, na maioria dos casos, as propriedades From e Sender representam o mesmo usuário conectado, a menos que ela seja atualizada conforme descrito nos seguintes cenários:

  • A propriedade De pode ser alterada se o administrador do Exchange tiver atribuído os direitos SendAs da caixa de correio para alguns outros usuários. O administrador pode fazer isso selecionando Permissões de caixa de correio do proprietário da caixa de correio no Portal de Gerenciamento do Azure ou usando o Centro de administração do Exchange ou um cmdlet Add-ADPermission do Windows PowerShell. Em seguida, você pode definir programaticamente a propriedade De para um desses usuários que têm os direitos SendAs para essa caixa de correio.

  • A propriedade Remetente pode ser alterada se o proprietário da caixa de correio tiver delegado um ou mais usuários para poder enviar mensagens dessa caixa de correio. O proprietário da caixa de correio pode delegar no Outlook. Quando um representante envia uma mensagem em nome do proprietário da caixa de correio, a propriedade Remetente é definida para a conta do representante, e a propriedade De permanece como o proprietário da caixa de correio. Programaticamente, você pode definir a propriedade Remetente para um usuário que tenha o direito de representante para essa caixa de correio.

MessageRule (versão prévia)

No momento, este recurso está disponível na versão beta. Para saber mais, no sumário à esquerda, vá para a seção Referência da API REST do Office 365 e selecione beta.

OutlookCategory (versão prévia)

No momento, este recurso está disponível na versão beta. Para saber mais, no sumário à esquerda, vá para a seção Referência da API REST do Office 365 e selecione beta.

Photo

Tipo: Microsoft.OutlookServices.Photo

Uma foto acessada do Exchange Online. São dados binários não codificados em base64.

Propriedade Tipo Descrição Gravável? Filtrável?
Altura int A altura da foto Não Não
Id Sequência de caracteres O identificador exclusivo da foto. Não Não
Largura int A largura da foto. Não Não

ReferenceAttachment

Tipo: Microsoft.OutlookServices.ReferenceAttachment

Tipo base: Microsoft.OutlookServices.Attachment

Um link para um arquivo ou pasta, anexado a uma mensagem, evento ou tarefa. Os possíveis locais para o arquivo ou pasta incluem o OneDrive, o OneDrive for Business e o DropBox. Derivado da entidade Anexo.

Propriedade Tipo Descrição Gravável? Filtrável?
ContentType Sequência de caracteres O tipo de MIME do anexo. Opcional. Sim Não
Id Sequência de caracteres O identificador exclusivo do anexo de referência. Não Não
IsFolder Booleano Especifica se o anexo é um link para uma pasta. Deve definir isso como verdadeiro se SourceUrl for um link para uma pasta. Opcional. Sim Não
IsInline Booleano true se o anexo for embutido; caso contrário, false. Opcional. Sim Sim
LastModifiedDateTime DateTimeOffset Data e hora em que o anexo foi modificado pela última vez. A data e a hora usam o formato ISO 8601 e estão sempre no horário UTC. Por exemplo, a meia-noite UTC de 1º de janeiro de 2014 ficaria assim: '2014-01-01T00:00:00Z'. Opcional. Não Sim
Nome Sequência de caracteres O nome de exibição do anexo. Não precisa ser o nome real do arquivo. Obrigatório. Sim Sim
Permissão ReferenceAttachmentPermissions Especifica as permissões concedidas para o anexo pelo tipo de provedor em ProviderType. Os valores possíveis são: Other, View, Edit, AnonymousView, AnonymousEdit, OrganizationView, OrganizationEdit. Opcional. Sim Não
PreviewUrl Sequência de caracteres Aplica-se apenas a um anexo de referência de uma imagem - URL para obter uma imagem de visualização. Usar ThumbnailUrl e PreviewUrl apenas quando SourceUrl identifica um arquivo de imagem. Opcional. Sim Não
ProviderType ReferenceAttachmentProviders O tipo de provedor que suporta um anexo deste ContentType. Os valores possíveis são: Other, OneDriveBusiness, OneDriveConsumer, Dropbox. Opcional. Sim Sim
Tamanho Int32 O comprimento do anexo em bytes. Opcional. Não Não
SourceUrl Sequência de caracteres URL para obter o conteúdo do anexo. Se este for um URL para uma pasta, para que a pasta seja exibida corretamente no Outlook ou Outlook na Web, defina IsFolder como verdadeiro. Obrigatório. Sim Não
ThumbnailUrl Sequência de caracteres Aplica-se apenas a um anexo de referência de uma imagem - URL para obter uma imagem em miniatura. Usar ThumbnailUrl e PreviewUrl apenas quando SourceUrl identifica um arquivo de imagem. Opcional. Sim Não

Tarefa

Tipo: Microsoft.OutlookServices.Task

Um item do Outlook que pode acompanhar um item de trabalho. Você pode usar uma tarefa para acompanhar as datas e horas de início, vencimento e conclusão real, seu progresso ou status, se é recorrente e requer lembrete.

Para cada uma das seguintes propriedades relacionadas à data:

  • CompletedDateTime
  • CreatedDateTime
  • DueDateTime
  • LastModifiedDateTime
  • ReminderDateTime
  • StartDateTime

Se a propriedade estiver definida, por padrão, a API REST da tarefa a retornará em UTC em uma resposta REST. Encontre mais informações sobre como definir StartDateTime e DueDateTime e retornar propriedades relacionadas à data em um fuso horário personalizado.

Propriedade Tipo Descrição Gravável? Filtrável?
AssignedTo Sequência de caracteres O nome da pessoa que recebeu a tarefa. Não Sim
Anexos Coleção (Anexo) A coleção de anexos FileAttachment e ItemAttachment para a tarefa. Propriedade de navegação. Não Não
Body ItemBody O corpo da tarefa que geralmente contém informações sobre a tarefa. Observe que apenas o tipo HTML é suportado. Sim Não
Categorias Coleção (Sequência de caracteres) As categorias associadas à tarefa. Sim Sim
ChangeKey Sequência de caracteres A versão da tarefa. Não Não
CompletedDateTime DateTimeTimeZone A data no fuso horário especificado em que a tarefa foi concluída. Sim Sim
CreatedDateTime DateTimeOffset A data e hora em que a tarefa foi criada. Por padrão, está em UTC. Você pode fornecer um fuso horário personalizado no cabeçalho da solicitação. Não Sim
DueDateTime DateTimeTimeZone A data no fuso horário especificado em que a tarefa deve ser concluída. Sim Sim
HasAttachments booleano Definida como verdadeira se a tarefa tiver anexos. Não Sim
Id Sequência de caracteres O identificador exclusivo da tarefa. Não Não
Importance Importance A importância do evento: Low, Normal, High. Sim Sim
IsReminderOn booleano Definido como verdadeiro se um alerta estiver definido para lembrar o usuário sobre a tarefa. Sim Não
LastModifiedDateTime DateTimeOffset A data e hora em que a tarefa foi modificada pela última vez. Por padrão, está em UTC. Você pode fornecer um fuso horário personalizado no cabeçalho da solicitação. Não Sim
Owner Sequência de caracteres O nome da pessoa que criou a tarefa. Não Sim
ParentFolderId Sequência de caracteres O identificador exclusivo da pasta pai da tarefa. Não Não
Recorrência PatternedRecurrence O padrão de recorrência da tarefa. Sim Não
ReminderDateTime DateTimeTimeZone A data e hora em que um alerta de lembrete da tarefa deve ocorrer. Sim Não
Sensitivity Sensitivity Indica o nível de privacidade do evento: Normal, Personal, Private, Confidential. Sim Sim
StartDateTime DateTimeTimeZone A data no fuso horário especificado quando a tarefa deve começar. Sim Sim
Status TaskStatus Indica o estado ou progresso da tarefa: NotStarted, InProgress, Completed, WaitingOnOthers, Deferred. Sim Sim
Subject Sequência de caracteres Uma breve descrição ou título da tarefa. Sim Sim

TaskFolder

Tipo: Microsoft.OutlookServices.TaskFolder

Uma pasta que contém tarefas. No Outlook, o grupo de tarefas padrão, My Tasks, contém uma pasta de tarefas padrão, Tasks, para a caixa de correio do usuário. Você não pode renomear ou excluir esses grupos de tarefas e pastas padrão, mas pode criar grupos de tarefas e pastas de tarefas adicionais.

Propriedade Tipo Descrição Gravável? Filtrável?
ChangeKey Sequência de caracteres A versão da pasta de tarefas. Não Não
Id Sequência de caracteres O identificador exclusivo da pasta de tarefas. Não Não
IsDefaultFolder Booleano Verdadeiro se a pasta for a pasta de tarefas padrão. Não Sim
Nome Sequência de caracteres O nome da pasta de tarefas. Sim Sim
ParentGroupKey Edm.Guid O identificador exclusivo do GUID para o grupo pai da pasta de tarefas. Não Não
Tarefas Coleção (Tarefa) As tarefas nesta pasta de tarefas. Propriedade de navegação. Não Não

TaskGroup

Tipo: Microsoft.OutlookServices.TaskGroup

Um grupo de pastas que contêm tarefas. No Outlook, há um grupo de tarefas padrão My Tasks que você não pode renomear ou excluir. Você pode, no entanto, criar grupos de tarefas adicionais.

Propriedade Tipo Descrição Gravável? Filtrável?
ChangeKey Sequência de caracteres A versão do grupo de tarefas. Não Não
GroupKey Edm.Guid O identificador exclusivo do GUID para o grupo de tarefas. Não Não
Id Sequência de caracteres O identificador exclusivo do grupo de tarefas. Não Não
IsDefaultGroup Booleano Verdadeiro se o grupo de tarefas for o grupo de tarefas padrão. Não Sim
Nome Sequência de caracteres O nome do grupo de tarefas. Sim Sim
TaskFolders Coleção (TaskFolder) As pastas de tarefas neste grupo de tarefas. Propriedade de navegação. Não Não

Usuário

Um usuário no sistema. O ponto de extremidade Me é fornecido como um atalho para especificar o usuário atual por endereço SMTP (users/sadie@contoso.com).

Tipo: Microsoft.OutlookServices.User

Uma coleção Users retorna uma matriz de usuários na propriedade valor da resposta OData. Use $count para obter a contagem de entidades na coleção: .../me/users/$count

Observação

A entidade Usuário inclui muitas propriedades e relacionamentos (propriedades de navegação) que são aumentados com frequência. A seção a seguir descreve apenas um subconjunto. Para informações atuais, consulte a definição Usuário no arquivo de metadados correspondente para sua versão.

Propriedade Tipo Descrição Gravável? Filtrável?
Alias Sequência de caracteres O alias do usuário. Normalmente, o endereço SMTP do usuário. Sim Sim
Calendário Calendário O calendário principal do usuário. Propriedade de navegação. Não Não
CalendarGroups Coleção (CalendarGroup) Obter os grupos de calendários do usuário. Propriedade de navegação. Não Não
Calendários Coleção (Calendário) Os calendários do usuário. Propriedade de navegação. Não Não
CalendarView Coleção (Evento) A visão de calendário para o calendário. Propriedade de navegação. Não Não
ContactFolders Coleção (ContactFolder) As pastas de contatos do usuário. Propriedade de navegação. Não Não
Contatos Coleção (Contato) Os contatos do usuário. Propriedade de navegação. Não Não
DisplayName Sequência de caracteres O nome de exibição do usuário. Sim Sim
Eventos Coleção (Evento) Os eventos dos usuários. O padrão é mostrar Eventos no Calendário Padrão. Propriedade de navegação. Não Não
Id Sequência de caracteres O identificador exclusivo do usuário. Não Não
InferenceClassification InferenceClassification Classificação de relevância das mensagens do usuário com base em designações explícitas que substituem a relevância ou importância deduzida. Propriedade de navegação. Sim Sim
MailboxGuid guid O GUID atribuído à caixa de correio do usuário. Não Sim
MailboxSettings MailboxSettings Configurações para a caixa de correio principal do usuário conectado. Sim Não
MailFolders Coleção (MailFolder) As pastas em uma caixa de correio. Propriedade de navegação. Não Não
Mensagens Coleção (Mensagem) As mensagens em uma caixa de correio ou pasta. Propriedade de navegação. Não Não
RootFolder MailFolder A pasta raiz da caixa de correio do usuário. Propriedade de navegação. Não Não

Tipos complexos

Attendee

Um participante do evento.

Tipo: Microsoft.OutlookServices.Recipient

Propriedade Tipo Descrição
Status ResponseStatus A resposta (nenhuma, aceita, recusada etc.) e a hora.
Tipo AttendeeType O tipo de participante. Os valores possíveis são: Required, Optional, Resource.

AttendeeAvailability

O tipo e a disponibilidade dos participantes.

Tipo: Microsoft.OutlookServices.AttendeeAvailability

Propriedade Tipo Descrição
Attendee AttendeeBase O tipo de participante - seja uma pessoa ou um recurso.
Availability FreeBusyStatus O status de disponibilidade do participante.

AttendeeBase

O tipo de participante.

Tipo: Microsoft.OutlookServices.Recipient

Propriedade Tipo Descrição
Tipo AttendeeType O tipo de participante. Os valores possíveis são: Required, Optional, Resource. Observação: se o participante for uma pessoa, FindMeetingTimes sempre considera que a pessoa é do tipo Required.

AutomaticRepliesSetting

Definições de configuração para notificar automaticamente o remetente de um email recebido com uma mensagem do usuário conectado. Por exemplo, uma resposta automática para notificar que o usuário conectado está disponível para responder a emails.

Tipo: Microsoft.OutlookServices.AutomaticRepliesSetting

Propriedade Tipo Descrição
ExternalAudience ExternalAudienceScope O conjunto da audiência externa para a organização do usuário conectado que receberá ExternalReplyMessage, se o Status for AlwaysEnabled ou Scheduled. Os valores são None = 0, ContactsOnly = 1 ou All = 2.
ExternalReplyMessage Sequência de caracteres A resposta automática para enviar à audiência externa especificada, se Status for AlwaysEnabled ou Scheduled.
InternalReplyMessage Sequência de caracteres A resposta automática para enviar à audiência interna na organização do usuário conectado, se Status for AlwaysEnabled ou Scheduled.
ScheduledEndDateTime DateTimeTimeZone A data e a hora em que as respostas automáticas estão definidas para terminar, se Status está definido como Scheduled. Você pode definir o fuso horário usando o cabeçalho HTTP Prefer: outlook.timezone na operação Obter.
ScheduledStartDateTime DateTimeTimeZone A data e a hora em que as respostas automáticas estão definidas para começar, se Status está definido como Scheduled. Você pode definir o fuso horário usando o cabeçalho HTTP Prefer: outlook.timezone na operação Obter.
Status AutomaticRepliesStatus Status de configurações para respostas automáticas: Disabled = 0, AlwaysEnabled = 1, Scheduled = 2.

DateTimeTimeZone

Descreve a data, a hora e o fuso horário de um ponto no tempo.

Propriedade Tipo Descrição
DateTime DateTime Um ponto único de tempo em uma representação combinada de data e hora (<date>T<time>) de acordo com o formato ISO 8601
TimeZone Sequência de caracteres Um dos seguintes nomes de fuso horário.

A propriedade TimeZone pode ser definida para qualquer um dos fusos horários com suporte no Windows, bem como os nomes de fusos horários a seguir. Veja TimeZone para mais informações.

Etc/GMT+12

Etc/GMT+11

Pacífico/Honolulu

América/Anchorage

América/Santa_Isabel

América/Los_Angeles

América/Phoenix

América/Chihuahua

América/Denver

América/Guatemala

América/Chicago

América/Mexico_City

América/Regina

América/Bogotá

América/New_York

América/Indiana/Indianápolis

América/Caracas

América/Asunción

América/Halifax

América/Cuiabá

América/La_Paz

América/Santiago

América/St_Johns

América/São_Paulo

América/Argentina/Buenos_Aires

América/Cayenne

América/Godthab

América/Montevidéu

América/Bahia

Etc/GMT+2

Atlântico/Açores

Atlântico/Cape_Verde

África/Casablanca

Etc/GMT

Europa/Londres

Atlântico/Reykjavik

Europa/Berlim

Europa/Budapeste

Europa/Paris

Europa/Varsóvia

África/Lagos

África/Windhoek

Europa/Bucareste

Ásia/Beirute

África/Cairo

Ásia/Damasco

África/Joanesburgo

Europa/Kiev

Europa/Istambul

Ásia/Jerusalém

Ásia/Amman

Ásia/Bagdá

Europa/Caliningrado

Ásia/Riad

África/Nairóbi

Ásia/Teerã

Ásia/Dubai

Ásia/Baku

Europa/Moscou

Índia/Maurício

Ásia/Tbilisi

Ásia/Ierevan

Ásia/Cabul

Ásia/Karachi

Ásia/Tashkent

Ásia/Kolkata (Calcutá)

Ásia/Colombo

Ásia/Katmandu

Ásia/Almaty

Ásia/Dacca

Ásia/Ecaterimburgo

Ásia/Rangoon

Ásia/Bangcoc

Ásia/Novosibirsk

Ásia/Shanghai

Ásia/Krasnoyarsk

Ásia/Cingapura

Austrália/Perth

Ásia/Taipé

Ásia/Ulan Bator

Ásia/Irkutsk

Ásia/Tóquio

Ásia/Seul

Austrália/Adelaide

Austrália/Darwin

Austrália/Brisbane

Austrália/Sidney

Pacífico/Port_Moresby

Austrália/Hobart

Ásia/Yakutsk

Pacífico/Guadalcanal

Ásia/Vladivostok

Pacífico/Auckland

Etc/GMT-12

Pacífico/Fiji

Ásia/Magadã

Pacífico/Tongatapu

Pacífico/Apia

Pacífico/Kiritimati

EmailAddress

O nome e o endereço de email de um destinatário da mensagem ou contato.

Tipo: Microsoft.OutlookServices.EmailAddress

Propriedade Tipo Descrição
Nome Sequência de caracteres O nome de exibição da pessoa ou entidade.
Endereço Sequência de caracteres O endereço de email da pessoa ou entidade.

GeoCoordinates

As coordenadas geográficas e a elevação do local.

Tipo: Microsoft.OutlookServices.GeoCoordinates

Propriedade Tipo Descrição
Altitude Double A altitude do local.
Latitude Double A latitude do local.
Longitude Double A longitude do local.
Accuracy Double A precisão do sensor que forneceu a latitude e a longitude.
AltitudeAccuracy Double A precisão do sensor fornecendo a altitude.

ItemBody

O conteúdo do corpo de uma mensagem ou evento.

Tipo: Microsoft.OutlookServices.ItemBody

Propriedade Tipo Descrição
ContentType BodyType O tipo de conteúdo: Text = 0, HTML = 1.
Conteúdo Sequência de caracteres O texto ou conteúdo HTML.

LocaleInfo

Informações sobre a localidade, incluindo o idioma preferencial e o país/região do usuário conectado.

Tipo: Microsoft.OutlookServices.LocaleInfo

Propriedade Tipo Descrição
DisplayName Sequência de caracteres Um nome que representa uma localidade por seu idioma natural, por exemplo, "Inglês (Estados Unidos)".
Localidade Sequência de caracteres Uma representação de localidade que inclui o idioma e o país/região. Por exemplo, "en-us". O componente do idioma acompanha códigos de 2 letras, conforme definido na ISO 639-1, e o componente do país acompanha os códigos de 2 letras conforme definido na ISO 3166-1 alpha-2.

Location

O local de um evento.

Tipo: Microsoft.OutlookServices.Location

Propriedade Tipo Descrição
DisplayName Sequência de caracteres O nome associado ao local.
Endereço PhysicalAddress O endereço físico do local.
Coordenadas GeoCoordinates As coordenadas geográficas e a elevação do local.
LocationEmailAddress Sequência de caracteres O endereço de email opcional do local.

LocationConstraint

As condições indicadas por um cliente para o local de uma reunião.

Tipo: Microsoft.OutlookServices.LocationConstraint

Propriedade Tipo Descrição
IsRequired booleano O cliente solicita que o serviço inclua na resposta um local de reunião para a reunião.
SuggestLocation booleano O cliente solicita o serviço para sugerir um ou mais locais para a reunião.
Locations Coleção (LocationConstraintItem) Um ou mais locais que o cliente solicita para uma reunião.

LocationConstraintItem

As condições declaradas por um cliente para verificar a disponibilidade de cada local de uma reunião e outras informações sobre o local.

Tipo: Microsoft.OutlookServices.Location

Propriedade Tipo Descrição
ResolveAvailability booleano Se definido como verdadeiro e o recurso especificado estiver ocupado, FindMeetingTimes procura outro recurso que esteja livre. Se definido como falso e o recurso especificado estiver ocupado, FindMeetingTimes retorna o recurso melhor classificado no cache do usuário sem verificar se está livre. O padrão é verdadeiro.

MailboxSettings

Configurações da caixa de correio principal do usuário.

Tipo: Microsoft.OutlookServices.MailboxSettings

Propriedade Tipo Descrição
AutomaticRepliesSetting AutomaticRepliesSetting Configurações para definir automaticamente o envio de respostas às mensagens recebidas.
TimeZone Sequência de caracteres O fuso horário padrão para a caixa de correio do usuário.
Language LocaleInfo Informações sobre a localidade do usuário, incluindo o idioma preferencial e o país/região.

MeetingTimeSuggestion

Uma sugestão de reunião que inclui informações como o horário da reunião, a probabilidade de presença, a disponibilidade do participante e os locais de reunião disponíveis.

Tipo: Microsoft.OutlookServices.MeetingTimeSuggestion

Propriedade Tipo Descrição
MeetingTimeSlot TimeSlot Um período de tempo sugerido para a reunião.
Confidence double Uma porcentagem que representa a probabilidade de todos os participantes comparecerem.
OrganizerAvailability FreeBusyStatus Disponibilidade do organizador da reunião para essa sugestão de reunião: Free, Tentative, Busy, Oof, WorkingElsewhere, Unknown.
AttendeeAvailability Coleção (AttendeeAvailability) Uma matriz que mostra o status de disponibilidade de cada participante para essa sugestão da reunião.
Locations Coleção (Localização) Uma matriz que especifica o nome e a localização geográfica de cada local da reunião para esta sugestão de reunião.
SuggestionReason Sequência de caracteres Descreve as razões para sugerir o horário da reunião.

A confiança de uma reunião

A propriedade Confidence de uma MeetingTimeSuggestion varia de 0% a 100% e representa a chance de que todos os participantes compareçam à reunião, com base em seu status disponível/ocupado:

  • Para cada participante, um status livre para um período de tempo de reunião especificado corresponde à chance de 100% de presença, status desconhecido 49% e status ocupado 0%.
  • A confiança de um provável horário de reunião é calculada pela média da chance de presença de todos os participantes especificados para essa reunião.
  • Você pode usar o parâmetro opcional MinimumAttendeePercentage para FindMeetingTimes para especificar apenas intervalos do horário da reunião de, pelo menos, um certo nível de confiança que deve ser retornado. Por exemplo, você pode especificar um MinimumAttendeePercentage de 80% se quiser apenas sugestões que tenham 80% de chance ou mais de que todos os participantes irão comparecer. Se você não especificar MinimumAttendeePercentage, FindMeetingTimes adota um valor de 50%.
  • Se houver vários candidatos ao horário da reunião, a ação FindMeetingTimes primeiro ordena os candidatos pelo seu valor de confiança calculado, do mais alto para o mais baixo. Se houver candidatos com a mesma confiança, então a ação ordena esses candidatos cronologicamente.

Por exemplo, se um intervalo de tempo de uma reunião envolve três participantes com o seguinte status livre/ocupado:

Attendee Status disponível/ocupado % de chance de comparecer
Sara Disponível 100%
Davi Desconhecida 49%
Lara Ocupado 0%

Portanto, a confiança do intervalo de tempo da reunião, que corresponde à chance média de presença, é (100% + 49% + 0%)/3 = 49,66%.

Se você especificar um MinimumAttendeePercentage de 80% em uma operação FindMeetingTimes, pois 49,66% < 80%, a operação não retornará esse intervalo de tempo na resposta.

MeetingTimeSuggestionsResult

Uma coleção de sugestões de reunião, se houver alguma, ou o motivo, caso não haja nenhuma.

Tipo: Microsoft.OutlookServices.MeetingTimeSuggestionsResult

Propriedade Tipo Descrição
MeetingTimeSuggestions Coleção (MeetingTimeSuggestion) Uma matriz de sugestões de reunião.
EmptySuggestionsReason Sequência de caracteres Um motivo para não retornar qualquer sugestão de reunião. Os valores possíveis são: AttendeesUnavailable, LocationsUnavailable, OrganizerUnavailable, AttendeesUnavailableOrUnknown ou Unknown.

Razões para não retornar sugestões de reunião

A propriedade EmptySuggestionsReason especifica uma das seguintes razões pelas quais a ação FindMeetingTimes não retorna nenhuma sugestão de reunião. A propriedade é uma sequência de caracteres vazia se FindMeetingTimes retornar quaisquer sugestões de reunião.

Valor Motivos
AttendeesUnavailable A disponibilidade de todos os participantes é conhecida, mas não há participantes suficientes disponíveis para alcançar o limite de confiança da reunião, que é de 50% por padrão.
AttendeesUnavailableOrUnknown Alguns ou todos os participantes têm disponibilidade desconhecida, fazendo com que a confiança na reunião caia para abaixo o limite definido, que é de 50% por padrão. A disponibilidade do participante poderá se tornar desconhecida se ele não for da organização ou se houver um erro ao obter informações sobre a disponibilidade.
LocationsUnavailable A propriedade IsRequired do parâmetro LocationConstraint é especificada como obrigatória, e ainda não existem locais disponíveis nos intervalos de tempo calculados.
OrganizerUnavailable O parâmetro IsOrganizerOptional é falso, e o organizador ainda não está disponível durante a janela de tempo solicitada.
Desconhecida O motivo para não retornar qualquer sugestão de reunião não é conhecido.

PatternedRecurrence

O padrão e o intervalo da recorrência.

Tipo: Microsoft.OutlookServices.PatternedRecurrence

Propriedade Tipo Descrição
Padrão RecurrencePattern A frequência de um evento.
Intervalo RecurrenceRange A duração de um evento.

PhysicalAddress

O endereço físico de um contato.

Tipo: Microsoft.OutlookServices.PhysicalAddress

Propriedade Tipo Descrição
Street Sequência de caracteres O tipo de logradouro (rua, alameda, avenida, etc.).
City Sequência de caracteres A cidade.
Estado Sequência de caracteres O estado.
CountryOrRegion Sequência de caracteres O país ou a região. É um valor de cadeia de caracteres de formato livre, por exemplo, "Brasil".
PostalCode Sequência de caracteres O código de endereçamento postal, ou CEP.

Destinatário

Representa informações sobre um usuário no envio ou recebimento final de um evento ou mensagem.

Tipo: Microsoft.OutlookServices.Recipient

Propriedade Tipo Descrição
EmailAddress EmailAddress O endereço de email do destinatário.

RecurrencePattern

A frequência de um evento.

Tipo: Microsoft.OutlookServices.RecurrencePattern

Propriedade Tipo Descrição
Tipo RecurrencePatternType O tipo de padrão de recorrência: Diário = 0, Semanal = 1, AbsoluteMonthly = 2, RelativeMonthly = 3, AbsoluteYearly = 4, RelativeYearly = 5.
Regras padrão:
- AbsoluteYearly. Deve definir o Mês e Dia do mês da ocorrência
- RelativeYearly. Deve definir o índice Mês, Dias da semanae Primeiro dia da semana
- AbsoluteMonthly. Deve definir o Dia do mês
- RelativeMonthly. Deve definir o índice Primeiro dia da semana e RecurrenceRange.NumberOfOccurrences
- Weekly. Deve definir o Dias da semana e o Primeiro dia da semana
- Daily. Nenhuma informação padrão adicional é necessária.
Interval Int32 O número de unidades de um determinado tipo de recorrência entre as ocorrências.
DayOfMonth Int32 O dia do mês em que o item ocorre.
Mês Int32 O mês em que o item ocorre. É um número entre 1 e 12.
DaysOfWeek Coleção (DayOfWeek) Uma coleção de dias da semana: domingo = 0, segunda-feira = 1, terça-feira = 2, quarta-feira = 3, quinta-feira = 4, sexta-feira = 5, sábado = 6.
FirstDayOfWeek DayOfWeek O dia da semana: domingo = 0, segunda-feira = 1, terça-feira = 2, quarta-feira = 3, quinta-feira = 4, sexta-feira = 5, sábado = 6.
Index WeekIndex O índice da semana: primeiro = 0, segundo = 1, terceiro = 2, quarto = 3, último = 4.

RecurrenceRange

A duração de um evento.

Tipo: Microsoft.OutlookServices.RecurrenceRange

Propriedade Tipo Descrição
Tipo RecurrenceRangeType O intervalo da recorrência: EndDate = 0, NoEnd = 1, Numbered = 2.
StartDate datetimeoffset Necessário: A data de início da série.
EndDate datetimeoffset Obrigatório para os padrões de limite de data: A data final da série. Deve ser após a data inicial.
NumberOfOccurrences Int32 Obrigatório para os padrões Numbered: Quantas vezes o evento deve repetir.

ResponseStatus

O status de resposta de uma solicitação de reunião.

Tipo: Microsoft.OutlookServices.ResponseStatus

Propriedade Tipo Descrição
Resposta ResponseType O tipo de resposta: None, Organizer, TentativelyAccepted, Accepted, Declined, NotResponded.
Hora datetimeoffset A data e hora em que a resposta retornou.

TimeConstraint

Restringe as sugestões de horário para reuniões a certas horas e dias da semana de acordo com a natureza especificada da atividade e intervalos de tempo disponíveis.

Tipo: Microsoft.OutlookServices.TimeConstraint

Propriedade Tipo Descrição
ActivityDomain ActivityDomain Opcional, a natureza da atividade: Work, Personal, Unrestricted ou Unknown.
Timeslots Coleção (TimeSlot) Uma matriz de períodos de tempo.

TimeSlot

Um período de tempo.

Tipo: Microsoft.OutlookServices.TimeSlot

Propriedade Tipo Descrição
Iniciar DateTimeTimeZone A hora em que um período inicia.
End DateTimeTimeZone A hora em que um período termina.

Enumerações

ActivityDomain

A natureza de uma atividade.

Valores suportados:

  • Trabalho
  • Pessoal
  • Unrestricted
  • Desconhecida

AutomaticRepliesStatus

O status de configuração para enviar automaticamente uma resposta quando a caixa de correio do usuário recebe uma mensagem.

Valores suportados:

  • AlwaysEnabled
  • Disabled
  • Scheduled

DayOfWeek

O conjunto de dias da semana.

Valores suportados:

  • Domingo
  • Segunda-feira
  • Terça-feira
  • Quarta-feira
  • Quinta-feira
  • Sexta-feira
  • Sábado

ExternalAudienceScope

O conjunto de audiência externa para enviar ExternalReplyMessage.

Valores suportados:

  • All
  • ContactsOnly
  • None

FreeBusyStatus

Especifica o status de disponibilidade de um participante para uma reunião.

Valores suportados:

  • Ocupado
  • Disponível
  • Fora do escritório
  • Tentativa
  • Desconhecida
  • WorkingElsewhere

InferenceClassificationType

Representa a relevância inferida de uma mensagem para um usuário se concentrar.

Valores suportados:

  • Focused
  • Outros

ReferenceAttachmentPermissions

Permissões de acesso para o arquivo ou pasta do anexo de referência.

Valores suportados:

  • Outros
  • Exibir
  • EDIT
  • AnonymousView
  • AnonymousEdit
  • OrganizationView
  • OrganizationEdit

ReferenceAttachmentProviders

Possíveis provedores de armazenamento de arquivos para anexos de referência.

Valores suportados:

  • Dropbox
  • OneDriveBusiness
  • OneDriveConsumer
  • Outros

Sensitivity

Indica o nível de privacidade.

Valores suportados:

  • Normal
  • Pessoal
  • Particular
  • Confidencial

TaskStatus

Especifica o estado ou progresso de uma tarefa.

Valores suportados:

  • Completed
  • Deferred
  • InProgress
  • NotStarted
  • WaitingOnOthers

Parâmetros de consulta OData

Você pode usar os parâmetros de consulta padrão OData v4.0 para filtrar solicitações de dados, e classificar e paginar os resultados ao trabalhar com as APIs de Email, Calendário e Contatos. Ao especificar parâmetros de consulta, certifique-se de que os caracteres que são reservados para significados especiais em um URI sejam apropriadamente codificados.

  • $search para pesquisar critérios específicos

  • $filter para filtrar critérios específicos

  • $select para solicitar propriedades específicas

  • $orderby para classificar resultados

  • $top e $skip para paginar resultados

  • $expand para expandir os anexos de mensagens e os anexos de eventos

  • $count para obter a quantidade de entidades em uma coleção. Este parâmetro vai no caminho da URL: .../me/calendars/$count

A consulta com as APIs de E-mail, Calendário e Contatos sempre usa um escopo superficial. Somente itens dentro da pasta atual são retornados. Pesquisas profundas não são suportadas.

Buscar solicitações

Você pode usar o parâmetro $search para restringir os resultados de uma solicitação às mensagens que correspondem a uma expressão de pesquisa. As sequências de caracteres de pesquisa são expressas usando a Sintaxe de Consulta Avançada (AQS). Os resultados são classificados pela data e hora em que a mensagem foi enviada.

Observação

É possível obter até 250 resultados de uma solicitação $search. Você pode usar $search apenas com mensagens. A pesquisa de contatos e eventos do calendário não é suportada.

Você não pode usar $filter ou $orderby em uma solicitação de pesquisa. Se fizer isso, você receberá uma mensagem de erro como esta.

    {
      "error":
      {
        "code":"ErrorInvalidUrlQuery",
        "message":"The query parameter 'OrderBy' is invalid."
      }
    }
Propriedade Descrição
Anexo Pesquisa pelo anexo especificado por título.
Cco Pesquisa o campo Cco.
Corpo ou Conteúdo Pesquisa o campo Corpo. Suportado apenas com pesquisas padrão.
Category Pesquisa o campo Categoria.
Cc Pesquisa o campo Cc.
From Pesquisa o campo De.
Has Pesquisa o campo HasAttachments.
Participants Pesquisa os campos Para, Cc e Cco.
Received Pesquisa o campo Recebido para uma data específica expressa como MM/DD/AAAA.
Sender Pesquisa o campo Remetente.
Subject Pesquisa o campo Assunto.
To Pesquisa o campo Para.

Você pesquisa campos comuns usando o parâmetro de consulta $search sem especificar uma propriedade. Uma pesquisa padrão pesquisará as propriedades Corpo, Remetente e Assunto. A pesquisa a seguir retornará todas as mensagens na Caixa de entrada que contém "pizza" em qualquer uma das três propriedades padrão.

Vamos ver alguns exemplos. Para facilitar a leitura, as URLs nos exemplos não foram codificadas por URL. No entanto, se você tentar esses exemplos, certifique-se de codificá-los em URL antes de enviá-los ao servidor.

Para obter todas as mensagens na Caixa de entrada que contenham a palavra "Pizza" na propriedade De, Assunto ou Corpo, você pode usar esta solicitação.

GET https://outlook.office.com/api/v2.0/me/messages?$search="pizza"

Para obter todas as mensagens na Caixa de entrada que contenham a palavra "Pizza" na propriedade Assunto, você pode usar esta solicitação.

GET https://outlook.office.com/api/v2.0/me/messages?$search="subject:pizza"

Para obter todas as mensagens na Caixa de entrada que foram enviadas de uma pessoa específica, você pode usar esta solicitação.

GET https://outlook.office.com/api/v2.0/me/messages?$search="from:help@contoso.com"

Os exemplos acima não incluíram a codificação de URL. Aqui estão os mesmos exemplos de URL codificadas e prontas para enviar para o seu servidor:

GET https://outlook.office.com/api/v2.0/me/messages?$search=%22pizza%22
GET https://outlook.office.com/api/v2.0/me/messages?$search=%22subject:pizza%22
GET https://outlook.office.com/api/v2.0/me/messages?$search=%22from:help@contoso.com%22

Solicitações de filtro

Você pode usar o parâmetro de consulta $filter para especificar critérios de pesquisa usando os seguintes operadores de filtro.

Nem todas as propriedades suportam filtragem. Apenas as propriedades do recurso marcadas como "Sim" em "Filtrável?" na coluna em suas tabelas correspondentes acima podem ser usadas. Se uma propriedade não for filtrável, você receberá uma mensagem de erro em resposta, como esta que é retornada se você tentar filtrar na propriedade ChangeKey:

    {
      "error":
      {
        "code":"ErrorInvalidProperty",
        "message":"The property 'ChangeKey' does not support filtering."
      }
    }

Se você usar um método de filtragem que não é suportado, você receberá uma mensagem de erro como esta, que é retornada quando o método de filtro startswith é usado na propriedade Assunto:

    {
      "error":
      {
        "code":"ErrorInvalidUrlQueryFilter",
        "message":"'contains' and 'startswith' are not supported for filtering.  Use Search instead."
      }
    }
Operador Tipo Exemplo
e Lógico E (usado para combinar vários critérios) TotalCount gt 0 and ChildFolderCount eq 0
ou Lógico Ou (usado para combinar vários critérios) TotalCount gt 0 or ChildFolderCount eq 0
eq Igual a IsRead eq false
ne Não é igual Importance ne Microsoft.Exchange.Services.OData.Model.Importance'High'
gt Maior que ReceivedDateTime gt 2014-09-01T00:00:00Z
ge Maior ou igual a LastModifiedDateTime ge 2014-09-01T00:00:00Z
lt Menor que ReceivedDateTime lt 2014-09-01T00:00:00Z
le Menor ou igual a LastModifiedDateTime le 2014-09-01T00:00:00Z

Use aspas simples (') para delimitar qualquer valor Sequência de caracteres dentro do critério de filtro. Use %27 para codificar em URL a aspa simples. A Sequência de caracteres em si não faz distinção entre maiúsculas e minúsculas.

Vamos ver alguns exemplos. Para facilitar a leitura, as URLs nos exemplos não foram codificadas por URL. No entanto, se você tentar esses exemplos, certifique-se de codificá-los em URL antes de enviá-los ao servidor.

Para obter todos os eventos no calendário padrão do usuário que começam em ou após uma data específica, você pode filtrar na propriedade Início.

GET https://outlook.office.com/api/v2.0/me/events?$filter=Start/DateTime ge '2016-04-01T08:00'

Para obter todos os eventos no calendário do usuário com um assunto específico, você pode filtrar na propriedade Assunto.

GET https://outlook.office.com/api/v2.0/me/events?$filter=Subject eq 'Mega Charity Bash'

Para obter todas as mensagens não lidas na Caixa de entrada, você pode filtrar pela propriedade IsRead.

GET https://outlook.office.com/api/v2.0/me/messages?$filter=IsRead eq false

Para obter todas as mensagens na Caixa de entrada com anexos, você pode filtrar na propriedade HasAttachments.

GET https://outlook.office.com/api/v2.0/me/messages?$filter=HasAttachments eq true

Para receber todas as mensagens na Caixa de entrada recebidas desde 1º de setembro de 2014, você pode filtrar pela propriedade ReceivedDateTime.

GET https://outlook.office.com/api/v2.0/me/messages?$filter=ReceivedDateTime ge 2014-09-01

Para obter todas as mensagens na Caixa de entrada enviadas de "hr@contoso.com", você pode filtrar na propriedade Remetente.

GET https://outlook.office.com/api/v2.0/me/messages?$filter=From/EmailAddress/Address eq 'hr@contoso.com'

Os exemplos acima não incluíram a codificação de URL. Aqui estão os mesmos exemplos de URL codificadas e prontas para enviar para o seu servidor:

GET https://outlook.office.com/api/v2.0/me/events?$filter=Start/DateTime%20ge%20%272016-04-01T08:00%27
GET https://outlook.office.com/api/v2.0/me/events?$filter=Subject%20eq%20%27Mega%20Charity%20Bash%27
GET https://outlook.office.com/api/v2.0/me/messages?$filter=IsRead%20eq%20false
GET https://outlook.office.com/api/v2.0/me/messages?$filter=HasAttachments%20eq%20true
GET https://outlook.office.com/api/v2.0/me/messages?$filter=ReceivedDateTime%20ge%202014-09-01
GET https://outlook.office.com/api/v2.0/me/messages?$filter=From/EmailAddress/Address%20eq%20%27hr@contoso.com%27

Selecione as propriedades específicas a serem retornadas

Você pode usar o parâmetro de consulta $select para especificar apenas as propriedades que seu aplicativo precisa.

Observação

Ao receber itens de email, de calendários e de contato, sempre use $select para excluir propriedades desnecessárias no conteúdo da resposta para manter um desempenho razoável do aplicativo. Se você não incluir um parâmetro $select, todas as propriedades para os itens serão retornadas.

O exemplo a seguir obtém as propriedades Subject, Sender, e ReceivedDateTime para todas as mensagens na Caixa de entrada.

GET https://outlook.office.com/api/v2.0/me/messages?$select=Subject,Sender,ReceivedDateTime

Classificar resultados

Você pode classificar os resultados usando o parâmetro de consulta $orderby. Defina o valor desse parâmetro para um nome de propriedade e, opcionalmente, especifique a ordem crescente (padrão) ou decrescente. Lembre-se, você não pode usar o parâmetro de consulta $orderby com $search.

O exemplo a seguir sem codificação de URL obtém todas as mensagens na Caixa de entrada classificadas pela propriedade ReceivedDateTime em ordem decrescente.

GET https://outlook.office.com/api/v2.0/me/messages?$orderby=ReceivedDateTime desc

O mesmo exemplo com codificação de URL:

GET https://outlook.office.com/api/v2.0/me/messages?$orderby=ReceivedDateTime%20desc

Paginar resultados

Por padrão, uma solicitação GET em uma propriedade Messages ou ChildFolders, uma coleção ou um CalendarView retorna dez entradas (máximo de 50). Você pode alterar esse comportamento usando o parâmetro de consulta $top para definir um número máximo. O exemplo a seguir obtém as primeiras cinco mensagens na Caixa de entrada.

GET https://outlook.office.com/api/v2.0/me/messages?$top=5

Se houver mais de cinco mensagens na Caixa de entrada, a resposta incluirá uma propriedade odata.nextLink. A presença dessa propriedade indica que há mais itens disponíveis no servidor. O valor dessa propriedade é um URI que pode ser usado para obter os próximos cinco itens.

GET https://outlook.office.com/api/v2.0/me/messages?$top=5&$skip=5

A paginação é obtida usando o parâmetro $top para especificar um tamanho de página e o parâmetro $skip como um múltiplo do tamanho da página. Ao incrementar o valor do parâmetro $skip pelo tamanho da página, você pode solicitar a próxima página no conjunto de resultados.

Contar entidades em uma coleção

Você pode obter a contagem de entidades em uma coleção usando o parâmetro $count. Você também pode filtrar a solicitação de contagem.

Este exemplo obtém a contagem de mensagens na Caixa de Entrada.

GET https://outlook.office.com/api/v2.0/me/messages/$count

E este exemplo sem codificação de URL obtém a contagem de mensagens não lidas na Caixa de Entrada.

GET https://outlook.office.com/api/v2.0/me/messages/$count?$filter=IsRead eq false

O mesmo exemplo com codificação de URL.

GET https://outlook.office.com/api/v2.0/me/messages/$count?$filter=IsRead%20eq%20false

Unir tudo

Você pode combinar parâmetros para criar consultas complexas. O exemplo a seguir refina uma consulta das mensagens na Caixa de Entrada das seguintes maneiras:

  • Retornar apenas itens com Importância definida como Alta.

  • Retornar apenas as propriedades Subject, Sender, e ReceivedDateTime.

  • Retornar apenas as primeiras cinco mensagens.

Observação

A codificação de URL não é usada e as quebras de linha foram adicionadas para facilitar a leitura do exemplo.

https://outlook.office.com/api/v2.0/me/messages?
    $filter=Importance eq 'High'
    &$select=Subject,Sender,ReceivedDateTime
    &$top=5

Quando você especifica $filter, o servidor deduz uma ordem de classificação para os resultados. Se você usar $filter e $orderby, as propriedades em $filter devem ser listadas primeiro em $orderby antes de quaisquer outras propriedades, e elas devem ser listadas na ordem em que aparecem no parâmetro $filter.

O exemplo a seguir mostra uma consulta filtrada pelas propriedades Assunto e Importância e, em seguida, classificadas pelas propriedades Assunto, Importância e Remetente.

https://outlook.office.com/api/v2.0/me/messages?
    $filter=Subject eq 'Good Times' AND Importance eq 'High'&
    $orderby=Subject,Importance,Sender

Aqui estão os mesmos exemplos com codificação URL e sem quebras de linha.

https://outlook.office.com/api/v2.0/me/messages?$filter=Importance%20eq%20%27High%27&select=Subject,Sender,ReceivedDateTime&$top=5

https://outlook.office.com/api/v2.0/me/messages?$filter=Subject%20eq%20%27Good%20Times%27%20AND%20Importance%20eq%20%27High%27&$orderby=Subject,Importance,Sender

Ver também