Referencia de recursos para las API de REST de correo, calendario, contactos y tareas (versión 1.0)

** Se aplica a** : Exchange Online | Office 365 | Hotmail.com | Live.com | MSN.com | Outlook.com | Passport.com

Este artículo describe las entidades de la API de REST, las propiedades, los tipos complejos, las enumeraciones y los parámetros de consulta de OData que puede usar con la API de Outlook de Correo, Calendario, Contactosy Tarea, para acceder a los datos del buzón de usuario en Office 365, Hotmail.com, Live.com, MSN.com, Outlook.com y Passport.com.

Consulte Utilizar la API REST de Outlook para obtener más información común a todos los subconjuntos de la API REST de Outlook.

¿No está interesado en la versión 1.0 de la API? En la tabla de contenido de la izquierda, vaya a la sección Referencia de la API de REST de Office 365 y seleccione la versión que desee.

Datos adjuntos

Un archivo o elemento (contacto, evento o mensaje) adjunto a un evento o mensaje. Los
recursos fileAttachment y itemAttachment correspondientes se derivan del recurso Attachment.

Tipo: Microsoft.OutlookServices.Entity

Propiedad	Tipo	Descripción	¿Se puede escribir?	¿Se puede filtrar?
Tipo de contenido	Cadena	El tipo MIME del archivo adjunto.	Sí	No
IsInline	Booleano	true si los datos adjuntos son datos adjuntos en línea; de lo contrario, false.	Sí	Sí
LastModifiedDateTime	DateTimeOffset	La fecha y hora de la última modificación de los datos adjuntos. La fecha y la hora utilizan el formato ISO 8601 y siempre están en hora UTC. Por ejemplo, la UTC de la medianoche del 1 de enero de 2014 se vería así: '2014-01-01T00: 00: 00Z'	No	Sí
Nombre	Cadena	Nombre para mostrar de los datos adjuntos. Esto no tiene por qué ser el nombre real del archivo.	Sí	Sí
Tamaño	Int32	La longitud en bytes de los datos adjuntos.	No	No

Calendario

Un calendario que es un contenedor de eventos.

Tipo: Microsoft.OutlookServices.Calendar

Una colección de Calendario devuelve una matriz de calendarios en la propiedad value de la respuesta OData. Utilice $count para obtener el recuento de entidades en la colección: .../me/calendars/$count

Consulte Operaciones Calendar para ver las acciones admitidas.

Propiedad	Tipo	Descripción	¿Se puede escribir?	¿Se puede filtrar?
Nombre	Cadena	El nombre del calendario.	Sí	Sí
ChangeKey	Cadena	Identifica la versión del objeto de calendario. Cada vez que se cambia el calendario, ChangeKey cambia también. Esto permite que Exchange aplique cambios a la versión correcta del objeto.	No	No
Color	CalendarColor	Especifica el tema de color para distinguir el calendario de otros calendarios en una interfaz de usuario. Los valores de propiedad son: LightBlue=0, LightGreen=1, LightOrange=2, LightGray=3, LightYellow=4, LightTeal=5, LightPink=6, LightBrown=7, LightRed=8, MaxColor=9, Auto=-1	Sí	Sí
Id	Cadena	El identificador exclusivo del calendario.	No	No
CalendarView	Colección(Event)	La vista calendario del calendario. Propiedad de navegación.	No	No
Eventos	Colección(Event)	Los eventos en el calendario. Propiedad de navegación.	No	No

CalendarGroup

Un grupo de calendarios.

Tipo: Microsoft.OutlookServices.CalendarGroup

Una colección CalendarGroup devuelve una matriz de grupos de calendario en la propiedad value de la respuesta OData. Utilice $count para obtener el recuento de entidades en la colección: .../me/calendargroups/$count

Consulte Operaciones CalendarGroup para ver las acciones admitidas.

Propiedad	Tipo	Descripción	¿Se puede escribir?	¿Se puede filtrar?
Nombre	Cadena	Nombre del grupo.	Sí	Sí
ChangeKey	Cadena	Identifica la versión del grupo de calendarios. Cada vez que se cambia el grupo de calendarios, ChangeKey cambia también. Esto permite que Exchange aplique cambios a la versión correcta del objeto.	No	No
ClassId	Cadena	El identificador de clase.	No	Sí
Id	Cadena	El identificador exclusivo del grupo de calendarios.	No	No
Calendarios	Colección(Calendar)	Los calendarios en el grupo de calendarios. Propiedad de navegación.	No	No

Contacto

Un contacto, que es un elemento en Outlook para que los usuarios organicen y guarden información sobre las personas y organizaciones con las que se comunican. Los contactos están contenidos en las carpetas de contactos.

Tipo: Microsoft.OutlookServices.Contact

Una colección Contact devuelve una matriz de contactos en la propiedad value de la respuesta OData. Utilice $count para obtener el recuento de entidades en la colección: .../me/contacts/$count

Consulte Operaciones Contact para ver las acciones admitidas.

Propiedad	Tipo	Descripción	¿Se puede escribir?	¿Se puede filtrar?
AssistantName	Cadena	El nombre del ayudante del contacto.	Sí	Sí
Birthday	datetimeoffset	El cumpleaños del contacto.	Sí	Sí
BusinessAddress	PhysicalAddress	La dirección del trabajo del contacto.	Sí	Sí
BusinessHomePage	Cadena	La página principal de la empresa del contacto.	Sí	Sí
BusinessPhones	Colección(String)	Los números de teléfono del trabajo del contacto.	Sí	No
Categories	Colección(String)	Las categorías asociadas con el contacto.	Sí	No
ChangeKey	Cadena	Identifica la versión del contacto. Cada vez que se cambia el contacto, ChangeKey cambia también. Esto permite que Exchange aplique cambios a la versión correcta del objeto.	No	No
Children	Colección(String)	Los nombres de los hijos del contacto.	Sí	Sí
CompanyName	Cadena	El nombre de la empresa del contacto.	Sí	Sí
Department	Cadena	El departamento del contacto.	Sí	Sí
DateTimeCreated	datetimeoffset	La hora en que se creó el contacto.	No	Sí
DateTimeLastModified	datetimeoffset	La hora en que se modificó el contacto.	No	Sí
Nombre para mostrar	Cadena	El nombre para mostrar del contacto.	Sí	Sí
EmailAddresses	Colección(EmailAddress)	Las direcciones de correo electrónico del contacto.	Sí	No
FileAs	Cadena	El nombre con el que se ha archivado el contacto.	Sí	Sí
Generation	Cadena	La generación del contacto.	Sí	Sí
GivenName	Cadena	El nombre del contacto.	Sí	Sí
HomeAddress	PhysicalAddress	La dirección particular del contacto.	Sí	Sí
HomePhones	Colección(String)	Los números de teléfono particular del contacto.	Sí	No
Id	Cadena	El identificador exclusivo del contacto.	No	No
ImAddresses	Colección(String)	Las direcciones de mensajería instantánea (MI) del contacto.	Sí	No
Initials	Cadena	Las iniciales del contacto.	Sí	Sí
JobTitle	Cadena	El puesto del contacto.	Sí	Sí
Manager	Cadena	El nombre del administrador del contacto.	Sí	Sí
MiddleName	Cadena	El segundo nombre del contacto.	Sí	Sí
MobilePhone1	Cadena	El número de teléfono móvil del contacto.	Sí	Sí
NickName	Cadena	El sobrenombre del contacto.	Sí	Sí
OfficeLocation	Cadena	La ubicación de la oficina del contacto.	Sí	Sí
OtherAddress	PhysicalAddress	Otras direcciones del contacto.	Sí	Sí
ParentFolderId	Cadena	El identificador de la carpeta principal del contacto.	No	No
PersonalNotes	Cadena	Las notas del usuario sobre el contacto.	Sí	Sí
Profession	Cadena	La profesión del contacto.	Sí	Sí
SpouseName	Cadena	El nombre del cónyuge del contacto.	Sí	Sí
Surname	Cadena	Los apellidos del contacto.	Sí	Sí
Título	Cadena	El título del contacto.	Sí	No
YomiCompanyName	Cadena	El nombre fonético japonés de la empresa del contacto. Esta propiedad es opcional.	Sí	No
YomiGivenName	Cadena	El nombre (nombre de pila) fonético japonés del contacto. Esta propiedad es opcional.	Sí	No
YomiSurname	Cadena	El apellido fonético japonés del contacto. Esta propiedad es opcional.	Sí	No

ContactFolder

Una carpeta que contiene contactos.

Tipo: Microsoft.OutlookServices.ContactFolder

Una colección ContactFolder devuelve una matriz de carpetas de contactos en la propiedad value de la respuesta OData. Utilice $count para obtener el recuento de entidades en la colección: .../me/contactfolders/$count

Consulte Operaciones ContactFolder para ver las acciones admitidas.

Propiedad	Tipo	Descripción	¿Se puede escribir?	¿Se puede filtrar?
ChildFolders	Colección(ContactFolder)	La colección de carpetas secundarias en la carpeta. Propiedad de navegación.	No	No
Contactos	Colección(Contact)	Los contactos en la carpeta. Propiedad de navegación.	No	No
Nombre para mostrar	Cadena	El nombre para mostrar de la carpeta.	Sí	Sí
Id	Cadena	Identificador exclusivo de la carpeta de contactos.	No	No
ParentFolderId	Cadena	El identificador de la carpeta principal de la carpeta.	No	No

Evento

Un evento de un calendario.

Tipo: Microsoft.OutlookServices.Event

Una colección Event devuelve una matriz de eventos en la propiedad value de la respuesta OData. Utilice $count para obtener el recuento de entidades en la colección: .../me/events/$count

Consulte Operaciones Event para ver las acciones admitidas.

Propiedad	Tipo	Descripción	¿Se puede escribir?	¿Se puede filtrar?
Datos adjuntos	Colección(Attachment)	La colección de datos adjuntos FileAttachment y ItemAttachment para el evento. Propiedad de navegación.	No	No
Attendees	Colección(Attendee)	La colección de asistentes del evento.	Sí	No
Cuerpo	ItemBody	El cuerpo del mensaje asociado con el evento.	Sí	No
BodyPreview	Cadena	La vista previa del mensaje asociado al evento.	No	No
Calendario	Calendario	El calendario que contiene el evento. Propiedad de navegación.	No	No
Categories	Colección(String)	Las categorías asociadas con el evento.	Sí	No
ChangeKey	Cadena	Identifica la versión del objeto de evento. Cada vez que cambia el evento, cambia también ChangeKey. Esto permite que Exchange aplique los cambios a la versión correcta del objeto.	No	No
DateTimeCreated	datetimeoffset	La fecha y hora en que se creó el evento.	No	Sí
DateTimeLastModified	datetimeoffset	La fecha y hora en que el evento fue modificado por última vez.	No	Sí
End	datetimeoffset	La fecha y hora en que finaliza el evento. De manera predeterminada, la hora de finalización está en formato UTC. Puede especificar una zona horaria opcional en EndTimeZone, expresar la hora de finalización en esa zona horaria e incluir una diferencia horaria de UTC. Tenga en cuenta que, si usa EndTimeZone, debe especificar también un valor para StartTimeZone. En este ejemplo, se especifica el 25 de febrero de 2015, a las 9:34 p. m. en hora estándar del Pacífico: "2015-02-25T21:34:00-08:00".	Sí	Sí
EndTimeZone	Cadena	Identifica la zona horaria de la reunión para la hora de finalización de la reunión (ver la propiedad End). Esta propiedad se establece con el nombre de la zona horaria tal como está almacenada en Windows. Puede obtener los nombres de zona horaria llamando a System.TimeZoneInfo.GetSystemTimeZones(). Esta propiedad es opcional para la versión 1.0. Sin embargo, esta propiedad se debe usar si se usa la propiedad StartTimeZone. Consulte TimeZone para más información.	Sí	No
HasAttachments	valor booleano	Se establece como true si el evento tiene datos adjuntos.	No	Sí
Id	Cadena	El identificador exclusivo del evento.	No	No
Importance	Importance	La importancia del evento: Low, Normal, High.	Sí	Sí
Instances	Colección(Event)	Las instancias del evento. Propiedad de navegación.	No	No
iCalUID	Cadena	Un identificador único que comparten todas las instancias de un evento a través de calendarios diferentes.	No	Sí
IsAllDay	valor booleano	Se establece en true si el evento dura todo el día. Ajustar esta propiedad requiere ajustar las propiedades Start y End del evento también.	Sí	Sí
IsCancelled	valor booleano	Se establece como true si el evento ha sido cancelado.	Sí	Sí
IsOrganizer	valor booleano	Se establece como true si el remitente del mensaje también es el organizador.	Sí	Sí
Location	Location	La ubicación del evento.	Sí	Sí
Organizer	Recipient	El organizador del evento.	Sí	Sí
Periodicidad	PatternedRecurrence	El patrón de periodicidad del evento.	Sí	No
ResponseRequested	valor booleano	Se establece en true si el remitente quiere una respuesta cuando el evento se acepta o rechaza.	Sí	Sí
ResponseStatus	ResponseStatus	Indica el tipo de respuesta que se envía en respuesta a un mensaje de evento.	No	Sí
Sensitivity	Sensitivity	Indica el nivel de privacidad del evento: Normal = 0, Personal = 1, Private = 2, Confidential = 3.	Sí	Sí
SeriesMasterId	Cadena	Las categorías asignadas al elemento.	Sí	No
ShowAs	FreeBusyStatus	El estado que se mostrará: libre = 0, provisional = 1, no disponible = 2, fuera de la oficina = 3, trabajando en otro lugar = 4, desconocido = -1.	Sí	Sí
Iniciar	datetimeoffset	La hora de inicio del evento. De manera predeterminada, la hora de inicio está en formato UTC. Puede especificar una zona horaria opcional en StartTimeZone, expresar la hora de inicio en esa zona horaria e incluir una diferencia horaria de UTC. Tenga en cuenta que, si usa StartTimeZone, debe especificar también un valor para EndTimeZone. En este ejemplo, se especifica el 25 de febrero de 2015, a las 7:34 p. m. en hora estándar del Pacífico: "2015-02-25T19:34:00-08:00".	Sí	Sí
StartTimeZone	Cadena	Identifica la zona horaria de la reunión para la hora de inicio de la reunión (vea la propiedad Start). Esta propiedad hace que el servicio gestione los cambios de zona horaria en lugar del cliente. Esta propiedad se establece con el nombre de la zona horaria tal como está almacenada en Windows. Puede obtener los nombres de zona horaria llamando a System.TimeZoneInfo.GetSystemTimeZones(). Esta propiedad es opcional para la versión 1.0. Sin embargo, esta propiedad se debe usar si se usa la propiedad EndTimeZone. Un valor de ejemplo para esta propiedad es "Hora estándar del Pacífico". Consulte TimeZone para más información.	Sí	No
Subject	Cadena	Texto de la línea de asunto del evento.	Sí	Sí
Tipo	EventType	El tipo de evento: SingleInstance = 0, Occurrence = 1, Exception = 2, SeriesMaster = 3.	Sí	Sí
WebLink	Cadena	La dirección URL para abrir el evento en Outlook Web App. El evento se abrirá en el navegador si está conectado a su buzón mediante Outlook Web App. Se le pedirá que inicie sesión si no la ha iniciado ya en el navegador. Se puede acceder a esta dirección URL desde un iFrame.	No	No

EventMessage

Un mensaje que representa una solicitud de reunión, un mensaje de cancelación de reunión, un mensaje de aceptación de reunión, un mensaje de aceptación provisional de reunión o un mensaje de rechazo de reunión.

Tipo base: Message

Una instancia de EventMessage, por lo general, se encuentra en la carpeta Bandeja de entrada, donde llega como resultado de un organizador de eventos que crea una reunión o de un asistente que responde a una convocatoria de reunión. Actúa en los mensajes de eventos de la misma manera que actúa en Message, con algunas diferencias menores que se describen en la siguiente tabla.

Acción/verbo	Permiso	Descripción
Crear un mensaje de evento (POST)	N/A	No autorizado. Dará como resultado un código de respuesta 400.
Actualizar un mensaje de evento (PATCH)	Mail.Write	Puede actualizar las propiedades From, Sender, ToRecipients, CcRecipients, BccRecipients, ReplyTo, IsDeliveryReceiptRequested, IsReadReceiptRequested, IsDraft, IsRead, Subject, Body, Importance y Categories.
Eliminar un mensaje de evento (DELETE)	Mail.Write	La misma acción que para un Message.
Mover un mensaje de evento (POST)	Mail.Write	La misma acción que para un Message.
Copiar un mensaje de evento (POST)	Mail.Write	La misma acción que para un Message.
Crear borrador de mensaje de respuesta (POST)	Mail.Write	La misma acción que para un Message.
Crear borrador de responder a todos los mensajes (POST)	Mail.Write	La misma acción que para un Message.
Crear una respuesta (POST)	Mail.Write	La misma acción que para un Message.
Crear una respuesta a todos (POST)	Mail.Write	La misma acción que para un Message.
Enviar un mensaje de evento existente (POST)	Mail.Write	Solo puede enviar un mensaje de evento donde la propiedad IsDraft tenga un valor de verdadero. A continuación, el mensaje se guarda en la carpeta Elementos enviados.
Crear un mensaje de evento de reenvío de borrador	Mail.Write	La misma acción que para un Message.
Reenviar un mensaje de evento	Mail.Write	La misma acción que para un Message.

Una instancia EventMessage incluye propiedades del tipo base Message y las propiedades en la siguiente tabla.

Propiedad	Tipo	Descripción	¿Se puede escribir?	¿Se puede filtrar?
Evento	Evento	El evento asociado con el mensaje del evento. La suposición para los asistentes o los recursos de la sala es que el Operador de calendario está configurado para actualizar automáticamente el calendario con un evento cuando llegan los mensajes de evento de solicitud de reunión. Propiedad de navegación.	No	No
MeetingMessageType	MeetingMessageType	El tipo de mensaje de evento: None = 0, MeetingRequest = 1, MeetingCancelled = 2, MeetingAccepted = 3, MeetingTentativelyAccepted = 4, MeetingDeclined = 5	No	Sí

EventMessageRequest (versión preliminar)

Esta característica está actualmente disponible en beta. En el índice de la izquierda, vaya a la sección Referencia de la API de REST de Office 365 y seleccione beta.

Propiedades extendidas

Actualmente, esta característica está disponible en la versión beta y 2.0. En el índice de la izquierda, vaya a la sección Referencia de la API de REST de Office 365 y seleccione la versión que desee.

FileAttachment

Un archivo (como un archivo de texto o un documento de Word) adjunto a un mensaje o evento. La propiedad ContentBytes contiene el contenido codificado en base64 del archivo. Derivada de la entidad Attachment.

Tipo: Microsoft.OutlookServices.FileAttachment

Tipo base: Microsoft.OutlookServices.Attachment

Propiedad	Tipo	Descripción	¿Se puede escribir?
ContentBytes	binario	El contenido binario del archivo.	No
ContentId	Cadena	El identificador de los datos de adjuntos del almacén de Exchange.	No
ContentLocation	Cadena	El identificador uniforme de recursos (URI) que corresponde a la ubicación del contenido de los datos adjuntos.	No
Tipo de contenido	Cadena	El tipo de contenido de los datos adjuntos.	Sí
DateTimeLastModified	datetimeoffset	La fecha y hora de la última modificación de los datos adjuntos.	No
Id	Cadena	El identificador de los datos adjuntos.	No
IsContactPhoto	valor booleano	Obsoleta	Sí
IsInline	valor booleano	Se establece en true si se trata de datos adjuntos en línea.	Sí
Nombre	Cadena	El nombre que representa el texto que aparece debajo del icono que representa el archivo adjunto insertado. No tiene que ser el nombre de archivo real.	Sí
Tamaño	Int32	El tamaño en bytes de los datos adjuntos.	No

Folder / MailFolder

Una carpeta en el buzón de un usuario, como Bandeja de entrada, Borradores y Elementos enviados. Las carpetas pueden contener mensajes y otras carpetas.

Tipo: Microsoft.OutlookServices.Folder

Una colección MailFolder devuelve una matriz de carpetas de contactos en la propiedad value de la respuesta OData. Utilice $count para obtener el recuento de entidades en la colección: .../me/folders/$count

Consulte Operaciones Folder para ver las acciones admitidas.

Propiedad	Tipo	Descripción	¿Se puede escribir?	¿Se puede filtrar?
ChildFolderCount	Int32	La cantidad de carpetas en la carpeta.	No	Sí
ChildFolders	Colección(Folder)	La colección de carpetas secundarias en la carpeta. Propiedad de navegación.	No	No
Nombre para mostrar	Cadena	El nombre para mostrar de la carpeta.	Sí	Sí
Id	Cadena	El identificador exclusivo de la carpeta. Puede usar los siguientes nombres conocidos para acceder a la carpeta correspondiente: Inbox, Drafts, SentItems, DeletedItems.	No	No
Mensajes	Colección(Message)	La colección de mensajes en la carpeta. Propiedad de navegación.	No	No
ParentFolderId	Cadena	El identificador exclusivo para la carpeta primaria de la carpeta.	No	No
TotalItemCount	Int32	La cantidad de elementos en la carpeta.	No	Sí
UnreadItemCount	Int32	El número de elementos en la carpeta marcados como no leídos.	No	Sí

Acceder a recuentos de elementos de forma eficaz

Las propiedades TotalItemCount y UnreadItemCount de una carpeta le permiten calcular convenientemente el número de elementos leídos en la carpeta. Le permiten evitar consultas como las siguientes que pueden incurrir en una latencia significativa:

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

Las carpetas en Outlook pueden contener más de un tipo de elementos, por ejemplo, la Bandeja de entrada puede contener elementos de solicitud de reunión que son distintos de los elementos de correo. TotalItemCount y UnreadItemCount incluyen elementos en una carpeta independientemente de sus tipos de elementos.

InferenceClassification

Esta característica está actualmente disponible en v2.0 y beta. Para obtener más información, en el índice de la izquierda, vaya a la sección de Referencia de la API de REST de Office 365 y seleccione una de estas versiones.

InferenceClassificationOverride

Esta característica está actualmente disponible en v2.0 y beta. Para obtener más información, en el índice de la izquierda, vaya a la sección de Referencia de la API de REST de Office 365 y seleccione una de estas versiones.

ItemAttachment

Un mensaje, contacto o evento adjunto a otro mensaje o evento. Derivada de la entidad Attachment.

Tipo: Microsoft.OutlookServices.ItemAttachment

Tipo base: Microsoft.OutlookServices.Attachment

Propiedad	Tipo	Descripción	¿Se puede escribir?
Tipo de contenido	Cadena	El tipo de contenido de los datos adjuntos.	Sí
DateTimeLastModified	datetimeoffset	Última fecha y hora en que se modificaron los datos adjuntos.	No
Id	Cadena	El identificador de los datos adjuntos.	No
Item	Item	Evento o mensaje adjunto. Propiedad de navegación.	Sí
IsInline	valor booleano	Se establece en true si los datos adjuntos están insertados, como una imagen incrustada en el cuerpo del elemento.	Sí
Nombre	Cadena	Nombre para mostrar de los datos adjuntos.	Sí
Tamaño	Int32	El tamaño en bytes de los datos adjuntos.	Sí

Mention (versión preliminar)

Actualmente, esta característica solo está disponible en la versión beta. En el índice de la izquierda, vaya a la sección Referencia de la API de REST de Office 365 y seleccione beta.

Message

Un mensaje en una carpeta de buzón.

Tipo: Microsoft.OutlookServices.Message

Una colección Message devuelve una matriz de mensajes en la propiedad value de la respuesta OData. Utilice $count para obtener el recuento de entidades en la colección: .../me/messages/$count

Consulte Operaciones Message para ver las acciones admitidas.

Propiedad	Tipo	Descripción	¿Se puede escribir?	¿Se puede filtrar?	¿Permite búsquedas?
Datos adjuntos	Colección(Attachment)	Los datos adjuntos fileAttachment y itemAttachment del mensaje. Propiedad de navegación.	Sí	No	Sí
BccRecipients	Collección(Recipient)	Los destinatarios Cco del mensaje.	Sí	No	Sí
Body	ItemBody	El cuerpo del mensaje.	Sí	No	Predeterminado
BodyPreview	Cadena	Los primeros 255 caracteres del contenido del cuerpo del mensaje.	No	No	Sí
Categories	Colección (cadena)	Categorías asociadas al mensaje.	Sí	Sí	Sí
CcRecipients	Collección(Recipient)	Los destinatarios Cc del mensaje.	Sí	No	Sí
ChangeKey	Cadena	La versión del mensaje.	No	No	No
ConversationId	Cadena	El identificador de la conversación a la que pertenece el correo electrónico.	No	Sí	No
DateTimeCreated	datetimeoffset	La fecha y la hora de creación del mensaje.	No	Sí	No
DateTimeLastModified	datetimeoffset	La fecha y la hora de la última modificación del mensaje.	No	Sí	No
DateTimeReceived	datetimeoffset	La fecha y la hora en las que se recibió el mensaje.	No	Sí	Sí
DateTimeSent	datetimeoffset	La fecha y la hora de envío del mensaje.	No	Sí	No
From	Recipient	El propietario del buzón y el remitente del mensaje.	Sí	Sí	Sí
HasAttachments	valor booleano	Indica si el mensaje tiene datos adjuntos.	Sí	Sí	Sí
Id	Cadena	El identificador exclusivo del mensaje.	No	No	No
Importance	Importance	La importancia del mensaje: Baja = 0, Normal = 1, Alta = 2. L	Sí	Sí	Sí
IsDeliveryReceiptRequested	valor booleano	Indica si se solicita confirmación de lectura para el mensaje.	Sí	Sí	No
IsDraft	valor booleano	Indica si el mensaje es un borrador. Un mensaje es un borrador si no se ha enviado todavía.	No	Sí	No
IsRead	valor booleano	Indica si se ha leído el mensaje.	Sí	Sí	No
IsReadReceiptRequested	valor booleano	Indica si se solicita confirmación de lectura para el mensaje.	Sí	Sí	No
ParentFolderId	Cadena	El identificador exclusivo para la carpeta primaria del mensaje.	No	No	No
ReplyTo	Collección(Recipient)	Las direcciones de correo electrónico que se utilizan al responder.	Sí	No	No
Sender	Recipient	La cuenta que se utiliza realmente para generar el mensaje.	Sí	Sí	Predeterminado
Subject	Cadena	El asunto del mensaje.	Sí	Sí	Predeterminado
ToRecipients	Collección(Recipient)	Los destinatarios Para del mensaje.	Sí	No	Sí
UniqueBody	ItemBody	El cuerpo del mensaje que es exclusivo de la conversación.	No	No	No
WebLink	Cadena	La dirección URL para abrir el mensaje en Outlook Web App. Puede anexar un argumento ispopout al final de la dirección URL para cambiar cómo se muestra el mensaje. Si ispopout no está presente o se establece en 1, se muestra el mensaje en una ventana emergente. Si ispopout se establece en 0, el navegador mostrará el mensaje en el panel de revisión de Outlook Web App. El mensaje se abrirá en el navegador si está conectado a su buzón mediante Outlook Web App. Se le pedirá que inicie sesión si no la ha iniciado ya en el navegador. Se puede acceder a esta dirección URL desde un iFrame.	No	Sí	No

Quitar un script de la propiedad Body

El cuerpo del mensaje puede ser HTML o texto. Si el cuerpo es HTML, de forma predeterminada, cualquier HTML potencialmente inseguro (por ejemplo, JavaScript) insertado en la propiedad Body se eliminaría antes de que se devolviera el contenido del cuerpo en una respuesta REST.

Para obtener todo el contenido HTML original, incluya el siguiente encabezado de solicitud HTTP:

Prefer: outlook.allow-unsafe-html

Configuración de las propiedades From y Sender

Cuando se redacta un mensaje, en la mayoría de los casos, las propiedades From y Sender representan al mismo usuario que inició sesión, a menos que alguno esté actualizado como se describe en los siguientes escenarios:

• La propiedad From se puede cambiar si el administrador de Exchange ha asignado los derechos SendAs del buzón a otros usuarios. El administrador puede hacer esto seleccionando Permisos de buzón del propietario del buzón en el Portal de administración de Azure, o al usar el Centro de administración de Exchange o un cmdlet Add-ADPermission de Windows PowerShell. Luego, puede establecer mediante programación la propiedad From a uno de estos usuarios que tienen derechos SendAs para ese buzón.

• La propiedad Sender se puede cambiar si el propietario del buzón ha delegado uno o más usuarios para que puedan enviar mensajes desde ese buzón. El propietario del buzón puede delegar en Outlook. Cuando un delegado envía un mensaje en nombre del propietario del buzón, se establece la propiedad Sender en la cuenta del delegado y la propiedad From sigue siendo el propietario del buzón. Mediante programación, puede configurar la propiedad Sender para un usuario que tiene derecho de delegado en ese buzón.

MessageRule (versión preliminar)

Esta característica está actualmente disponible en beta. En el índice de la izquierda, vaya a la sección Referencia de la API de REST de Office 365 y seleccione beta.

OutlookCategory (versión preliminar)

Esta característica está actualmente disponible en beta. En el índice de la izquierda, vaya a la sección Referencia de la API de REST de Office 365 y seleccione beta.

Photo

Esta característica está actualmente disponible en v2.0 y beta. Para obtener más información, en el índice de la izquierda, vaya a la sección de Referencia de la API de REST de Office 365 y seleccione una de estas versiones.

ReferenceAttachment

Esta característica está actualmente disponible en beta. En el índice de la izquierda, vaya a la sección Referencia de la API de REST de Office 365 y seleccione beta.

Tarea

Actualmente, esta característica está disponible en la versión beta y 2.0. Para obtener más información, en el índice de la izquierda, vaya a la sección de Referencia de la API de REST de Office 365 y seleccione una de estas versiones.

Carpeta de tareas

Actualmente, esta característica está disponible en la versión beta y 2.0. Para obtener más información, en el índice de la izquierda, vaya a la sección de Referencia de la API de REST de Office 365 y seleccione una de estas versiones.

TaskGroup

Actualmente, esta característica está disponible en la versión beta y 2.0. Para obtener más información, en el índice de la izquierda, vaya a la sección de Referencia de la API de REST de Office 365 y seleccione una de estas versiones.

Usuario

Usuario del sistema. El extremo Me se proporciona como acceso directo para especificar el usuario actual por dirección SMTP ( users/sadie@contoso.com).

Tipo: Microsoft.OutlookServices.User

Una colección Users devuelve una matriz de usuarios en la propiedad value de la respuesta OData. Utilice $count para obtener el recuento de entidades en la colección: .../me/users/$count

Propiedad	Tipo	Descripción	¿Se puede escribir?	¿Se puede filtrar?
Alias	Cadena	El alias del usuario. Por lo general, la dirección SMTP del usuario.	Sí	Sí
Calendario	Calendario	El calendario principal del usuario. Propiedad de navegación.	No	No
CalendarGroups	Colección(CalendarGroup)	Los grupos de calendarios del usuario. Propiedad de navegación.	No	No
Calendarios	Colección(Calendar)	Los calendarios del usuario. Propiedad de navegación.	No	No
CalendarView	Colección(Event)	La vista calendario del calendario. Propiedad de navegación.	No	No
ContactFolders	Colección(ContactFolder)	Las carpetas de contactos del usuario. Propiedad de navegación.	No	No
Contactos	Colección(Contact)	Los contactos del usuario. Propiedad de navegación.	No	No
Nombre para mostrar	Cadena	El nombre para mostrar del usuario.	Sí	Sí
Eventos	Colección(Event)	Los eventos del usuario. El valor predeterminado es mostrar los eventos en el calendario predeterminado. Propiedad de navegación.	No	No
Carpetas	Colección(Folder)	Las carpetas en un buzón o carpeta. Propiedad de navegación.	No	No
Id	Cadena	El identificador único del usuario.	No	No
MailboxGuid	guid	El GUID asignado al buzón del usuario.	No	Sí
Mensajes	Colección(Message)	Los mensajes en un buzón o carpeta. Propiedad de navegación.	No	No
RootFolder	Folder	La carpeta raíz del buzón del usuario. Propiedad de navegación.	No	No

Tipos complejos

• Attendee
• EmailAddress
• GeoCoordinates
• ItemBody
• Location
• PatternedRecurrence
• PhysicalAddress
• Recipient
• RecurrencePattern
• RecurrenceRange
• ResponseStatus

Attendee

Asistente a un evento.

Tipo: Microsoft.OutlookServices.Recipient

Propiedad	Tipo	Descripción
Estado	ResponseStatus	La respuesta (ninguna, aceptada, rechazada, etc.) y el tiempo.
Tipo	AttendeeType	El tipo de asistente: Required, Optional, Resource.

EmailAddress

Nombre y dirección de correo de un contacto o destinatario del mensaje.

Tipo: Microsoft.OutlookServices.EmailAddress

Propiedad	Tipo	Descripción
Nombre	Cadena	Nombre para mostrar de la persona o entidad.
Dirección	Cadena	Dirección de correo de la persona o entidad.

GeoCoordinates

Coordenadas geográficas y elevación de la ubicación.

Tipo: Microsoft.OutlookServices.GeoCoordinates

Propiedad	Tipo	Descripción
Altitude	doble	Altitud de la ubicación.
Latitude	doble	Latitud de la ubicación.
Longitude	doble	Longitud de la ubicación.
Accuracy	doble	La precisión del sensor que proporciona la latitud y la longitud.
AltitudeAccuracy	doble	La precisión del sensor que proporciona la altitud.

ItemBody

El contenido del cuerpo de un mensaje o evento.

Tipo: Microsoft.OutlookServices.ItemBody

Propiedad	Tipo	Descripción
Tipo de contenido	BodyType	El tipo de contenido: Texto = 0, HTML = 1.
Contenido	Cadena	El contenido de texto o HTML.

Location

La ubicación de un evento.

Tipo: Microsoft.OutlookServices.Location

Propiedad	Tipo	Descripción
Nombre para mostrar	Cadena	Nombre asociado a la ubicación.
Dirección	PhysicalAddress	La dirección física de la ubicación.
Coordenadas	GeoCoordinates	Coordenadas geográficas y elevación de la ubicación.

PatternedRecurrence

Patrón e intervalo de periodicidad.

Tipo: Microsoft.OutlookServices.PatternedRecurrence

Propiedad	Tipo	Descripción
Patrón	RecurrencePattern	Frecuencia de un evento.
Range	RecurrenceRange	Duración de un evento.

PhysicalAddress

La dirección física de un contacto.

Tipo: Microsoft.OutlookServices.PhysicalAddress

Propiedad	Tipo	Descripción
Street	Cadena	Calle.
City	Cadena	Ciudad.
Estado	Cadena	Estado.
CountryOrRegion	Cadena	País o región. Se trata de un valor de cadena de formato libre, por ejemplo, "Estados Unidos".
PostalCode	Cadena	Código postal.

Recipient

Representa información sobre un usuario en la finalización del envío o la recepción de un evento o un mensaje.

Tipo: Microsoft.OutlookServices.Recipient

Propiedad	Tipo	Descripción
EmailAddress	EmailAddress	Dirección de correo del destinatario.

RecurrencePattern

Frecuencia de un evento.

Tipo: Microsoft.OutlookServices.RecurrencePattern

Propiedad	Tipo	Descripción
Tipo	RecurrencePatternType	El tipo de patrón de periodicidad: Daily = 0, Weekly = 1, AbsoluteMonthly = 2, RelativeMonthly = 3, AbsoluteYearly = 4, RelativeYearly = 5. Reglas de patrones: - AbsoluteYearly. Debe establecer el Month y DayOfMonth de la ocurrencia - RelativeYearly. Debe establecer el índice Month, DaysOfWeeky FirstDayOfWeek - AbsoluteMonthly. Debe establecer el DayOfMonth - RelativeMonthly. Debe establecer el índice FirstDayOfWeek índice y el RecurrenceRange.NumberOfOccurrences - Weekly. Debe establecer el DaysOfWeek y el FirstDayOfWeek - Daily. No se necesita información adicional del patrón.
Interval	Int32	Número de unidades de un tipo de periodicidad determinado entre repeticiones.
DayOfMonth	Int32	El día del mes en que ocurre el elemento.
Month	Int32	El mes en que ocurre el elemento. Se trata de un número entre 1 y 12.
DaysOfWeek	Colección(DayOfWeek)	Una colección de días de la semana: domingo = 0, lunes = 1, martes = 2, miércoles = 3, jueves = 4, viernes = 5, sábado = 6.
FirstDayOfWeek	DayOfWeek	El día de la semana: domingo = 0, lunes = 1, martes = 2, miércoles = 3, jueves = 4, viernes = 5, sábado = 6.
Índice	WeekIndex	El índice de la semana: Primero = 0, Segundo = 1, Tercero = 2, Cuarto = 3, Último = 4.

RecurrenceRange

Duración de un evento.

Tipo: Microsoft.OutlookServices.RecurrenceRange

Propiedad	Tipo	Descripción
Tipo	RecurrenceRangeType	El rango de periodicidad: EndDate = 0, NoEnd = 1, Numbered = 2.
StartDate	datetimeoffset	Requerido: la fecha de inicio de la serie.
EndDate	datetimeoffset	Requerido para los patrones de fecha límite: la fecha de finalización de la serie. Debe ser posterior a la fecha de inicio.
NumberOfOccurrences	Int32	Requerido para patrones Numbered: cuántas veces repetir el evento.

ResponseStatus

Estado de la respuesta de una convocatoria de reunión.

Tipo: Microsoft.OutlookServices.ResponseStatus

Propiedad	Tipo	Descripción
Respuesta	ResponseType	El tipo de respuesta: None, Organizer, TentativelyAccepted, Accepted, Declined, NotResponded.
Hora	datetimeoffset	Fecha y hora en que se devolvió la respuesta.

Enumeraciones

DayOfWeek

El conjunto de días de la semana.

Valores admitidos:

• Domingo
• Lunes
• Martes
• Miércoles
• Jueves
• Viernes
• Sábado

FreeBusyStatus

Especifica el estado de disponibilidad de un asistente a una reunión.

Valores admitidos:

• Ocupado
• Libre
• Oof
• Tentative (provisional)
• Desconocido
• WorkingElsewhere (trabajando en otro lugar)

ReferenceAttachmentPermissions

Permisos de acceso para el archivo o la carpeta de la referencia adjunta.

Valores admitidos:

• Otro
• Vista
• Edit (editar)
• AnonymousView (ver anónimo)
• AnonymousEdit (editar anónimo)
• OrganizationView (ver organización)
• OrganizationEdit (editar organización)

ReferenceAttachmentProviders

Posibles proveedores de almacenamiento de archivos para las referencias adjuntas.

Valores admitidos:

• Dropbox
• OneDriveBusiness
• OneDriveConsumer
• Otro

Sensitivity

Indica el nivel de privacidad.

Valores admitidos:

• Importance
• Personal
• Privado
• Confidencial

Parámetros de consulta de OData

Puede usar los parámetros de consulta estándar de OData versión 4.0 para filtrar solicitudes de datos y ordenar y paginar resultados cuando se trabaja con las API de correo, calendario y contactos. Al especificar los parámetros de consulta, asegúrese de que los caracteres que están reservados para significados especiales en un URI estén apropiadamente codificados.

• $search para buscar criterios específicos

• $filter para filtrar por criterios específicos

• $select para solicitar propiedades específicas

• $orderby para ordenar los resultados

• $top y $skip a los resultados de página

• $expand para expandir archivos adjuntos de mensajes y de eventos

• $count para obtener el recuento de entidades en una colección. Este parámetro va en la ruta URL: .../me/calendars/$count

Consultar con las API de correo, calendario y contactos siempre usa un ámbito poco profundo. Solo se devuelven los elementos dentro de la carpeta actual. Las búsquedas profundas no se admiten.

Solicitudes de búsqueda

Puede usar el parámetro $search para restringir los resultados de una solicitud a los mensajes que coincidan con una expresión de búsqueda. Las cadenas de búsqueda se expresan mediante la Sintaxis de consulta avanzada (AQS). Los resultados de la búsqueda se ordenan por la fecha y la hora en que se envió el mensaje.

No puede utilizar $filter o $orderby en una solicitud de búsqueda. Si lo hace, recibirá un mensaje de error como este.

    {
      "error":
      {
        "code":"ErrorInvalidUrlQuery",
        "message":"The query parameter 'OrderBy' is invalid."
      }
    }

Propiedad	Descripción
Datos adjuntos	Busca los datos adjuntos especificados por título.
CCO	Busca en el campo Bcc.
Body o Content	Busca en el campo Body. Solo compatible con búsquedas predeterminadas.
Category	Busca en el campo Category.
CC	Busca en el campo Cc.
From	Busca en el campo From.
Has	Busca en el campo HasAttachments.
Participantes	Busca en los campos To, Ccy Bcc.
Cantidad.Recibida	Busca en el campo Received una fecha específica expresada como MM/DD/AAAA.
Sender	Busca en el campo Sender.
Subject	Busca en el campo Subject.
To	Busca en el campo To.

Busque campos comunes utilizando el parámetro de consulta $search sin especificar una propiedad. Una búsqueda predeterminada buscará en las propiedades Body, Sendery Subject. La siguiente búsqueda devolverá todos los mensajes en la Bandeja de entrada que contengan "pizza" en cualquiera de las tres propiedades predeterminadas.

Veamos algunos ejemplos. Para facilitar su lectura, las URL en los ejemplos no tienen codificación URL; sin embargo, si prueba estos ejemplos asegúrese de codificarlos en la URL antes de enviarlos al servidor.

Para obtener todos los mensajes en la Bandeja de entrada que contengan la palabra "Pizza" en la propiedad From, Subject, o Body, puede usar esta solicitud.

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

Para obtener todos los mensajes en la Bandeja de entrada que contengan la palabra "Pizza" en la propiedad Subject, puede usar esta solicitud.

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

Para obtener todos los mensajes en la Bandeja de entrada que fueron enviados por una persona específica, puede usar esta solicitud.

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

Los ejemplos anteriores no incluyen la codificación de URL, aquí están los mismos ejemplos con codificación en la URL y listos para enviar a su servidor:

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

Solicitudes de filtrado

Puede usar el parámetro de consulta $filter para especificar criterios de búsqueda utilizando los siguientes operadores de filtrado.

No todas las propiedades admiten el filtrado. Solo las propiedades de recurso marcadas como "Sí" en la columna "¿Se puede filtrar?" en sus tablas correspondientes arriba se pueden usar. Si una propiedad no se puede filtrar, recibirá un mensaje de error en respuesta, como este que se devuelve si intenta filtrar en la propiedad ChangeKey:

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

Si utiliza un método de filtrado que no es compatible, recibirá un mensaje de error como este que se devuelve cuando el método de filtrado startswith se utiliza en la propiedad Subject:

    {
      "error":
      {
        "code":"ErrorInvalidUrlQueryFilter",
        "message":"'contains' and 'startswith' are not supported for filtering.  Use Search instead."
      }
    }

Operador	Tipo	Ejemplo
y	And lógico (utilizado para combinar múltiples criterios)	TotalCount gt 0 and ChildFolderCount eq 0
o bien	Or lógico (usado para combinar múltiples criterios)	TotalCount gt 0 or ChildFolderCount eq 0
eq	Igual a	IsRead eq false
ne	No igual a	Importance ne Microsoft.Exchange.Services.OData.Model.Importance'High'
gt	Mayor que	DateTimeReceived gt 2014-09-01T00:00:00Z
ge	Mayor o igual que	DateTimeLastModified ge 2014-09-01T00:00:00Z
lt	Menor que	DateTimeReceived lt 2014-09-01T00:00:00Z
le	Menor o igual que	DateTimeLastModified le 2014-09-01T00:00:00Z

Use comillas simples (') para delimitar cualquier valor de cadena en el criterio de filtrado. Utilice %27 para codificar en URL la comilla simple. The cadena en sí no distingue entre mayúsculas y minúsculas.

Veamos algunos ejemplos. Para facilitar su lectura, las URL en los ejemplos no tienen codificación URL; sin embargo, si prueba estos ejemplos asegúrese de codificarlos en la URL antes de enviarlos al servidor.

Para obtener todos los eventos en el calendario del usuario con un tema específico, puede filtrar en la propiedad Subject.

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

Para obtener todos los mensajes no leídos en la Bandeja de entrada, puede filtrar en la propiedad IsRead.

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

Para obtener todos los mensajes en la Bandeja de entrada con datos adjuntos, puede filtrar en la propiedad HasAttachments.

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

Para obtener todos los mensajes en la Bandeja de entrada recibidos desde el 1 de septiembre de 2014, puede filtrar en la propiedad ReceivedDateTime.

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

Para obtener todos los mensajes en la Bandeja de entrada enviados desde "hr@contoso.com", puede filtrar en la propiedad Sender.

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

Los ejemplos anteriores no incluyen la codificación de URL, aquí están los mismos ejemplos con codificación en la URL y listos para enviar a su servidor:

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

Seleccionar propiedades específicas para devolver

Puede usar el parámetro de consulta $select para especificar solo las propiedades que su aplicación necesita.

El siguiente ejemplo obtiene las propiedades Subject, Sendery DateTimeReceived para todos los mensajes en la Bandeja de entrada.

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

Ordenar resultados

Puede ordenar los resultados usando el parámetro de consulta $orderby. Establezca el valor de este parámetro en un nombre de propiedad y, opcionalmente, especifique el orden ascendente (predeterminado) o descendente. Recuerde, no puede usar el $orderbyparámetro de consulta con $search.

El siguiente ejemplo sin codificación de URL obtiene todos los mensajes en la Bandeja de entrada ordenados por la propiedad DateTimeReceived en orden descendente.

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

El mismo ejemplo con codificación de URL:

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

Paginar resultados

Por defecto, una solicitud GET en una propiedad Messages o ChildFolders, una colección o un CalendarView devuelve diez entradas (máximo 50). Puede cambiar este comportamiento utilizando el parámetro de consulta $top para establecer un número máximo. El siguiente ejemplo obtiene los primeros cinco mensajes en la Bandeja de entrada.

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

Si hay más de cinco mensajes en la Bandeja de entrada, la respuesta incluye una propiedad odata.nextLink. La presencia de esta propiedad indica que hay más elementos disponibles en el servidor. El valor de esta propiedad es un URI que se puede usar para obtener los siguientes cinco elementos.

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

La paginación se logra utilizando el parámetro $top para especificar un tamaño de página y el parámetro $skip como un múltiplo del tamaño de la página. Al incrementar el valor del parámetro $skip por el tamaño de página puede solicitar la página siguiente en el conjunto de resultados.

Contar entidades en una colección

Puede obtener el recuento de entidades en una colección utilizando el parámetro $count. También puede filtrar la solicitud de recuento.

Este ejemplo obtiene el recuento de mensajes en la Bandeja de entrada.

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

Y este ejemplo sin codificación URL obtiene el recuento de los mensajes no leídos en la bandeja de entrada.

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

El mismo ejemplo con codificación de URL.

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

Juntando las piezas

Puede combinar parámetros para crear consultas complejas. El siguiente ejemplo refina una consulta de los mensajes en la Bandeja de entrada de las siguientes maneras:

• Devuelve solo los elementos con Importance establecido en High.

• Devuelve solo las propiedades Subject, Sender y DateTimeReceived.

• Devuelve solo los primeros cinco mensajes.

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

Si especifica $filter , el servidor deducirá un criterio de ordenación para los resultados. Si usa $filter y a la vez $orderby, las propiedades en el $filter deben aparecer en primer lugar en la $orderby antes de las demás propiedades y deben aparecer en el orden en que aparecen en el parámetro $filter . El siguiente ejemplo muestra una consulta filtrada por las dos propiedades Subject e Importance, y luego ordenadas por las propiedades Subject, Importance y Sender.

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

Estos son los mismos ejemplos con codificación de URL y sin saltos de línea.

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

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

Vea también

• API REST de Outlook en el Centro de desarrollo de Outlook
• Información general del desarrollo en la plataforma de Office 365
• Autenticación de aplicaciones y autorización de recursos de Office 365
• Registrar manualmente su aplicación con Azure AD para poder acceder a las API de Office 365
• Referencia de la API de REST de correo de Outlook
• Referencia de la API de REST de calendario de Outlook
• Referencia de la API de REST de contactos de Outlook
• Referencia de las API de REST de tarea de Outlook