Referência de recurso para as APIs REST de email, Calendário, Contatos e Tarefa (beta)

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

Observação

Esta documentação abrange recursos novos ou modificados para vários locais de eventos, compartilhamento de calendário, @-mentions, respostas rápidas, opções de idioma e fuso horário marcados como "(versão prévia)". Os recursos em versão prévia estão sujeitos a alterações antes da finalização e podem causar erros para quem os utiliza. Por essa razão, em geral, você deve usar somente uma versão de produção de uma API em seu código de produção. Se disponível, a v2.0 é atualmente a versão preferida.

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.

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

Não está interessado na versão beta da API? Na tabela de conteúdo à esquerda, vá para a seção Referência da API REST do Office 365 e selecione a versão desejada.

Dica

Você pode exibir o documento de metadados completo para o modelo de dados Mail, Agenda, Contatos e Tarefa, navegando até o ponto de extremidade $metadata em um navegador da Web (exemplo: https://outlook.office.com/api/beta/$metadata).

Attachment

Um arquivo, item (contato, evento ou mensagem) ou link para um arquivo ou pasta, que é anexado a um evento, mensagem, ou tarefa. Os recursos correspondentes fileAttachment, itemAttachment e referenceAttachment são todos derivados do recurso attachment.

Tipo: Microsoft.OutlookServices.Entity

Propriedade	Type	Descrição	Gravável?	Filtrável?
ContentType	Cadeia de caracteres	O tipo de MIME do anexo.	Sim	Não
IsInline	Booliano	true se o anexo for em linha; 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
Name	Cadeia de caracteres	O nome de exibição do anexo. Não precisa ser o nome real do arquivo.	Sim	Sim
Size	Int32	O comprimento do anexo em bytes.	Não	Não

Calendar

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

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

Propriedade	Type	Descrição	Gravável?	Filtrável?
CanEdit	Booliano	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	Booliano	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á-la.	Não	Sim
CanViewPrivateItems	Booliano	Verdadeiro se o usuário pode ler itens do calendário que foram marcados como particulares, caso contrário, falso.	Não	Sim
ChangeKey	Cadeia 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
Color	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	Cadeia de caracteres	Identificador exclusivo do calendário.	Não	Não
IsDefaultCalendar	Booliano	Verdadeiro se esse calendário for o calendário padrão do usuário, caso contrário, é falso.	Sim	Sim
IsShared	Booliano	Verdadeiro se o usuário tiver compartilhado o calendário com outros usuários, caso contrário, é falso. Como apenas o usuário que criou o calendário pode compartilhá-lo, IsShared e IsSharedWithMe não podem ser verdadeiros para o mesmo usuário.	Não	Sim
IsSharedWithMe	Booliano	Verdadeiro se o usuário tiver compartilhado este calendário, caso contrário, é falso. Esta propriedade sempre é falsa para um proprietário de calendário.	Não	Sim
Name	Cadeia 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
Events	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

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

Propriedade	Type	Descrição	Gravável?	Filtrável?
Name	Cadeia de caracteres	O nome do grupo.	Sim	Sim
ChangeKey	Cadeia 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	Cadeia de caracteres	O identificador da classe.	Não	Sim
Id	Cadeia de caracteres	O identificador exclusivo do grupo de calendários.	Não	Não
Calendars	Coleção (Calendário)	Os calendários no grupo de calendários. Propriedade de navegação.	Não	Não

Contact

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 de Contatos 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

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

Propriedade	Type	Descrição	Gravável?	Filtrável?
AssistantName	Cadeia de caracteres	O nome do assistente do contato.	Sim	Sim
Birthday	datetimeoffset	O aniversário do contato.	Sim	Sim
Categories	​Coleção(Cadeia de caracteres)​	As categorias associadas ao contato.	Sim	Não
ChangeKey	Cadeia 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(Cadeia de caracteres)​	Os nomes dos filhos do contato.	Sim	Sim
CompanyName	Cadeia de caracteres	O nome da empresa do contato.	Sim	Sim
CreatedDateTime	datetimeoffset	A hora em que o contato foi criado.	Não	Sim
Department	Cadeia de caracteres	O departamento do contato.	Sim	Sim
DisplayName	Cadeia de caracteres	O nome de exibição do contato.	Sim	Sim
EmailAddresses	Coleção (EmailAddress)	Os endereços de email do contato.	Sim	Não
Extensions	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	Cadeia de caracteres	O nome com o qual o contato está arquivado.	Sim	Sim
Flag	FollowupFlag	Informações sobre qualquer acompanhamento no contato.	Sim	Sim
Gender	Cadeia de caracteres	O sexo do contato.	Sim	Sim
Generation	Cadeia de caracteres	A geração do contato.	Sim	Sim
GivenName	Cadeia de caracteres	O nome do contato.	Sim	Sim
Id	Cadeia de caracteres	O identificador exclusivo do contato.	Não	Não
ImAddresses	​Coleção(Cadeia de caracteres)​	Os endereços de mensagens instantâneas (IM) do contato.	Sim	Não
Initials	Cadeia de caracteres	As iniciais do contato.	Sim	Sim
JobTitle	Cadeia de caracteres	O cargo do contato.	Sim	Sim
LastModifiedDateTime	datetimeoffset	A hora em que o contato foi modificado.	Não	Sim
Manager	Cadeia de caracteres	O nome do gerente do contato.	Sim	Sim
MiddleName	Cadeia de caracteres	O nome do meio do contato.	Sim	Sim
NickName	Cadeia de caracteres	O apelido do contato.	Sim	Sim
OfficeLocation	Cadeia de caracteres	O local do escritório do contato.	Sim	Sim
ParentFolderId	Cadeia de caracteres	A ID da pasta pai do contato.	Não	Não
PersonalNotes	Cadeia de caracteres	As anotações do usuário sobre o contato.	Sim	Sim
Phones	Coleção (Telefone)	Números de telefone associados ao contato, por exemplo, telefone residencial, celular e telefone comercial.	Sim	Sim
PostalAddresses	Coleção PhysicalAddress	Endereços associados ao contato, por exemplo, endereço residencial e endereço comercial.	Sim	Não
Profession	Cadeia de caracteres	A profissão do contato.	Sim	Sim
SpouseName	Cadeia de caracteres	O nome do cônjuge do contato.	Sim	Sim
Surname	Cadeia de caracteres	O sobrenome do contato.	Sim	Sim
Título	Cadeia de caracteres	O título do contato.	Sim	Não
Websites	Coleção (Site)	Sites associados ao contato.	Sim	Não
WeddingAnniversary	Date	O aniversário de casamento do contato.	Sim	Sim
YomiCompanyName	Cadeia de caracteres	O nome de empresa do contato em japonês fonético. Essa propriedade é opcional.	Sim	Não
YomiGivenName	Cadeia de caracteres	O nome do contato em japonês fonético. Essa propriedade é opcional.	Sim	Não
YomiSurname	Cadeia de caracteres	O sobrenome do contato em japonês fonético. Essa propriedade é opcional.	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, consulte 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

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

Propriedade	Type	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
Contacts	Coleção (Contato)	Os contatos na pasta. Propriedade de navegação.	Não	Não
DisplayName	Cadeia de caracteres	O nome de exibição da pasta.	Sim	Sim
Id	Cadeia de caracteres	Identificador exclusivo da pasta de contatos.	Não	Não
ParentFolderId	Cadeia de caracteres	A ID da pasta pai da pasta.	Não	Não
WellKnownName	Cadeia de caracteres	O nome da pasta, se a pasta for uma pasta reconhecida. Atualmente contacts é a única pasta de contatos reconhecida.	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

Event

Um evento em um calendário.

Tipo: Microsoft.OutlookServices.Event

Uma coleção de 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

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

Propriedade	Type	Descrição	Gravável?	Filtrável?
Attachments	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	Cadeia de caracteres	A visualização da mensagem associada ao evento.	Não	Não
Calendar	Calendar	O calendário que contém o evento. Propriedade de navegação.	Não	Não
Categories	​Coleção(Cadeia de caracteres)​	As categorias associadas ao evento.	Sim	Não
ChangeKey	Cadeia 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
End	DateTimeTimeZone	A data e a hora em que o evento termina.	Sim	Sim
Extensions	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	booliano	Definido como true se o evento tiver anexos.	Não	Sim
Id	Cadeia 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	Cadeia de caracteres	Um identificador exclusivo que é compartilhado por todas as instâncias de um evento em calendários diferentes.	Não	Sim
IsAllDay	booliano	Definido 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	booliano	Definida como true se o evento tiver sido cancelado.	Sim	Sim
IsOrganizer	booliano	Definida como true se o remetente da mensagem também for o organizador.	Sim	Sim
IsReminderOn	Booliano	Definida como true se um alerta estiver definido para lembrar o usuário sobre o evento.	Sim	Sim
LastModifiedDateTime	datetimeoffset	A data e a hora em que o evento foi modificado pela última vez.	Não	Sim
Location	Location	Informações sobre a localização do evento.	Sim	Sim
Locations	Coleção (Localização)	Os locais onde o evento é realizado ou assistido.	Sim	Sim
OnlineMeetingUrl	Cadeia de caracteres	Uma URL para uma reunião online.	Sim	Não
Organizer	Recipient	O organizador do evento.	Sim	Sim
OriginalEndTimeZone	Cadeia de caracteres	O fuso horário de término que foi definido quando o evento foi criado. consulte DateTimeTimeZone para uma lista de fusos horários válidos.	Não	Sim
OriginalStartTimeZone	Cadeia de caracteres	O fuso horário de início que foi definido quando o evento foi criado. consulte DateTimeTimeZone para uma lista de fusos horários válidos.	Não	Sim
Recurrence	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	booliano	Definida como true se o remetente quiser receber uma resposta quando o evento for aceito ou recusado.	Sim	Sim
ResponseStatus	ResponseStatus	Indica o tipo de resposta enviada a uma mensagem de evento.	Não	Sim
Sensitivity	Sensitivity	Indica o nível de privacidade do evento: Normal, Personal, Private, Confidential.	Sim	Sim
SeriesMasterId	Cadeia de caracteres	As categorias atribuídas ao item.	Sim	Não
ShowAs	FreeBusyStatus	O status a mostrar: Free, Tentative, Busy, Oof, WorkingElsewhere, Unknown.	Sim	Sim
Start	DateTimeTimeZone	A hora de início do evento.	Sim	Sim
Subject	Cadeia de caracteres	O texto da linha de assunto do evento.	Sim	Sim
Type	EventType	O tipo de evento: SingleInstance, Occurrence, Exception, SeriesMaster.	Sim	Sim
WebLink	Cadeia 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, consulte 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 eventos 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 com a Mensagem, com algumas pequenas diferenças descritas na tabela a seguir.

Ação/Verbo	Permission	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	Type	Descrição	Gravável?	Filtrável?
EndDateTime	DateTimeTimeZone	A data e a hora em que o evento associado termina.	Sim	Sim
Evento	Event	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
IsAllDay	Booliano	Indica se o evento dura o dia inteiro. Ajustar esta propriedade também requer o ajuste das propriedades StartDateTime e EndDateTime do evento.	Sim	Sim
IsOutOfDate	Booliano	Indica se esta solicitação de reunião foi desatualizada por uma solicitação mais recente.	Não	Não
Location	Location	O local do evento associado.	Sim	Sim
MeetingMessageType	MeetingMessageType	O tipo de mensagem de evento: Nenhum = 0, MeetingRequest = 1, MeetingCancelled = 2, MeetingAccepted = 3, MeetingTentativelyAccepted = 4, MeetingDeclined = 5	Não	Sim
Recurrence	PatternedRecurrence	O padrão de recorrência do evento associado.	Sim	Não
StartDateTime	DateTimeTimeZone	A hora de início do evento associado.	Sim	Sim
Type	EventType	O tipo do evento associado: SingleInstance = 0, Occurrence = 1, Exception = 2, SeriesMaster = 3.	Sim	Sim

EventMessageRequest (versão prévia)

Uma mensagem que representa uma solicitação de reunião.

Tipo base: EventMessage

Propriedade	Type	Descrição	Gravável?	Filtrável?
PreviousEndDateTime	DateTimeTimeZone	A data e a hora de término anteriores da reunião solicitada.	Não	Sim
PreviousLocation	Location	A localização anterior da reunião solicitada.	Não	Sim
PreviousStartDateTime	DateTimeTimeZone	A data e a hora de início anteriores da reunião solicitada.	Não	Sim

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	Type	Descrição	Gravável?	Filtrável?
Valor	​Coleção(Cadeia de caracteres)​	Uma coleção de valores de propriedade.	Sim	Não
PropertyId	Cadeia 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	Type	Descrição	Gravável?	Filtrável?
Valor	Cadeia de caracteres	Um valor de propriedade.	Sim	Não
PropertyId	Cadeia 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. consulte Formatos PropertyId para detalhes.

Consulte a 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 Attachment.

Tipo: ** Microsoft.OutlookServices.FileAttachment**

Tipo base: Microsoft.OutlookServices.Attachment

Propriedade	Type	Descrição	Gravável?
ContentBytes	binário	O conteúdo binário do arquivo.	Não
ContentId	Cadeia de caracteres	A ID do anexo no repositório do Exchange.	Não
ContentLocation	Cadeia de caracteres	O URI (Uniform Resource Identifier) que corresponde ao local do conteúdo do anexo.	Não
ContentType	Cadeia 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	Cadeia de caracteres	A ID do anexo.	Não
IsInline	booliano	Definida como true se este for um anexo em linha.	Sim
Name	Cadeia 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
Size	Int32	O tamanho do anexo em bytes.	Não

Folder / MailFolder

Observação

Na versão beta, 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

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

Propriedade	Type	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	Cadeia de caracteres	O nome de exibição da pasta.	Sim	Sim
Id	Cadeia de caracteres	O identificador exclusivo da pasta. Você pode usar os seguintes nomes conhecidos para acessar a pasta correspondente: Inbox, Drafts, SentItems, DeletedItems.	Não	Não
MessageRules	Coleção (MessageRule)	A coleção de regras que se aplicam à pasta da Caixa de Entrada. Propriedade de navegação.	Não	Não
Messages	Coleção (Mensagem)	A coleção de mensagens na pasta. Propriedade de navegação.	Não	Não
ParentFolderId	Cadeia 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
WellKnownName	Cadeia de caracteres	O nome conhecido da pasta, como clutter, deleteditems, drafts, inbox, junkemail, outbox ou sentitems.	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/beta/me/mailfolders/inbox/messages?$count=true&$filter=isread%20eq%20false

As 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 permitir o foco naquelas que são mais relevantes ou importantes para o usuário.

Tipo: Microsoft.OutlookServices.InferenceClassification

Propriedade	Type	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	Type	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	Cadeia 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 Attachment.

Tipo: Microsoft.OutlookServices.ItemAttachment

Tipo base: Microsoft.OutlookServices.Attachment

Propriedade	Type	Descrição	Gravável?
ContentType	Cadeia 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	Cadeia 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 em linha, como uma imagem incorporada no corpo do item.	Sim
Name	Cadeia de caracteres	O nome de exibição do anexo.	Sim
Size	Int32	O tamanho do anexo em bytes.	Sim

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

Representa uma notificação para uma pessoa com base no endereço de email dela. Esse tipo de notificação é também conhecido como @-mentions.

O recurso Message oferece suporte à Mention. Inclui uma propriedade MentionsPreview, que indica se o usuário conectado foi mencionado nessa instância, e a propriedade de navegação Menções, que suporta obter detalhes de qualquer menção nessa instância.

Ao criar uma mensagem, um aplicativo pode criar uma menção na mesma solicitação POST, incluindo a menção na propriedade Menções. Usando uma solicitação GET com o parâmetro de consulta $filter, um aplicativo pode retornar todas as mensagens na caixa de correio do usuário conectado que mencionam o usuário. Uma solicitação GET com o parâmetro de consulta $expand permite que o aplicativo expanda todas as menções em uma mensagem específica.

Esse mecanismo de permitir que um aplicativo seja definido e receba menções em mensagens habilita notificações leves, em que o usuário que faz a menção pode permanecer no contexto existente (como a composição de um corpo da mensagem) enquanto o aplicativo define a propriedade subjacente Menções. Pessoas mencionadas podem facilmente descobrir se e onde elas são mencionadas por meio de solicitações GET com o parâmetro de consulta $filter ou $expand.

Um exemplo de caso de uso da API Menções está no Outlook, o cliente de email. Quando um usuário digita @ ao escrever uma mensagem, o Outlook permite que o usuário simplesmente selecione ou insira um nome para completar a @-menção, sem ter que sair do contexto para chamar a atenção da pessoa. Sob as capas, o Outlook define a propriedade Menções antes de realmente criar e enviar a mensagem. O Outlook também usa operações GET com $filter e $expand para permitir que o usuário conectado procure convenientemente se e quais mensagens o mencionam, alertando o usuário sobre itens de ação ou discussões para uma resposta mais rápida.

Tipo: Microsoft.OutlookServices.Mention

Propriedade	Type	Descrição	Gravável?	Filtrável?
Application	Cadeia de caracteres	O nome do aplicativo em que a menção é criada. Opcional. Não usado e padronizado como nulo para Mensagem.	Sim	Não
ClientReference	Cadeia de caracteres	Um identificador exclusivo que representa um pai da instância do recurso. Opcional. Não usado e padronizado como nulo para Mensagem.	Sim	Sim
CreatedBy	EmailAddress	As informações de email do usuário que fez a menção. Obrigatório.	Sim	Não
CreatedDateTime	DateTimeOffset	A data e hora em que a menção é criada no cliente.	Não	Não
DeepLink	Cadeia de caracteres	Um link profundo da Web para o contexto da menção na instância do recurso. Opcional. Não usado e padronizado como nulo para Mensagem.	Sim	Não
Id	Cadeia de caracteres	O identificador exclusivo de uma menção em uma instância de recurso.	Não	Não
Mencionado	EmailAddress	As informações de email da pessoa mencionada. Obrigatório.	Sim	Não
MentionText	Cadeia de caracteres	Conteúdo para a menção. Opcional. Não usado e padronizado como nulo para Mensagem.	Sim	Não
ServerCreatedDateTime	DateTimeOffset	A data e hora em que a menção é criada no servidor. Opcional. Não usado e padronizado como nulo para Mensagem.	Não	Não

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

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

Propriedade	Type	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 (Recipient)	Os destinatários em Cco da mensagem.	Sim	Não	Sim
Body	ItemBody	O corpo da mensagem.	Sim	Não	Default
BodyPreview	Cadeia de caracteres	Os primeiros 255 caracteres do conteúdo do corpo da mensagem.	Não	Não	Sim
Categories	Coleção (Cadeia 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	Cadeia de caracteres	A versão da mensagem.	Não	Não	Não
ConversationId	Cadeia de caracteres	A ID da conversa à qual o email pertence.	Não	Sim	Não
ConversationIndex	Binário	Indica a posição relativa do item na conversa à qual o email pertence.	Não	Não	Não
CreatedDateTime	datetimeoffset	A data e a hora em que a mensagem foi criada.	Não	Sim	Não
Extensions	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
Flag	FollowupFlag	Informações sobre qualquer acompanhamento na mensagem.	Sim	Sim	Sim
From	Recipient	O proprietário da caixa de correio e remetente da mensagem.	Sim	Sim	Sim
HasAttachments	booliano	Indica se a mensagem tem anexos.	Não	Sim	Sim
Id	Cadeia 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
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	Não
InternetMessageId	Cadeia de caracteres	A ID da mensagem no formato especificado pelo RFC2822.	Não	Não	Não
InternetMessageHeaders	Coleção (InternetMessageHeader)	A coleção de cabeçalhos de mensagens da Internet no formato especificado por RFC2822.	Não	Não	Não
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
LastModifiedDateTime	datetimeoffset	A data e a hora em que a mensagem foi alterada pela última vez.	Não	Sim	Não
Menções	Coleção (Menção)	Uma coleção de menções na mensagem, ordenada pelo CreatedDateTime do mais novo ao mais antigo. Por padrão, uma mensagem GET não retorna essa propriedade a menos que você aplique $expand na propriedade. Propriedade de navegação.	Sim	Não	Não
MentionsPreview	MentionsPreview	Obter informações sobre menções em uma mensagem. Ao processar uma solicitação GET /messages, o servidor define essa propriedade e inclui na resposta por padrão. O servidor retorna null se não houver menções na mensagem. Opcional.	Nã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	Não
ParentFolderId	Cadeia 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
Remetente	Recipient	A conta que é realmente usada para gerar a mensagem.	Sim	Sim	Default
SentDateTime	datetimeoffset	A data e a hora em que a mensagem foi enviada.	Não	Sim	Nã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
Subject	Cadeia de caracteres	O assunto da mensagem.	Sim	Sim	Default
ToRecipients	Coleção (Recipient)	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
UnsubscribeData	Coleção (Cadeia de caracteres)	Contém as entradas válidas analisadas do cabeçalho List-Unsubscribe. Se a propriedade UnsubscribeEnabled for true, isso conteria os dados para o comando mailto: no cabeçalho List-Unsubscribe. Os dados devem estar de acordo com RFC-2369. Use a ação Cancelar assinatura para parar futuras mensagens enviadas para a lista de distribuição correspondente.	Não	Não	Não
UnsubscribeEnabled	booliano	Indica se essa mensagem permite que um destinatário cancele a assinatura e pare as mensagens futuras enviadas de acordo com uma lista de distribuição de email. True se o cabeçalho List-Unsubscribe estiver em conformidade com RFC-2369.	Não	Não	Não
WebLink	Cadeia 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)

Uma regra que se aplica a mensagens na Caixa de Entrada de um usuário.

Tipo: Microsoft.OutlookServices.MessageRule

Propriedade	Type	Descrição	Gravável?
Actions	MessageRuleActions	Ações a serem realizadas em uma mensagem quando as condições correspondentes forem atendidas.	Sim
Conditions	MessageRulePredicates	Condições que, quando atendidas, dispararão as ações correspondentes dessa regra.	Sim
DisplayName	Cadeia de caracteres	O nome de exibição da regra.	Sim
Exceptions	MessageRulePredicates	Representa condições de exceção para a regra.	Sim
HasError	Booliano	Indica se a regra está em uma condição de erro.	Não
IsEnabled	Booliano	Indica se a regra está habilitada para ser aplicada a mensagens.	Sim
IsReadOnly	Booliano	Indica se a regra é somente leitura e não pode ser modificada ou excluída pelas regras da API REST.	Sim
Sequence	Int32	Indica a ordem em que a regra é executada, entre outras regras.	Sim

OutlookCategory (versão prévia)

Tipo: Microsoft.OutlookServices.OutlookCategory

Uma categoria pela qual um usuário pode agrupar itens do Outlook como mensagens e eventos em sua caixa de correio.

Propriedade	Type	Descrição	Gravável?	Filtrável?
DisplayName	Cadeia de caracteres	Um nome exclusivo para esta categoria na caixa de correio do usuário.	Não	Sim
Color	CategoryColor	Uma constante predefinida que representa a cor mapeada para essa categoria.	Sim	Sim

Photo

Tipo: Microsoft.OutlookServices.Photo

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

Propriedade	Type	Descrição	Gravável?	Filtrável?
Height	int	A altura da foto	Não	Não
Id	Cadeia de caracteres	O identificador exclusivo da foto.	Não	Não
Width	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 Attachment.

Propriedade	Type	Descrição	Gravável?	Filtrável?
ContentType	Cadeia de caracteres	O tipo de MIME do anexo. Opcional.	Sim	Não
Id	Cadeia de caracteres	O identificador exclusivo do anexo de referência.	Não	Não
IsFolder	Booliano	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	Booliano	true se o anexo for em linha; 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
Name	Cadeia de caracteres	O nome de exibição do anexo. Não precisa ser o nome real do arquivo. Obrigatório.	Sim	Sim
Permission	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	Cadeia 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
Size	Int32	O tamanho do anexo em bytes. Opcional.	Não	Não
SourceUrl	Cadeia 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	Cadeia 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

Task

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	Type	Descrição	Gravável?	Filtrável?
AssignedTo	Cadeia de caracteres	O nome da pessoa que recebeu a tarefa.	Não	Sim
Attachments	Coleção (Anexo)	A coleção de anexos FileAttachment, ItemAttachmente ReferênciaAttachment 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
Categories	​Coleção(Cadeia de caracteres)​	As categorias associadas à tarefa.	Sim	Sim
ChangeKey	Cadeia 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	booliano	Definida como verdadeira se a tarefa tiver anexos.	Não	Sim
Id	Cadeia de caracteres	O identificador exclusivo da tarefa.	Não	Não
Importance	Importance	A importância do evento: Low, Normal, High.	Sim	Sim
IsReminderOn	booliano	Definida como verdadeira 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	Cadeia de caracteres	O nome da pessoa que criou a tarefa.	Não	Sim
ParentFolderId	Cadeia de caracteres	O identificador exclusivo da pasta pai da tarefa.	Não	Não
Recurrence	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	Cadeia 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	Type	Descrição	Gravável?	Filtrável?
ChangeKey	Cadeia de caracteres	A versão da pasta de tarefas.	Não	Não
Id	Cadeia de caracteres	O identificador exclusivo da pasta de tarefas.	Não	Não
IsDefaultFolder	Booliano	Verdadeiro se a pasta for a pasta de tarefas padrão.	Não	Sim
Name	Cadeia 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
Tasks	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	Type	Descrição	Gravável?	Filtrável?
ChangeKey	Cadeia 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	Cadeia de caracteres	O identificador exclusivo do grupo de tarefas.	Não	Não
IsDefaultGroup	Booliano	Verdadeiro se o grupo de tarefas for o grupo de tarefas padrão.	Não	Sim
Name	Cadeia 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

User

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 quantidade 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	Type	Descrição	Gravável?	Filtrável?
Alias	Cadeia de caracteres	O alias do usuário. Normalmente, o endereço SMTP do usuário.	Sim	Sim
Calendar	Calendar	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
Calendars	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
Contacts	Coleção (Contato)	Os contatos do usuário. Propriedade de navegação.	Não	Não
DisplayName	Cadeia de caracteres	O nome de exibição do usuário.	Sim	Sim
Events	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	Cadeia 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
MasterCategories	Coleção (OutlookCategory)	A lista mestra de categorias do usuário. Propriedade de navegação.	Sim	Sim
Messages	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
• AttendeeAvailability
• AttendeeBase
• AutomaticRepliesMailTips (versão prévia)
• AutomaticRepliesSetting
• DateTimeTimeZone
• EmailAddress
• Error (versão prévia)
• FollowUpFlag (versão prévia)
• GeoCoordinates
• InternetMessageHeader (versão prévia)
• ItemBody
• LocaleInfo
• Location
• LocationConstraint
• LocationConstraintItem
• MailboxSettings
• MailTips (versão prévia)
• MeetingTimeSuggestion
• MeetingTimeSuggestionsResult
• MentionsPreview (versão prévia)
• MessageRuleActions (versão prévia)
• MessageRulePredicates (versão prévia)
• PatternedRecurrence
• Phone (versão prévia)
• PhysicalAddress
• Recipient
• RecurrencePattern
• RecurrenceRange
• ResponseStatus
• SizeRange (versão prévia)
• TimeConstraint
• TimeSlot
• TimeZoneInformation (versão prévia)
• Website (versão prévia)
• WorkingHours (versão prévia)

Attendee

Um participante do evento.

Tipo: Microsoft.OutlookServices.AttendeeBase

Propriedade	Type	Descrição
Status	ResponseStatus	A resposta (nenhuma, aceita, recusada etc.) e a hora.

AttendeeAvailability

O tipo e a disponibilidade dos participantes.

Tipo: Microsoft.OutlookServices.AttendeeAvailability

Propriedade	Type	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	Type	Descrição
Type	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.

AutomaticRepliesMailTips (versão prévia)

Dicas de email sobre respostas automáticas configuradas em uma caixa de correio.

Tipo: Microsoft.OutlookServices.AutomaticRepliesMailTips

Propriedade	Type	Descrição
Message	Cadeia de caracteres	A mensagem de resposta automática.
MessageLanguage	LocaleInfo	O idioma em que a mensagem de resposta automática está.
ScheduledStartTime	DateTimeTimeZone	A data e a hora em que as respostas automáticas são definidas para começar.
ScheduledEndTime	DateTimeTimeZone	A data e a hora em que as respostas automáticas estão definidas para terminar.

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	Type	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	Cadeia de caracteres	A resposta automática para enviar ao público externo especificado, se Status for AlwaysEnabled ou Scheduled.
InternalReplyMessage	Cadeia 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	Configurações de status 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	Type	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	Cadeia 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. consulte 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	Type	Descrição
Name	Cadeia de caracteres	O nome de exibição da pessoa ou entidade.
Address	Cadeia de caracteres	O endereço de email da pessoa ou entidade.

Error (versão prévia)

Um erro que ocorre durante uma ação.

Tipo: Microsoft.OutlookServices.Error

Propriedade	Type	Descrição
Message	Cadeia de caracteres	A mensagem de erro.
Code	Cadeia de caracteres	O código do erro.

FollowUpFlag (versão prévia)

Informações sobre o acompanhamento de uma instância de recurso.

Tipo: Microsoft.OutlookServices.FollowupFlag

Propriedade	Type	Descrição
CompletedDateTime	DateTimeTimeZone	Data e hora em que o acompanhamento foi concluído.
DueDateTime	DateTimeTimeZone	Data e hora em que o acompanhamento deve ser concluído.
StartDateTime	DateTimeTimeZone	Data e hora em que o acompanhamento deve começar.
FlagStatus	FollowupFlagStatus	Representa se a instância do recurso pai está sinalizada para acompanhamento ou se o seu acompanhamento está concluído.

GeoCoordinates

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

Tipo: Microsoft.OutlookServices.GeoCoordinates

Propriedade	Type	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 longitude.
AltitudeAccuracy	double	A precisão do sensor fornecendo a altitude.

InternetMessageHeader (versão prévia)

Um par chave-valor que representa um cabeçalho da mensagem da Internet no formato especificado pelo RFC2822 que fornece detalhes do caminho de rede feito por uma mensagem do remetente para o destinatário.

Tipo: Microsoft.OutlookServices.InternetMessageHeader

Propriedade	Type	Descrição
Name	Cadeia de caracteres	A chave no par chave-valor do cabeçalho da mensagem da Internet.
Valor	Cadeia de caracteres	O valor no par chave-valor do cabeçalho da mensagem da Internet.

ItemBody

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

Tipo: Microsoft.OutlookServices.ItemBody

Propriedade	Type	Descrição
ContentType	BodyType	O tipo de conteúdo: Text = 0, HTML = 1.
Content	Cadeia 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	Type	Descrição
DisplayName	Cadeia de caracteres	Um nome que representa uma localidade por seu idioma natural, por exemplo, "Inglês (Estados Unidos)".
Localidade	Cadeia 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.

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

O local de um evento.

Tipo: Microsoft.OutlookServices.Location

Propriedade	Type	Descrição
Address	PhysicalAddress	O endereço físico do local.
Coordenadas	GeoCoordinates	As coordenadas geográficas e a elevação do local.
DisplayName	Cadeia de caracteres	O nome associado ao local.
LocationEmailAddress	Cadeia de caracteres	O endereço de email opcional do local.
LocationUri	Cadeia de caracteres	URI opcional que representa o local.
LocationType	LocationType	O tipo de localização: Default, ConferenceRoom, HomeAddress, BusinessAddress,GeoCoordinates, StreetAddress, Hotel, Restaurant, LocalBusiness, PostalAddress.

LocationConstraint

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

Tipo: Microsoft.OutlookServices.LocationConstraint

Propriedade	Type	Descrição
IsRequired	booliano	O cliente solicita que o serviço inclua na resposta um local de reunião para a reunião.
SuggestLocation	booliano	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	Type	Descrição
ResolveAvailability	booliano	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 é true.

MailTips (versão prévia)

Mensagens informativas exibidas para os usuários enquanto eles estão compondo uma mensagem. Por exemplo, uma mensagem de ausência temporária como uma resposta automática para um destinatário da mensagem.

Tipo: Microsoft.OutlookServices.MailTips

Propriedade	Type	Descrição
EmailAddress	EmailAddress	O endereço de email do destinatário para receber as dicas de email.
AutomaticReplies	AutomaticRepliesMailTips	Dicas de email para a resposta automática, caso tenham sido configuradas pelo destinatário.
MailboxFull	Booliano	O status completo da caixa de correio do destinatário.
CustomMailTip	Cadeia de caracteres	Uma dica de email personalizada que pode ser definida na caixa de correio do destinatário.
ExternalMemberCount	Int32	O número de membros externos, se o destinatário for uma lista de distribuição.
TotalMemberCount	Int32	O número de membros, se o destinatário for uma lista de distribuição.
DeliveryRestricted	Booliano	Caso a caixa de correio do destinatário está restrita ou não, por exemplo, aceitando mensagens apenas de uma lista predefinida de remetentes, rejeitando mensagens de uma lista predefinida de remetentes ou aceitando mensagens apenas de remetentes autenticados.
IsModerated	Booliano	Se o envio de mensagens para o destinatário requer aprovação. Por exemplo, se o destinatário for uma grande lista de distribuição e um moderador tiver sido configurado para aprovar mensagens enviadas para essa lista de distribuição ou se o envio de mensagens para um destinatário exigir a aprovação do gerente do destinatário.
RecipienteScope	RecipientScopeType	O escopo do destinatário, como um parceiro interno ou externo. Por exemplo, um administrador pode definir outra organização como "parceira". O escopo é útil se um administrador quiser que determinadas dicas de email estejam acessíveis a determinados escopos. Também é útil para os remetentes informá-los de que a mensagem pode sair da organização, ajudando-os a tomar as decisões corretas sobre texto, tom e conteúdo.
RecipientSuggestions	Coleção (Destinatário)	Destinatários sugeridos com base em contextos anteriores em que aparecem na mesma mensagem.
MaxMessageSize	Int32	O tamanho máximo da mensagem que foi configurado para a organização ou caixa de correio do destinatário.
Erro	Error	Erros que ocorrem durante a ação GetMailTips.

MailboxSettings

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

Tipo: Microsoft.OutlookServices.MailboxSettings

Propriedade	Type	Descrição
AutomaticRepliesSetting	AutomaticRepliesSetting	Configurações para definir automaticamente o envio de respostas às mensagens recebidas.
TimeZone	Cadeia 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.
WorkingHours	WorkingHours	Os dias da semana e as horas de um fuso horário específico que o usuário trabalha.

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	Type	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	Cadeia 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:

Participante	Status livre/ocupado	% de chance de comparecer
Dana	Disponível	100%
Davi	Unknown	49%
Lara	Busy	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 se não houver motivo.

Tipo: Microsoft.OutlookServices.MeetingTimeSuggestionsResult

Propriedade	Type	Descrição
MeetingTimeSuggestions	Coleção (MeetingTimeSuggestion)	Uma matriz de sugestões de reunião.
EmptySuggestionsReason	Cadeia de caracteres	Um motivo para não retornar nenhuma 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 cadeia 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.
Unknown	O motivo para não retornar nenhuma sugestão de reunião não é conhecido.

MentionsPreview (versão prévia)

Representa informações sobre menções em uma instância de recurso.

Tipo: Microsoft.OutlookServices.MentionsPreview

Propriedade	Type	Descrição
IsMentioned	Booliano	Verdadeiro se o usuário conectado for mencionado na instância de recurso pai. Somente leitura. Suporta filtros.

MessageRuleActions (versão prévia)

Representa o conjunto de ações que estão disponíveis para uma regra.

Tipo: Microsoft.OutlookServices.MessageRuleActions

Propriedade	Type	Descrição
AssignCategories	Coleção (Cadeia de caracteres)	Uma lista de categorias a serem atribuídas a uma mensagem.
CopyToFolder	Cadeia de caracteres	O ID de uma pasta para a qual uma mensagem deve ser copiada.
Delete	Booliano	Indica se uma mensagem deve ser movida para a pasta Itens Excluídos.
ForwardAsAttachmentTo	Coleção (Recipient)	Os endereços de email dos destinatários para os quais uma mensagem deve ser encaminhada como um anexo.
ForwardTo	Coleção (Destinatário)	Os endereços de email dos destinatários para os quais uma mensagem deve ser encaminhada.
MarkAsRead	Booliano	Indica se uma mensagem deve ser marcada como lida.
MarkImportance	Importance	Define a importância da mensagem, que pode ser: Low, Normal, High.
MoveToFolder	Cadeia de caracteres	O ID da pasta para a qual uma mensagem será movida.
PermanentDelete	Booliano	Indica se uma mensagem deve ser excluída permanentemente e não salva na pasta Itens Excluídos.
RedirectTo	Recipient	Os endereço de email para o qual uma mensagem deve ser redirecionada.
StopProcessingRules	Booliano	Indica se regras subsequentes devem ser avaliadas.

MessageRulePredicates (versão prévia)

Representa o conjunto de condições e exceções disponíveis para uma regra.

Tipo: Microsoft.OutlookServices.MessageRulePredicates

Propriedade	Type	Descrição
BodyContains	Coleção (Cadeia de caracteres)	Representa as cadeias de caracteres que devem aparecer no corpo de uma mensagem de entrada para que a exceção ou condição seja aplicada.
BodyOrSubjectContains	Coleção (Cadeia de caracteres)	Representa as cadeias de caracteres que devem aparecer no corpo ou assunto de uma mensagem de entrada para que a exceção ou condição seja aplicada.
Categories	Coleção (Cadeia de caracteres)	Representa as categorias com as quais a mensagem de entrada deve ser rotulada para que a exceção ou condição seja aplicada.
FromAddresses	Coleção (Recipient)	Representa os endereços de e-mail do remetente específico de uma mensagem recebida para que a condição ou exceção seja aplicada.
HasAttachments	Booliano	Indica se uma mensagem de entrada deve ter anexos para que a exceção ou condição seja aplicada.
HeaderContains	Coleção (Cadeia de caracteres)	Representa as cadeias de caracteres que são exibidas nos cabeçalhos de uma mensagem de entrada para que a exceção ou condição seja aplicada.
Importance	Importance	A importância que é marcada em uma mensagem de entrada para que a exceção ou condição seja aplicada: Low, Normal, High.
IsApprovalRequest	Booliano	Indica se uma mensagem de entrada deve ser uma solicitação de aprovação para que a exceção ou condição seja aplicada.
IsAutomaticForward	Booliano	Indica se uma mensagem de entrada deve ser encaminhada automaticamente para que a exceção ou condição seja aplicada.
IsAutomaticReply	Booliano	Indica se uma mensagem de entrada deve ser uma resposta automática para que a exceção ou condição seja aplicada.
IsEncrypted	Booliano	Indica se uma mensagem de entrada deve estar criptografada para que a exceção ou condição seja aplicada.
IsMeetingRequest	Booliano	Indica se uma mensagem de entrada deve ser uma solicitação de reunião para que a exceção ou condição seja aplicada.
IsMeetingResponse	Booliano	Indica se uma mensagem de entrada deve ser uma resposta à solicitação de reunião para que a exceção ou condição seja aplicada.
IsNonDeliveryReport	Booliano	Indica se uma mensagem de entrada deve ser uma notificação de falha na entrega para que a exceção ou condição seja aplicada.
IsPermissionControlled	Booliano	Indica se uma mensagem de entrada deve ser uma permissão controlada (protegida por RMS) para que a exceção ou condição seja aplicada.
IsReadReceipt	Booliano	Indica se uma mensagem de entrada deve ser uma confirmação de leitura para que a exceção ou condição seja aplicada.
IsSigned	Booliano	Indica se uma mensagem de entrada deve ser assinada por S/MIME para que a exceção ou condição seja aplicada.
IsVoicemail	Booliano	Indica se uma mensagem de entrada deve ser uma caixa postal para que a exceção ou condição seja aplicada.
MessageActionFlag	MessageActionFlag	Representa o valor do sinalizador de ações que é exibido em uma mensagem de entrada para que a exceção ou condição seja aplicada.
NotSentToMe	Booliano	Indica se o proprietário da caixa de correio não deve ser um destinatário de uma mensagem de entrada para que a condição ou exceção seja aplicada.
ReceipentContains	Coleção (Cadeia de caracteres)	Representa as cadeias de caracteres que são exibidas nas propriedades ToRecipients ou CcRecipients de uma mensagem de entrada para que a exceção ou condição seja aplicada.
SenderContains	Coleção (Cadeia de caracteres)	Representa as cadeias de caracteres que são exibidas na propriedade De de uma mensagem de entrada para que a exceção ou condição seja aplicada.
Sensitivity	Sensitivity	Representa o nível de confidencialidade que deve ser marcado em uma mensagem de entrada para que a condição ou exceção seja aplicada. Os valores possíveis são: Normal, Personal, Private, Confidential.
SentCcMe	Booliano	Indica se o proprietário da caixa de correio deve estar na propriedade CcRecipients de uma mensagem de entrada para que a condição ou exceção seja aplicada.
SentOnlyToMe	Booliano	Indica se o proprietário da caixa de correio deve ser o único destinatário em uma mensagem de entrada para que a condição ou exceção seja aplicada.
SentToAddresses	Coleção (Recipient)	Representa os endereços de email para os quais uma mensagem de entrada deve ter sido enviada para que a condição ou exceção seja aplicada.
SentToMe	Booliano	Indica se o proprietário da caixa de correio deve estar na propriedade ToRecipients de uma mensagem de entrada para que a condição ou exceção seja aplicada.
SentToOrCcMe	Booliano	Indica se o proprietário da caixa de correio deve estar na propriedade ToRecipients ou CcRecipients de uma mensagem de entrada para que a condição ou exceção seja aplicada.
SubjectContains	Coleção (Cadeia de caracteres)	Representa as cadeias de caracteres que são exibidas no assunto de uma mensagem de entrada para que a exceção ou condição seja aplicada.
WithinSizeRange	SizeRange	Representa os tamanhos mínimo e máximo (em kilobytes) nos quais uma mensagem de entrada deve se enquadrar para que a condição ou exceção seja aplicada.

PatternedRecurrence

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

Tipo: Microsoft.OutlookServices.PatternedRecurrence

Propriedade	Type	Descrição
Pattern	RecurrencePattern	A frequência de um evento.
RecurrenceTimeZone	Cadeia de caracteres	O fuso horário dos horários inicial e final. consulte o tipo complexo DateTimeTimeZone para a lista de fusos horários suportados.
Intervalo	RecurrenceRange	A duração de um evento.

Phone

Representa um número de telefone.

Tipo: Microsoft.OutlookServices.Phone

Propriedade	Type	Descrição
Number	cadeia de caracteres	O número de telefone.
Type	Cadeia de caracteres	O tipo de número de telefone. Os valores possíveis são: Home, Business, Mobile, Other, Assistant, HomeFax, BusinessFax, OtherFax, Pager, Radio.

PhysicalAddress

O endereço físico de um contato.

Tipo: Microsoft.OutlookServices.PhysicalAddress

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

Recipient

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

Tipo: Microsoft.OutlookServices.Recipient

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

RecurrencePattern

A frequência de um evento.

Tipo: Microsoft.OutlookServices.RecurrencePattern

Propriedade	Type	Descrição
Type	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.
Month	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	Type	Descrição
Type	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	Type	Descrição
Response	ResponseType	O tipo de resposta: None, Organizer, TentativelyAccepted, Accepted, Declined, NotResponded.
Time	datetimeoffset	A data e hora em que a resposta retornou.

SizeRange (versão prévia)

Especifica os tamanhos mínimo e máximo (em kilobytes) que uma mensagem de entrada deve ter para que a condição ou exceção seja aplicada.

Tipo: Microsoft.OutlookServices.SizeRange

Propriedade	Type	Descrição
MaximumSize	Int32	Especifica o tamanho máximo (em kilobytes) que uma mensagem de entrada deve ter para que a condição ou exceção seja aplicada.
MinimumSize	Int32	Especifica o tamanho mínimo (em kilobytes) que uma mensagem de entrada deve ter para que a condição ou exceção seja aplicada.

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	Type	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	Type	Descrição
Start	DateTimeTimeZone	A hora em que um período inicia.
End	DateTimeTimeZone	A hora em que um período termina.

TimeZoneInformation (versão prévia)

Representa um fuso horário. Os formatos suportados são Windows e fuso horário da autoridade de atribuição de números da Internet (IANA) (também conhecido como fuso horário de Olson).

Tipo: Microsoft.OutlookServices.TimeZoneInformation

Propriedade	Type	Descrição
Alias	Cadeia de caracteres	Um identificador para o fuso horário.
DisplayName	Cadeia de caracteres	Uma cadeia de caracteres de exibição que representa o fuso horário.

Site (versão prévia)

Representa um site.

Tipo: Microsoft.OutlookServices.Website

Propriedade	Type	Descrição
Address	Cadeia de caracteres	A URL do site.
DisplayName	Cadeia de caracteres	O nome de exibição do site da Web.
Type	WebsiteType	O tipo de site normalmente associado a um contato. Os valores possíveis são: Blog, Home, Other, Profile, Work.

WorkingHours (versão prévia)

Representa os dias da semana e as horas de um fuso horário específico em que o usuário trabalha.

Tipo: Microsoft.OutlookServices.WorkingHours

Propriedade	Type	Descrição
DaysOfWeek	Coleção (DayOfWeek)	Uma coleção de dias da semana em que o usuário trabalha: domingo = 0, segunda-feira = 1, terça-feira = 2, quarta-feira = 3, quinta-feira = 4, sexta-feira = 5, sábado = 6.
StartTime	Edm.TimeOfDay	A hora do dia em que o usuário começa a trabalhar.
EndTime	Edm.TimeOfDay	A hora do dia em que o usuário para de trabalhar.
TimeZone	Cadeia de caracteres	O fuso horário ao qual o horário de trabalho se aplica. consulte DateTimeTimeZone para uma lista de fusos horários válidos.

Enumerações

• ActivityDomain
• AutomaticRepliesStatus
• CategoryColor (versão prévia)
• DayOfWeek
• ExternalAudienceScope
• FollowupFlagStatus (preview)
• FreeBusyStatus
• InferenceClassificationType
• TipoLocal (versão prévia)
• MailTipsType (versão prévia)
• MessageActionFlag (versão prévia)
• PhoneType (versão prévia)
• RecipientScopeType (versão prévia)
• ReferenceAttachmentPermissions
• ReferenceAttachmentProviders
• TaskStatus
• TimeZoneStandard
• WebsiteType

DayOfWeek

O conjunto de dias da semana.

Valores suportados:

• Sunday
• Monday
• Tuesday
• Wednesday
• Thursday
• Friday
• Saturday

FreeBusyStatus

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

Valores suportados:

• Busy
• Free
• Fora do escritório
• Tentativa
• Unknown
• WorkingElsewhere

ActivityDomain

A natureza de uma atividade.

Valores suportados:

• Trabalho
• Personal
• Unrestricted
• Unknown

AutomaticRepliesStatus

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

Valores suportados:

• AlwaysEnabled
• Desabilitado
• Scheduled

CategoryColor (versão prévia)

A cor que caracteriza uma categoria na caixa de correio do usuário. A cor real que cada constante predefinida representa depende do cliente do Outlook que está sendo usado para exibir as categorias.

Valor suportado	Cor mapeada para no cliente da área de trabalho do Outlook
Preset0	Vermelho
Preset1	Laranja
Preset2	Marrom
Preset3	Amarelo
Preset4	Verde
Preset5	Azul-petróleo
Preset6	Verde-oliva
Preset7	Azul
Preset8	Roxo
Preset9	Uva
Preset10	Aço
Preset11	DarkSteel
Preset12	Cinza
Preset13	DarkGray
Preset14	Preto
Preset15	DarkRed
Preset16	DarkOrange
Preset17	DarkBrown
Preset18	DarkYellow
Preset19	DarkGreen
Preset20	DarkTeal
Preset21	DarkOlive
Preset22	DarkBlue
Preset23	DarkPurple
Preset24	DarkCranberry
Nenhum	Nenhuma cor mapeada

ExternalAudienceScope

O conjunto de público externo para enviar ExternalReplyMessage.

Valores suportados:

• All
• ContactsOnly
• None

FollowupFlagStatus (versão prévia)

Representa o status do sinalizador de acompanhamento de uma instância de recurso.

Valores suportados:

• Complete
• Sinalizado
• NotFlagged

InferenceClassificationType

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

Valores suportados:

• Focused
• Other

LocationType (versão prévia)

Os possíveis tipos de localizações.

Valores suportados:

• Default
• Sala de conferencia
• HomeAddress
• BusinessAddress
• GeoCoordinates
• StreetAddress
• Hotel
• Restaurante
• LocalBusiness
• PostalAddress

MailTipsType (versão prévia)

Uma enumeração de sinalizadores que representa as dicas de email solicitadas.

Valores suportados:

• AutomaticReplies
• CustomMailTip
• DeliveryRestriction
• ExternalMemberCount
• MailboxFullStatus
• MaxMessageSize
• ModerationStatus
• RecipienteScope
• RecipientSuggestions
• TotalMemberCount

MessageActionFlag (versão prévia)

Especifica a ação a ser executada para uma mensagem.

Valores suportados:

• Any
• Call
• DoNotForward
• FollowUp
• FYI
• Forward
• NoResponseNecessary
• Read
• Responder
• ReplyToAll
• Revisão

PhoneType (versão prévia)

O tipo de números de telefone normalmente associados a um contato.

Valores suportados:

• Assistant
• Business
• BusinessFax
• Home
• HomeFax
• Mobile
• Outros
• OtherFax
• Pager
• Radio

RecipientScopeType (versão prévia)

Uma enumeração de sinalizadores que representa os tipos de escopos de destinatário. Os escopos de destinatários são usados ​​pelos administradores para especificar determinadas dicas de email a serem acessadas apenas para um determinado escopo.

Valores suportados:

• Nenhum
• Internal
• Externa
• ExternalPartner
• ExternalNonPartner

ReferenceAttachmentPermissions

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

Valores suportados:

• Other
• View
• Edit
• AnonymousView
• AnonymousEdit
• OrganizationView
• OrganizationEdit

ReferenceAttachmentProviders

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

Valores suportados:

• Dropbox
• OneDriveBusiness
• OneDriveConsumer
• Other

Sensitivity

Indica o nível de privacidade.

Valores suportados:

• Normal
• Personal
• Private
• Confidential

TaskStatus

Especifica o estado ou progresso de uma tarefa.

Valores suportados:

• Completed
• Deferred
• InProgress
• NotStarted
• WaitingOnOthers

TimeZoneStandard (versão prévia)

O formato para expressar fusos horários.

Valores suportados:

• Windows
• Iana

WebsiteType (versão prévia)

O tipo de site normalmente associado a um contato.

Valores suportados:

• Blog
• Home
• Other
• Profile
• Work

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 email, 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.

Pesquisar 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.
Bcc	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 Body, Sender, e Subject . 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/beta/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/beta/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/beta/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/beta/me/messages?$search=%22pizza%22
GET https://outlook.office.com/api/beta/me/messages?$search=%22subject:pizza%22
GET https://outlook.office.com/api/beta/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	Type	Exemplo
and	Lógico E (usado para combinar vários critérios)	TotalCount gt 0 and ChildFolderCount eq 0
or	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 cadeia de caracteres dentro do critério de filtro. Use %27 para codificar em URL a aspa simples. A cadeia 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/beta/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 Subject.

GET https://outlook.office.com/api/beta/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/beta/me/messages?$filter=IsRead eq false

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

GET https://outlook.office.com/api/beta/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 ReceivedDateTime.

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

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

GET https://outlook.office.com/api/beta/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/beta/me/events?$filter=Start/DateTime%20ge%20%272016-04-01T08:00%27
GET https://outlook.office.com/api/beta/me/events?$filter=Subject%20eq%20%27Mega%20Charity%20Bash%27
GET https://outlook.office.com/api/beta/me/messages?$filter=IsRead%20eq%20false
GET https://outlook.office.com/api/beta/me/messages?$filter=HasAttachments%20eq%20true
GET https://outlook.office.com/api/beta/me/messages?$filter=ReceivedDateTime%20ge%202014-09-01
GET https://outlook.office.com/api/beta/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 ReceivedDateTime para todas as mensagens na Caixa de Entrada.

GET https://outlook.office.com/api/beta/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/beta/me/messages?$orderby=ReceivedDateTime desc

O mesmo exemplo com codificação de URL:

GET https://outlook.office.com/api/beta/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/beta/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/beta/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/beta/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/beta/me/messages/$count?$filter=IsRead eq false

O mesmo exemplo com codificação de URL.

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

Combinar 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/beta/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/beta/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/beta/me/messages?$filter=Importance%20eq%20%27High%27&select=Subject,Sender,ReceivedDateTime&$top=5

https://outlook.office.com/api/beta/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 AD do Azure para que ele possa acessar as APIs do Office 365
• Referência da API REST do email 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