Referência de recurso para as APIs REST de Email, Calendário, Contatos e Tarefa (versão 1.0)
Aplica-se a: Exchange Online | Office 365 | Hotmail.com | Live.com | MSN.com | Outlook.com | Passport.com
Observação
A versão 1.0 da API REST do Outlook está sendo preterida. A partir de 1º de novembro de 2018, os aplicativos não poderão mais usar a Autenticação Básica com o ponto de extremidade REST da v1.0. Em 1º de novembro de 2019, o ponto de extremidade REST da v1.0 será totalmente desativado, e a documentação da v1.0 será removida logo em seguida. Comece a fazer a migração do seu aplicativo para usar a API REST do Outlook na v1.0 do Microsoft Graph. Veja mais detalhes em nosso anúncio.
Este artigo descreve as entidades da API REST, propriedades, tipos complexos, enumerações e parâmetros de consulta OData que podem ser usados com a API 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 que são comuns a todos os subconjuntos da API REST do Outlook.
Não tem interesse na v1.0 da API? No sumário à esquerda, vá para a seção de Referência da API REST do Office 365 e selecione a versão desejada.
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/v1.0/$metadata).
Anexo
Um arquivo ou item (contato, evento ou mensagem) anexado a um evento ou mensagem. Os
recursos correspondentes fileAttachment e itemAttachment são derivados do mesmo recurso Anexo.
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 | Booliano | 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 value da resposta do 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? |
|---|---|---|---|---|
| Nome | Sequência de caracteres | O nome do calendário. | Sim | 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 |
| 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 |
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 value da resposta do 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 de classe. | Não | Sim |
| ID | Sequência de caracteres | O identificador exclusivo 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 | Collection(String) | Os números de telefone comerciais do contato. | Sim | Não |
| Categories | Collection(String) | 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 | Collection(String) | Os nomes dos filhos do contato. | Sim | Sim |
| CompanyName | Sequência de caracteres | O nome da empresa do contato. | Sim | Sim |
| Departamento | Sequência de caracteres | O departamento do contato. | Sim | Sim |
| DateTimeCreated | datetimeoffset | A hora em que o contato foi criado. | Não | Sim |
| DateTimeLastModified | 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 |
| FileAs | Sequência de caracteres | O nome com o qual o contato está arquivado. | Sim | Sim |
| Geração | 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 | Collection(String) | 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 | Collection(String) | 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 fonético em japonês da empresa do contato. Essa propriedade é opcional. | Sim | Não |
| YomiGivenName | Sequência de caracteres | O nome japonês fonético do contato. Essa propriedade é opcional. | Sim | Não |
| YomiSurname | Sequência de caracteres | O sobrenome fonético em japonês da empresa do contato. Essa propriedade é opcional. | Sim | Não |
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 filho 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 |
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? |
|---|---|---|---|---|
| Attachments | Coleção (Anexo) | A coleção de anexos FileAttachment e ItemAttachment 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 |
| Calendar | Calendário | O calendário que contém o evento. Propriedade de navegação. | Não | Não |
| Categories | Collection(String) | 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 |
| DateTimeCreated | datetimeoffset | A data e hora em que o evento foi criado. | Não | Sim |
| DateTimeLastModified | datetimeoffset | A data e a hora em que o evento foi modificado pela última vez. | Não | Sim |
| End | datetimeoffset | A data e a hora em que o evento termina. Por padrão, a hora de término é em UTC. Você pode especificar um fuso horário opcional em EndTimeZone, expressar a hora de término nesse fuso horário e incluir uma diferença de tempo em relação a UTC. Se usar EndTimeZone, você deverá especificar um valor para StartTimeZone também. Este exemplo especifica 25 de fevereiro de 2015, 21: 34 na Hora Padrão do Pacífico: "2015-02-25T21:34:00-08:00". |
Sim | Sim |
| EndTimeZone | Sequência de caracteres | Identifica o fuso horário da reunião para a hora de término da reunião (veja a propriedade Fim). Esta propriedade é definida com o nome do fuso horário, pois é armazenada no Windows. Você pode obter os nomes de fuso horário chamando System.TimeZoneInfo.GetSystemTimeZones (). Esta propriedade é opcional para v1.0. No entanto, essa propriedade deve ser usada se a propriedade StartTimeZone for usada. Veja TimeZone para mais informações. |
Sim | Não |
| HasAttachments | booliano | Defina como true se o evento tiver anexos. | Não | Sim |
| ID | Sequência de caracteres | O identificador exclusivo do evento. | Não | Não |
| Importance | Importância | 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 | booliano | Defina como true 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 | booliano | Defina como true se o evento tiver sido cancelado. | Sim | Sim |
| IsOrganizer | booliano | Defina como true se o remetente da mensagem também for o organizador. | Sim | Sim |
| Location | Localização | A localização do evento. | Sim | Sim |
| Organizer | Destinatário | O organizador do evento. | Sim | Sim |
| Recurrence | PatternedRecurrence | O padrão de recorrência do evento. | Sim | Não |
| ResponseRequested | booliano | Defina como verdadiro 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 | Confidencialidade | 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, Tentativa = 1, Ocupado = 2, Desligado = 3, Funcionando em outro lugar = 4, Desconhecido = -1. | Sim | Sim |
| Iniciar | datetimeoffset | A hora de início do evento. Por padrão, a hora de início é em UTC. Você pode especificar um fuso horário opcional em StartTimeZone, expressar a hora de início no fuso horário correspondente e incluir uma diferença de tempo em relação a UTC. Se usar StartTimeZone, você deverá especificar um valor para EndTimeZone também. Este exemplo especifica 25 de fevereiro de 2015, 19:34 na Hora Padrão do Pacífico: "2015-02-25T19:34:00-08:00". |
Sim | Sim |
| StartTimeZone | Sequência de caracteres | Identifica o fuso horário da reunião para a hora de início da reunião (veja a propriedade Início). Essa propriedade faz com que o serviço manipule as alterações de fuso horário em vez do cliente. Esta propriedade é definida com o nome do fuso horário, pois é armazenada no Windows. Você pode obter os nomes de fuso horário chamando System.TimeZoneInfo.GetSystemTimeZones (). Esta propriedade é opcional para v1.0. No entanto, essa propriedade deve ser usada se a propriedade EndTimeZone for usada. Um valor de exemplo para essa propriedade é "Horário Padrão do Pacífico". Veja TimeZone para mais informações. |
Sim | Não |
| Subject | Sequência de caracteres | O texto da linha de assunto do evento. | Sim | Sim |
| Tipo | EventType | O tipo de evento: SingleInstance = 0, Ocorrência = 1, Exceção = 2, SeriesMaster = 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 |
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, na qual ela chega como resultado de um organizador de eventos que cria uma reunião ou de um participante que está respondendo a uma solicitação de reunião. Você age de acordo com as mensagens do evento da mesma forma que age com Mensagem, 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 suposição 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
Este recurso está atualmente disponível nas versões beta e V2.0. Para saber mais, no sumário à esquerda, vá para a seção referência da API REST do Office 365 e selecione a versão de sua escolha.
FileAttachment
Um arquivo (como um arquivo de texto ou documento do Word) anexado a uma mensagem ou evento. A propriedade ContentBytes inclui os conteúdos codificados em base64 do arquivo. Derivado da entidade Anexo.
Tipo: Microsoft.OutlookServices.FileAttachment
Tipo de 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 |
| DateTimeLastModified | 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 |
| IsContactPhoto | booliano | Obsoleto. | Sim |
| IsInline | booliano | Defina como true 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
Nas versões posteriores à v1.0, a entidade e o tipo Pasta 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.Folder
Uma coleção Pastas 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 (Pasta) | A coleção de pastas filho 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: Caixa de entrada, Rascunhos, 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 |
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/v1.0/me/folders/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
Este recurso está atualmente disponível na v2.0 e beta. Para saber mais, no sumário à esquerda, vá para a seção referência da API REST do Office 365 e selecione uma dessas versões.
InferenceClassificationOverride
Este recurso está atualmente disponível na v2.0 e beta. Para saber mais, no sumário à esquerda, vá para a seção referência da API REST do Office 365 e selecione uma dessas versões.
ItemAttachment
Uma mensagem, contato ou evento anexado a outra mensagem ou evento. Derivado da entidade Anexo.
Tipo: Microsoft.OutlookServices.ItemAttachment
Tipo de base: Microsoft.OutlookServices.Attachment
| Propriedade | Tipo | Descrição | Gravável? |
|---|---|---|---|
| ContentType | Sequência de caracteres | O tipo de conteúdo do anexo. | Sim |
| DateTimeLastModified | 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 | booliano | Defina 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.
Mensagem
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? |
|---|---|---|---|---|---|
| Attachments | 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 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 (String) | As categorias associadas à mensagem. | Sim | Sim | Sim |
| CcRecipients | Coleção (Destinatário) | Os destinatários Cc 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 |
| DateTimeCreated | datetimeoffset | A data e a hora em que a mensagem foi criada. | Não | Sim | Não |
| DateTimeLastModified | datetimeoffset | A data e a hora em que a mensagem foi alterada pela última vez. | Não | Sim | Não |
| DateTimeReceived | datetimeoffset | A data e a hora em que a mensagem foi recebida. | Não | Sim | Sim |
| DateTimeSent | datetimeoffset | A data e a hora em que a mensagem foi enviada. | Não | Sim | Não |
| From | Destinatário | O proprietário da caixa de correio e o remetente da mensagem. | Sim | Sim | Sim |
| HasAttachments | booliano | Indica se a mensagem tem anexos. | Sim | 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: Baixo = 0, Normal = 1, Alto = 2. | Sim | Sim | Sim |
| IsDeliveryReceiptRequested | booliano | Indica se uma confirmação de leitura foi solicitada para a mensagem. | Sim | Sim | Não |
| IsDraft | booliano | Indica se a mensagem é um rascunho. Uma mensagem é um rascunho quando ela ainda não foi enviada. | Não | Sim | Não |
| IsRead | booliano | Indica se a mensagem foi lida. | Sim | Sim | Não |
| IsReadReceiptRequested | booliano | Indica se uma confirmação de leitura foi solicitada para a mensagem. | Sim | Sim | Não |
| ParentFolderId | Sequência de caracteres | O identificador exclusivo da pasta pai da mensagem. | Não | Não | Não |
| ReplyTo | Coleção (Destinatário) | Os endereços de email a serem usados ao responder. | Sim | Não | Não |
| Remetente | Destinatário | A conta que é realmente usada para gerar a mensagem. | Sim | Sim | Padrão |
| Subject | Sequência de caracteres | O assunto da mensagem. | Sim | Sim | Padrão |
| ToRecipients | Coleção (Destinatário) | Os destinatários Para 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
Este recurso está atualmente disponível na v2.0 e beta. Para saber mais, no sumário à esquerda, vá para a seção referência da API REST do Office 365 e selecione uma dessas versões.
ReferenceAttachment
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.
Tarefa
Este recurso está atualmente disponível nas versões beta e V2.0. Para saber mais, no sumário à esquerda, vá para a seção referência da API REST do Office 365 e selecione uma dessas versões.
TaskFolder
Este recurso está atualmente disponível nas versões beta e V2.0. Para saber mais, no sumário à esquerda, vá para a seção referência da API REST do Office 365 e selecione uma dessas versões.
TaskGroup
Este recurso está atualmente disponível nas versões beta e V2.0. Para saber mais, no sumário à esquerda, vá para a seção referência da API REST do Office 365 e selecione uma dessas versões.
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 relações (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 |
| Pastas | Coleção (Pasta) | As pastas em uma caixa de correio ou pasta. Propriedade de navegação. | Não | Não |
| ID | Sequência de caracteres | O identificador exclusivo do usuário. | Não | Não |
| MailboxGuid | guid | O GUID atribuído à caixa de correio do usuário. | Não | Sim |
| Mensagens | Coleção (Mensagem) | As mensagens em uma caixa de correio ou pasta. Propriedade de navegação. | Não | Não |
| RootFolder | Pasta | A pasta raiz da caixa de correio do usuário. Propriedade de navegação. | Não | Não |
Tipos complexos
- Attendee
- EmailAddress
- GeoCoordinates
- ItemBody
- Location
- PatternedRecurrence
- PhysicalAddress
- Destinatário
- RecurrencePattern
- RecurrenceRange
- ResponseStatus
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: Required, Optional, Resource. |
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 | duplo | A altitude do local. |
| Latitude | duplo | A latitude do local. |
| Longitude | duplo | A longitude do local. |
| Accuracy | duplo | A precisão do sensor fornecendo a latitude e longitude. |
| AltitudeAccuracy | duplo | 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. |
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. |
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. |
| State | 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 - Semanal. Deve definir o Dias da semana e o Primeiro dia da semana - Diário. 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. |
| Índice | 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. |
Enumerações
DayOfWeek
O conjunto de dias da semana.
Valores suportados:
- Domingo
- Segunda-feira
- Terça-feira
- Quarta-feira
- Quinta-feira
- Sexta-feira
- Sábado
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
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
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.
$searchpara pesqusiar critérios específicos$filterpara filtrar critérios específicos$selectpara solicitar propriedades específicas$orderbypara classificar resultados$tope$skippara paginar resultados$expandpara expandir os anexos de mensagens e os anexos de eventos$countpara obter a contagem 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 expressa 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. |
| Remetente | 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/v1.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/v1.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/v1.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/v1.0/me/messages?$search=%22pizza%22
GET https://outlook.office.com/api/v1.0/me/messages?$search=%22subject:pizza%22
GET https://outlook.office.com/api/v1.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 | DateTimeReceived gt 2014-09-01T00:00:00Z |
| ge | Maior ou igual a | DateTimeLastModified ge 2014-09-01T00:00:00Z |
| lt | Menor que | DateTimeReceived lt 2014-09-01T00:00:00Z |
| le | Menor ou igual a | DateTimeLastModified 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 do usuário com um assunto específico, você pode filtrar na propriedade Assunto.
GET https://outlook.office.com/api/v1.0/me/events?$filter=Subject eq 'Mega Charity Bash'
Para obter todas as mensagens não lidas na Caixa de entrada, você pode filtrar na propriedade IsRead.
GET https://outlook.office.com/api/v1.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/v1.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 na propriedade DateTimeReceived.
GET https://outlook.office.com/api/v1.0/me/messages?$filter=DateTimeReceived 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/v1.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/v1.0/me/events?$filter=Subject%20eq%20%27Mega%20Charity%20Bash%27
GET https://outlook.office.com/api/v1.0/me/messages?$filter=IsRead%20eq%20false
GET https://outlook.office.com/api/v1.0/me/messages?$filter=HasAttachments%20eq%20true
GET https://outlook.office.com/api/v1.0/me/messages?$filter=DateTimeReceived%20ge%202014-09-01
GET https://outlook.office.com/api/v1.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, 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 DateTimeReceived para todas as mensagens na Caixa de Entrada.
GET https://outlook.office.com/api/v1.0/me/messages?$select=Subject,Sender,DateTimeReceived
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 DateTimeReceived em ordem decrescente.
GET https://outlook.office.com/api/v1.0/me/messages?$orderby=DateTimeReceived desc
O mesmo exemplo com codificação de URL:
GET https://outlook.office.com/api/v1.0/me/messages?$orderby=DateTimeReceived%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 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/v1.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/v1.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/v1.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/v1.0/me/messages/$count?$filter=IsRead eq false
O mesmo exemplo com codificação de URL.
GET https://outlook.office.com/api/v1.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 defina como Alta.
Retornar apenas as propriedades Subject, Sender e DateTimeReceived.
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/v1.0/me/messages?
$filter=Importance eq 'High'
&$select=Subject,Sender,DateTimeReceived
&$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/v1.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/v1.0/me/messages?$filter=Importance%20eq%20%27High%27&select=Subject,Sender,DateTimeReceived&$top=5
https://outlook.office.com/api/v1.0/me/messages?$filter=Subject%20eq%20%27Good%20Times%27%20AND%20Importance%20eq%20%27High%27&$orderby=Subject,Importance,Sender
Ver também
- API REST do Outlook no Centro de Desenvolvimento do Outlook
- Visão geral sobre desenvolvimento na plataforma do Office 365
- Autenticação de aplicativo do Office 365 e autorização de recursos
- Registrar manualmente seu aplicativo no Azure AD para que ele possa acessar as APIs do Office 365
- Referência da API REST do E-mail do Outlook
- Referência da API REST de Calendário do Outlook
- Referência da API de Contatos do Outlook
- Referência da API REST de Tarefa do Outlook