Referencia de recursos para las API de REST de correo, calendario, contactos y tareas (beta)

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

Este artículo describe las entidades, las propiedades, los tipos complejos, las enumeraciones y los parámetros de consulta de OData de la API de REST que puede usar con la API de Outlook de Correo, Calendario, Contactosy Tareaspara 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 de REST de Outlook para obtener más información común a todos los subconjuntos de esa API.

¿No está interesado en la versión beta de la API? 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.

Datos adjuntos

Un archivo, elemento (contacto, evento o mensaje), o un vínculo a un archivo o carpeta, que se adjunta a un evento, mensaje, o tarea. Los recursos de fileAttachment, referenceAttachment y referenceAttachment correspondientes se derivan del recurso Datos adjuntos.

Tipo: Microsoft.OutlookServices.Entity

Propiedad	Tipo	Descripción	¿Se puede escribir?	¿Se puede filtrar?
Tipo de contenido	Cadena	El tipo MIME de los datos adjuntos.	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. No es necesario que sea 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?
CanEdit	Booleano	Es verdadero si el usuario puede escribir en el calendario; de lo contrario, es falso. Esta propiedad es verdadera para el usuario que creó el calendario. Esta propiedad también es verdadera para un usuario con quien se compartió un calendario y al que se concedió acceso de escritura.	No	Sí
CanShare	Booleano	Es verdadero si el usuario tiene permiso para compartir el calendario; de lo contrario, es falso. Solo el usuario que creó el calendario puede compartirlo.	No	Sí
CanViewPrivateItems	Booleano	Es verdadero si el usuario puede leer elementos del calendario que se marcaron como privados; de lo contrario, es falso.	No	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
IsDefaultCalendar	Booleano	Es verdadero si este calendario es el calendario predeterminado del usuario, de lo contrario es falso.	Sí	Sí
IsShared	Booleano	Verdadero si el usuario ha compartido el calendario con otros usuarios, de lo contrario, es falso. Como solo el usuario que creó el calendario puede compartirlo, IsShared y IsSharedWithMe no pueden ser verdaderos para el mismo usuario.	No	Sí
IsSharedWithMe	Booleano	Verdadero si al usuario se le ha compartido este calendario, de lo contrario es falso. Esta propiedad siempre es falsa para un propietario de calendario.	No	Sí
Nombre	Cadena	El nombre del calendario.	Sí	Sí
Propietario	EmailAddress	Si se establece, esto representa al usuario que creó o agregó el calendario. Para un calendario que el usuario creó o agregó, la propiedad Owner está configurada para el usuario. Para un calendario compartido con el usuario, la propiedad Owner se establece a la persona que compartió ese calendario con el usuario.	No	Sí
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
MultiValueExtendedProperties	Una colección	Una colección de propiedades extendidas multivalor de tipo MultiValueLegacyExtendedProperty. Es una propiedad de navegación. Vea más información sobre propiedades extendidas.	Sí	Sí
SingleValueExtendedProperties	Una colección	Una colección de propiedades extendidas de un solo valor SingleValueLegacyExtendedProperty. Es una propiedad de navegación. Vea más información sobre propiedades extendidas.	Sí	Sí

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 único 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í
Fecha de nacimiento	datetimeoffset	El cumpleaños del contacto.	Sí	Sí
Categories	Colección (Cadena)	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 (Cadena)	Los nombres de los hijos del contacto.	Sí	Sí
CompanyName	Cadena	El nombre de la empresa del contacto.	Sí	Sí
CreatedDateTime	datetimeoffset	La hora en la que se creó el contacto.	No	Sí
Departmento	Cadena	El departamento del contacto.	Sí	Sí
DisplayName	Cadena	El nombre para mostrar del contacto.	Sí	Sí
EmailAddresses	Colección(EmailAddress)	Las direcciones de correo electrónico del contacto.	Sí	No
Extensiones	Colección(Extension)	La colección de extensiones de datos de tipo abierto definidas para el contacto. Propiedad de navegación.	No	Sí
FileAs	Cadena	El nombre con el que se ha archivado el contacto.	Sí	Sí
Flag	FollowupFlag	Información sobre cualquier seguimiento del contacto.	Sí	Sí
Gender	Cadena	El género del contacto.	Sí	Sí
Generación	Cadena	La generación del contacto.	Sí	Sí
GivenName	Cadena	El nombre del contacto.	Sí	Sí
Id	Cadena	El identificador único del contacto.	No	No
ImAddresses	Colección (Cadena)	Las direcciones de mensajería instantánea (MI) del contacto.	Sí	No
Iniciales	Cadena	Las iniciales del contacto.	Sí	Sí
JobTitle	Cadena	Puesto del contacto.	Sí	Sí
LastModifiedDateTime	datetimeoffset	La hora en que se modificó el contacto.	No	Sí
Administrador	Cadena	El nombre del administrador del contacto.	Sí	Sí
MiddleName	Cadena	El segundo nombre del contacto.	Sí	Sí
NickName	Cadena	El sobrenombre del contacto.	Sí	Sí
OfficeLocation	Cadena	La ubicación de la oficina 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í
Teléfonos	Colección(Phone)	Números de teléfono asociados con el contacto, por ejemplo, teléfono residencial, teléfono móvil y teléfono comercial.	Sí	Sí
PostalAddresses	Colección PhysicalAddress	Direcciones asociadas con el contacto, por ejemplo, dirección particular y dirección comercial.	Sí	No
Profesión	Cadena	La profesión del contacto.	Sí	Sí
SpouseName	Cadena	El nombre del cónyuge del contacto.	Sí	Sí
Apellidos	Cadena	Los apellidos del contacto.	Sí	Sí
Título	Cadena	El título del contacto.	Sí	No
Sitios web	Colección(Website)	Sitios web asociados con el contacto.	Sí	No
WeddingAnniversary	Fecha	El aniversario de bodas del contacto.	Sí	Sí
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

Las propiedades de navegación MultiValueExtendedProperties y SingleValueExtendedProperties también están disponibles para este recurso, para representar colecciones de tipos respectivos de propiedades extendidas definidas para una instancia de recurso. Para más información, vea API de REST de propiedades extendidas.

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)	Colección de carpetas secundarias en la carpeta. Propiedad de navegación.	No	No
Contactos	Colección(Contact)	Contactos en la carpeta. Propiedad de navegación.	No	No
DisplayName	Cadena	El nombre para mostrar de la carpeta.	Sí	Sí
Id	Cadena	Identificador único de la carpeta de contactos.	No	No
ParentFolderId	Cadena	El identificador de la carpeta principal de la carpeta.	No	No
WellKnownName	Cadena	El nombre de la carpeta si la carpeta es una carpeta reconocida. Actualmente contacts es la única carpeta de contactos reconocida.	No	No
MultiValueExtendedProperties	Una colección	Una colección de propiedades extendidas multivalor de tipo MultiValueLegacyExtendedProperty. Es una propiedad de navegación. Vea más información sobre propiedades extendidas.	Sí	Sí
SingleValueExtendedProperties	Una colección	Una colección de propiedades extendidas de un solo valor SingleValueLegacyExtendedProperty. Es una propiedad de navegación. Vea más información sobre propiedades extendidas.	Sí	Sí

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, ItemAttachment, yReferenceAttachment para el evento. Propiedad de navegación.	No	No
Asistentes	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	Calendario que contiene el evento. Propiedad de navegación.	No	No
Categories	Colección (Cadena)	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
CreatedDateTime	datetimeoffset	La fecha y hora en que se creó el evento.	No	Sí
End	DateTimeTimeZone	La fecha y hora en que finaliza el evento.	Sí	Sí
Extensiones	Colección(Extension)	Colección de extensiones de datos de tipo abierto definidas para el evento. Propiedad de navegación.	No	Sí
HasAttachments	booleano	Se establece como true si el evento tiene datos adjuntos.	No	Sí
Id	Cadena	El identificador exclusivo del evento.	No	No
Importancia	Importancia	Importancia del evento: Low, Normal, High.	Sí	Sí
Instancias	Colección(Event)	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	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	booleano	Se establece como true si el evento ha sido cancelado.	Sí	Sí
IsOrganizer	booleano	Se establece como true si el remitente del mensaje también es el organizador.	Sí	Sí
IsReminderOn	Booleano	Se establece en true si se establece una alerta para recordarle el evento al usuario.	Sí	Sí
LastModifiedDateTime	datetimeoffset	La fecha y hora en que el evento fue modificado por última vez.	No	Sí
Location	Location	Información de ubicación del evento.	Sí	Sí
Locations	Colección(Location)	Ubicaciones donde se celebra el evento o en las que se asiste.	Sí	Sí
OnlineMeetingUrl	Cadena	Una dirección URL para una reunión en línea.	Sí	No
Organizador	Recipient	El organizador del evento.	Sí	Sí
OriginalEndTimeZone	Cadena	Zona horaria de finalización que se estableció cuando se creó el evento. Consulte DateTimeTimeZone para obtener una lista de zonas horarias válidas.	No	Sí
OriginalStartTimeZone	Cadena	La zona horaria de inicio que se estableció cuando se creó el evento. Consulte DateTimeTimeZone para obtener una lista de zonas horarias válidas.	No	Sí
Periodicidad	PatternedRecurrence	El patrón de periodicidad del evento.	Sí	No
ReminderMinutesBeforeStart	Int32	El número de minutos antes de la hora de inicio del evento en que se producirá la alerta del recordatorio.	Sí	No
ResponseRequested	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í
Confidencialidad	Confidencialidad	Indica el nivel de privacidad del evento: Normal, Personal, Private, Confidential.	Sí	Sí
SeriesMasterId	Cadena	Las categorías asignadas al elemento.	Sí	No
ShowAs	FreeBusyStatus	El estado para mostrar: Free, Tentative, Busy, Oof, WorkingElsewhere, Unknown.	Sí	Sí
Iniciar	DateTimeTimeZone	La hora de inicio del evento.	Sí	Sí
Asunto	Cadena	Texto de la línea de asunto del evento.	Sí	Sí
Tipo	EventType	El tipo de evento: SingleInstance, Occurrence, Exception, SeriesMaster.	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

Las propiedades de navegación MultiValueExtendedProperties y SingleValueExtendedProperties también están disponibles para este recurso, para representar colecciones de tipos respectivos de propiedades extendidas definidas para una instancia de recurso. Para más información, vea API de REST de propiedades extendidas.

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 bien como resultado de un organizador de eventos que crea una reunión o como un asistente que responde a una convocatoria de reunión. Puede actuar con los mensajes de eventos de la misma manera que actúa en mensaje, con lagunas diferencias menores que se describen en la siguiente tabla.

Acción/verbo	Permiso	Descripción
Crear un mensaje de evento (POST)	N/D	No permitido. 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 borrador de mensaje para reenviar evento	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?
EndDateTime	DateTimeTimeZone	La fecha y hora en que finaliza el evento asociado.	Sí	Sí
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 Asistente 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
IsAllDay	Booleano	Indica si el evento dura todo el día. Ajustar esta propiedad requiere ajustar las propiedades StartDateTime y EndDateTime del evento también.	Sí	Sí
IsOutOfDate	Booleano	Indica si esta solicitud de reunión se ha desactualizado debido a una solicitud más reciente.	No	No
Location	Location	La ubicación del evento asociado.	Sí	Sí
MeetingMessageType	MeetingMessageType	El tipo de mensaje de evento: None = 0, MeetingRequest = 1, MeetingCancelled = 2, MeetingAccepted = 3, MeetingTentativelyAccepted = 4, MeetingDeclined = 5	No	Sí
Periodicidad	PatternedRecurrence	El patrón de periodicidad del evento asociado.	Sí	No
StartDateTime	DateTimeTimeZone	La hora de inicio del evento asociado.	Sí	Sí
Tipo	EventType	El tipo del evento asociado: SingleInstance = 0, Occurrence = 1, Exception = 2, SeriesMaster = 3.	Sí	Sí

EventMessageRequest (versión preliminar)

Un mensaje que representa una solicitud de reunión.

Tipo base: EventMessage

Propiedad	Tipo	Descripción	¿Se puede escribir?	¿Se puede filtrar?
PreviousEndDateTime	DateTimeTimeZone	La fecha y hora de finalización anterior de la reunión solicitada.	No	Sí
PreviousLocation	Location	La ubicación anterior de la reunión solicitada.	No	Sí
PreviousStartDateTime	DateTimeTimeZone	La fecha y hora de inicio previas de la reunión solicitada.	No	Sí

Propiedades extendidas

Puede crear una propiedad personalizada en una entidad como MultiValueLegacyExtendedProperty o SingleValueLegacyExtendedProperty, dependiendo de los valores destinados a la propiedad.

MultiValueLegacyExtendedProperty

Una propiedad extendida que puede contener una colección de valores múltiples.

Tipo: Microsoft.OutlookServices.MultiValueLegacyExtendedProperty

Propiedad	Tipo	Descripción	¿Se puede escribir?	¿Se puede filtrar?
Valor	Colección (Cadena)	Colección de valores de propiedad.	Sí	No
PropertyId	Cadena	El identificador de la propiedad. Esto se usa para identificar la propiedad.	No	No

SingleValueLegacyExtendedProperty

Propiedad extendida que contiene un solo valor.

Tipo: Microsoft.OutlookServices.SingleValueLegacyExtendedProperty

Propiedad	Tipo	Descripción	¿Se puede escribir?	¿Se puede filtrar?
Valor	Cadena	Valor de la propiedad.	Sí	No
PropertyId	Cadena	El identificador de la propiedad. Esto se usa para identificar la propiedad.	No	Sí

Al crear una propiedad extendida, hay varias formas de especificar la PropertyId. Consulte Formatos PropertyId para más información.

Consulte Referencia de la API de REST de propiedades extendidas para ver las operaciones relacionadas que puede usar.

FileAttachment

Un archivo (como un archivo de texto o un documento de Word) adjunto a un mensaje, evento o tarea. La propiedad ContentBytes incluye 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í
LastModifiedDateTime	datetimeoffset	La fecha y hora de la última modificación de los datos adjuntos.	No
Id	Cadena	El identificador de los datos adjuntos.	No
IsInline	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

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.MailFolder

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(MailFolder)	Colección de carpetas secundarias en la carpeta. Propiedad de navegación.	No	No
DisplayName	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: Bandeja de entrada, Borradores, Elementos enviados, Elementos eliminados.	No	No
MessageRules	Colección(MessageRule)	Conjunto de reglas que se aplican a la Bandeja de entrada. Propiedad de navegación.	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í
WellKnownName	Cadena	El nombre bien conocido de la carpeta, como clutter, deleteditems, drafts, inbox, junkemail, outbox, o sentitems.	No	Sí
MultiValueExtendedProperties	Una colección	Una colección de propiedades extendidas multivalor de tipo MultiValueLegacyExtendedProperty. Es una propiedad de navegación. Vea más información sobre propiedades extendidas.	Sí	Sí
SingleValueExtendedProperties	Una colección	Una colección de propiedades extendidas de un solo valor SingleValueLegacyExtendedProperty. Es una propiedad de navegación. Vea más información sobre propiedades extendidas.	Sí	Sí

Acceder a recuentos de elementos de forma eficaz

Las propiedades TotalItemCount y UnreadItemCount de una carpeta le permiten calcular fácilmente 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/beta/me/mailfolders/inbox/messages?$count=true&$filter=isread%20eq%20false

Las carpetas en Outlook pueden contener más de un tipo de elemento. Por ejemplo, la Bandeja de entrada puede contener elementos de convocatoria 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

Clasificación de mensajes de un usuario que permite poner el foco en los que son más relevantes o importantes para el usuario.

Tipo: Microsoft.OutlookServices.InferenceClassification

Propiedad	Tipo	Descripción	¿Se puede escribir?
Reemplazos	Colección(InferenceClassificationOverride)	Un conjunto de modificaciones para que un usuario clasifique siempre los mensajes de remitentes específicos de una manera determinada, tal y como admite InferenceClassificationType. Propiedad de navegación.	Sí

InferenceClassificationOverride

Representa el reemplazo de un usuario sobre cómo se deben clasificar siempre los mensajes entrantes de un remitente determinado.

Tipo: Microsoft.OutlookServices.InferenceClassificationOverride

Propiedad	Tipo	Descripción	¿Se puede escribir?
ClassifyAs	InferenceClassificationType	Especifica cómo se deben clasificar siempre los mensajes entrantes de un remitente determinado. Prioritarios=0, Otros=1.	Sí
Id	Cadena	Identificador único de la invalidación.	No
SenderEmailAddress	EmailAddress	Información de la dirección de correo del remitente para el que se creó el reemplazo.	Sí

ItemAttachment

Un mensaje, contacto o evento adjunto a otro mensaje, evento o tarea. 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í
LastModifiedDateTime	datetimeoffset	Última fecha y hora en que se modificaron los datos adjuntos.	No
Id	Cadena	El identificador de los datos adjuntos.	No
Elemento	Elemento	Evento o mensaje adjunto. Propiedad de navegación.	Sí
IsInline	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)

Representa una notificación a una persona basada en la dirección de correo electrónico de la persona. Este tipo de notificación también se conoce como menciones @.

El recurso Message admite Mention. Incluye una propiedad MentionsPreview que indica si el usuario registrado se menciona en esa instancia, y la propiedad de navegación Mentions que permite obtener detalles de cualquier mención en esa instancia.

Al crear un mensaje, una aplicación puede crear una mención en la misma solicitud POST al incluir la mención en la propiedadMentions. Usando una solicitud GET con el parámetro de consulta $filter, una aplicación puede devolver todos los mensajes en el buzón del usuario que ha iniciado sesión que mencionan al usuario. Una solicitud GET con el parámetro $expand de consulta permite a la aplicación expandir todas las menciones en un mensaje específico.

Este mecanismo de permitir que una aplicación establezca y reciba menciones en los mensajes permite notificaciones ligeras, en las que el usuario que hace la mención puede permanecer en el contexto existente (como componer el cuerpo de un mensaje) mientras la aplicación establece la propiedad Mentions subyacente. Las personas mencionadas pueden averiguar fácilmente si se mencionan a través de solicitudes GET con el parámetro de consulta $filter o $expand.

Un caso de uso de ejemplo de la API de Mentions está en Outlook, el cliente de correo. Cuando un usuario escribe @ mientras escribe un mensaje, Outlook le permite al usuario simplemente seleccionar o escribir un nombre para completar la mención @, sin tener que salir del contexto para llamar la atención de la persona. Outlook establece de forma interna la propiedad Mentions antes de crear y enviar realmente el mensaje. Outlook también usa operaciones GET con $filter y $expand para permitir que el usuario que haya iniciado sesión busque cómodamente si y en qué mensajes se menciona al usuario, alertando al usuario sobre elementos de acción o discusiones para lograr una respuesta más rápida.

Tipo: Microsoft.OutlookServices.Mention

Propiedad	Tipo	Descripción	¿Se puede escribir?	¿Se puede filtrar?
Aplicación	Cadena	El nombre de la aplicación donde se crea la mención. Opcional. No utilizado y predeterminado como nulo para Message.	Sí	No
ClientReference	Cadena	Un identificador exclusivo que representa un primario de la instancia de recurso. Opcional. No utilizado y predeterminado como nulo para Message.	Sí	Sí
CreatedBy	EmailAddress	La información de correo electrónico del usuario que hizo la mención. Necesario.	Sí	No
CreatedDateTime	DateTimeOffset	La fecha y hora en que se creó la mención en el cliente.	No	No
DeepLink	Cadena	Un vínculo web profundo al contexto de la mención en la instancia de recurso. Opcional. No utilizado y predeterminado como nulo para Message.	Sí	No
Id	Cadena	El identificador exclusivo de una mención en una instancia de recurso.	No	No
Mentioned	EmailAddress	La información de correo electrónico de la persona mencionada. Necesario.	Sí	No
MentionText	Cadena	Contenido de la mención. Opcional. No utilizado y predeterminado como nulo para Message.	Sí	No
ServerCreatedDateTime	DateTimeOffset	La fecha y hora en que se creó la mención en el servidor. Opcional. No utilizado y predeterminado como nulo para Message.	No	No

Mensaje

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?	¿Se puede buscar?
Datos adjuntos	Colección(Attachment)	Los datos adjuntos fileAttachment y itemAttachment para el mensaje. Propiedad de navegación.	Sí	No	Sí
BccRecipients	Colección (Destinatario)	Los destinatarios Cco del mensaje.	Sí	No	Sí
Body	ItemBody	El cuerpo del mensaje.	Sí	No	Default (predeterminado)
BodyPreview	Cadena	Los primeros 255 caracteres del contenido del cuerpo del mensaje.	No	No	Sí
Categories	Colección (String)	Categorías asociadas al mensaje.	Sí	Sí	Sí
CcRecipients	Colección (Destinatario)	Los destinatarios Cc para el 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
ConversationIndex	Binario	Indica la posición relativa del elemento dentro de la conversación a la que pertenece el correo electrónico.	No	No	No
CreatedDateTime	datetimeoffset	La fecha y la hora de creación del mensaje.	No	Sí	No
Extensiones	Colección(Extension)	Colección de extensiones de datos de tipo abierto definidas para el evento. Propiedad de navegación.	No	Sí	No
Flag	FollowupFlag	Información sobre cualquier seguimiento del mensaje.	Sí	Sí	Sí
De	Recipient	El propietario del buzón y el remitente del mensaje.	Sí	Sí	Sí
HasAttachments	booleano	Indica si el mensaje tiene datos adjuntos.	No	Sí	Sí
Id	Cadena	El identificador exclusivo del mensaje.	No	No	No
Importancia	Importancia	Importancia del mensaje: Baja = 0, Normal = 1, Alta = 2.	Sí	Sí	Sí
InferenceClassification	InferenceClassificationType	La clasificación del mensaje para el usuario, según la importancia o relevancia inferida, o según una invalidación explícita.	Sí	Sí	No
InternetMessageId	Cadena	El identificador del mensaje en el formato especificado por RFC2822.	No	No	No
InternetMessageHeaders	Colección(InternetMessageHeader)	La colección de encabezados de mensaje de internet en el formato especificado por RFC2822.	No	No	No
IsDeliveryReceiptRequested	booleano	Indica si se solicita confirmación de lectura para el mensaje.	Sí	Sí	No
IsDraft	booleano	Indica si el mensaje es un borrador. Un mensaje es un borrador si no se ha enviado todavía.	No	Sí	No
IsRead	booleano	Indica si se ha leído el mensaje.	Sí	Sí	No
IsReadReceiptRequested	booleano	Indica si se solicita confirmación de lectura para el mensaje.	Sí	Sí	No
LastModifiedDateTime	datetimeoffset	La fecha y la hora de la última modificación del mensaje.	No	Sí	No
Mentions	Colección (Mention)	Una colección de menciones en el mensaje, ordenadas por CreatedDateTime de la más nueva a la más antigua. Por defecto, un mensaje GET no devuelve esta propiedad a menos que se aplique $expand en la propiedad. Propiedad de navegación.	Sí	No	No
MentionsPreview	MentionsPreview	Información sobre menciones en el mensaje. Al procesar una solicitud GET /messages, el servidor establece esta propiedad y la incluye en la respuesta predeterminada. El servidor devuelve null si no hay menciones en el mensaje. Opcional.	No	No	No
MultiValueExtendedProperties	Una colección	Una colección de propiedades extendidas multivalor de tipo MultiValueLegacyExtendedProperty. Es una propiedad de navegación. Vea más información sobre propiedades extendidas.	Sí	Sí	No
ParentFolderId	Cadena	Identificador único para la carpeta primaria del mensaje.	No	No	No
ReceivedDateTime	datetimeoffset	La fecha y la hora en las que se recibió el mensaje.	No	Sí	Sí
ReplyTo	Colección (Destinatario)	Las direcciones de correo electrónico que se utilizan al responder.	No	No	No
Sender	Recipient	La cuenta que se utiliza realmente para generar el mensaje.	Sí	Sí	Default (predeterminado)
SentDateTime	datetimeoffset	La fecha y la hora de envío del mensaje.	No	Sí	No
SingleValueExtendedProperties	Una colección	Una colección de propiedades extendidas de un solo valor SingleValueLegacyExtendedProperty. Es una propiedad de navegación. Vea más información sobre propiedades extendidas.	Sí	Sí	No
Asunto	Cadena	El asunto del mensaje.	Sí	Sí	Default (predeterminado)
ToRecipients	Colección (Destinatario)	Destinatarios Para del mensaje.	Sí	No	Sí
UniqueBody	ItemBody	El cuerpo del mensaje que es exclusivo de la conversación.	No	No	No
UnsubscribeData	Colección (String)	Esto contiene las entradas válidas analizadas desde el encabezado List-Unsubscribe. Si la propiedad UnsubscribeEnabled es true, esto contendría los datos para el comando mailto: en el encabezado List-Unsubscribe. Los datos deben ajustarse a RFC-2369. Utilice la acción Unsubscribe para detener mensajes futuros enviados a la lista de distribución correspondiente.	No	No	No
UnsubscribeEnabled	booleano	Indica si este mensaje permite a un destinatario finalizar la suscripción y detener mensajes futuros que se envían de acuerdo con una lista de distribución de correo electrónico. True si el encabezado List-Unsubscribe se ajusta a RFC-2369.	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, cualquier HTML potencialmente inseguro (por ejemplo, JavaScript) incorporado en la propiedad Cuerpo se eliminaría por defecto 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

Configurar 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 usando 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 en uno o más usuarios para que puedan enviar mensajes desde ese buzón. El propietario del buzón puede delegar en Outlook. Cuando una persona delegada 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)

Regla que se aplica a los mensajes de la Bandeja de entrada de un usuario.

Tipo: Microsoft.OutlookServices.MessageRule

Propiedad	Tipo	Descripción	¿Se puede escribir?
Acciones	MessageRuleActions	Acciones que se van a realizar en un mensaje cuando se cumplan las condiciones correspondientes.	Sí
Condiciones	MessageRulePredicates	Condiciones que, cuando se cumplan, activarán las acciones correspondientes a esa regla.	Sí
DisplayName	Cadena	Nombre para mostrar de la regla.	Sí
Excepciones	MessageRulePredicates	Representa las condiciones de excepción de la regla.	Sí
HasError	Booleano	Indica si la regla es una condición de error.	No
IsEnabled	Booleano	Indica si la regla está habilitada para que se aplique a los mensajes.	Sí
IsReadOnly	Booleano	Indica si la regla es de solo lectura y la API de REST de reglas no la puede modificar ni eliminar.	Sí
Sequence	Int32	Indica el orden en que se ejecuta la regla entre otras reglas.	Sí

OutlookCategory (versión preliminar)

Tipo: Microsoft.OutlookServices.OutlookCategory

Una categoría en la que un usuario puede agrupar elementos de Outlook tales como mensajes y eventos en su buzón.

Propiedad	Tipo	Descripción	¿Se puede escribir?	¿Se puede filtrar?
DisplayName	Cadena	Un nombre exclusivo para esta categoría en el buzón del usuario.	No	Sí
Color	CategoryColor	Una constante preestablecida que representa el color mapeado para esta categoría.	Sí	Sí

Foto

Tipo: Microsoft.OutlookServices.Photo

Una foto a la que se accede desde Exchange Online. Son datos binarios no codificados en base-64.

Propiedad	Tipo	Descripción	¿Se puede escribir?	¿Se puede filtrar?
Alto	entero	La altura de la foto	No	No
Id	Cadena	El identificador exclusivo de la foto.	No	No
Ancho	entero	El ancho de la foto.	No	No

ReferenceAttachment

Tipo: Microsoft.OutlookServices.ReferenceAttachment

Tipo base: Microsoft.OutlookServices.Attachment

Un vínculo a un archivo o carpeta, adjunto a un mensaje, evento o tarea. Las ubicaciones posibles para el archivo o la carpeta incluyen OneDrive, OneDrive para la Empresa y DropBox. Derivada de la entidad Attachment.

Propiedad	Tipo	Descripción	¿Se puede escribir?	¿Se puede filtrar?
Tipo de contenido	Cadena	El tipo MIME de los datos adjuntos. Opcional.	Sí	No
Id	Cadena	El identificador exclusivo de la referencia adjunta.	No	No
IsFolder	Booleano	Especifica si los datos adjuntos son un vínculo a una carpeta. Debe establecer esto en verdadero si SourceUrl es un vínculo a una carpeta. Opcional.	Sí	No
IsInline	Booleano	true si los datos adjuntos son datos adjuntos en línea; de lo contrario, false. Opcional.	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'. Opcional.	No	Sí
Nombre	Cadena	Nombre para mostrar de los datos adjuntos. No es necesario que sea el nombre real del archivo. Necesario.	Sí	Sí
Permiso	ReferenceAttachmentPermissions	Especifica los permisos otorgados para los datos adjuntos por el tipo de proveedor en ProviderType. Los valores posibles son: Other, View, Edit, AnonymousView, AnonymousEdit, OrganizationView y OrganizationEdit. Opcional.	Sí	No
PreviewUrl	Cadena	Se aplica solo a una referencia adjunta de una imagen, URL para obtener una imagen de vista previa. Utilice ThumbnailUrl y PreviewUrl solo cuando SourceUrl identifica un archivo de imagen. Opcional.	Sí	No
ProviderType	ReferenceAttachmentProviders	El tipo de proveedor que admite los datos adjuntos de este ContentType. Los valores posibles son: Other, OneDriveBusiness, OneDriveConsumer y Dropbox. Opcional.	Sí	Sí
Tamaño	Int32	La longitud en bytes de los datos adjuntos. Opcional.	No	No
SourceUrl	Cadena	URL para obtener el contenido del archivo adjunto. Si se trata de una URL a una carpeta, para que la carpeta se muestre correctamente en Outlook o Outlook en la web, configure IsFolder en true. Necesario.	Sí	No
ThumbnailUrl	Cadena	Se aplica solo a una referencia adjunta de una imagen, URL para obtener una imagen de miniatura. Utilice ThumbnailUrl y PreviewUrl solo cuando SourceUrl identifica un archivo de imagen. Opcional.	Sí	No

Tarea

Tipo: Microsoft.OutlookServices.Task

Un elemento de Outlook que puede seguir un elemento de trabajo. Puede usar una tarea para seguir las fechas y horas de inicio, vencimiento y finalización real, su progreso o estado, si es periódica y si requiere recordatorios.

Para cada una de las siguientes propiedades relacionadas con la fecha:

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

Si la propiedad está configurada, de manera predeterminada, la API de REST de Task la devuelve en UTC en una respuesta REST. Obtenga más información sobre cómo configurar StartDateTime y DueDateTime y devolver las propiedades relacionadas con la fecha en una zona horaria personalizada.

Propiedad	Tipo	Descripción	¿Se puede escribir?	¿Se puede filtrar?
AssignedTo	Cadena	El nombre de la persona a la que se le ha asignado la tarea.	No	Sí
Datos adjuntos	Colección(Attachment)	La colección de datos adjuntos FileAttachment, ItemAttachment, yReferenceAttachment para la tarea. Propiedad de navegación.	No	No
Cuerpo	ItemBody	El cuerpo de la tarea que generalmente contiene información sobre la tarea. Tenga en cuenta que solo se admite el tipo de HTML.	Sí	No
Categories	Colección (Cadena)	Las categorías asociadas a la tarea.	Sí	Sí
ChangeKey	Cadena	Las categorías asociadas a la tarea.	No	No
CompletedDateTime	DateTimeTimeZone	La fecha en la zona horaria especificada en que se finalizó la tarea.	Sí	Sí
CreatedDateTime	DateTimeOffset	Fecha y hora en la que se creó una tarea. Por defecto, está en UTC. Puede proporcionar una zona horaria personalizada en el encabezado de solicitud.	No	Sí
DueDateTime	DateTimeTimeZone	La fecha en la zona horaria especificada en la que se debe finalizar la tarea.	Sí	Sí
HasAttachments	booleano	Establezca en verdadero si la tarea tiene datos adjuntos.	No	Sí
Id	Cadena	El identificador exclusivo de la tarea.	No	No
Importancia	Importancia	Importancia del evento: Low, Normal, High.	Sí	Sí
IsReminderOn	booleano	Se establece como verdadero si se crea una alerta para recordarle el evento al usuario.	Sí	No
LastModifiedDateTime	DateTimeOffset	Fecha y hora de la última modificación de la tarea. Por defecto, está en UTC. Puede proporcionar una zona horaria personalizada en el encabezado de solicitud.	No	Sí
Propietario	Cadena	El nombre de la persona que creó la tarea.	No	Sí
ParentFolderId	Cadena	El identificador exclusivo para la carpeta primaria de la tarea.	No	No
Periodicidad	PatternedRecurrence	El patrón de periodicidad para la tarea.	Sí	No
ReminderDateTime	DateTimeTimeZone	La fecha y hora de una alerta de recordatorio de la tarea que se producirá.	Sí	No
Confidencialidad	Confidencialidad	Indica el nivel de privacidad del evento: Normal, Personal, Private, Confidential.	Sí	Sí
StartDateTime	DateTimeTimeZone	La fecha en la zona horaria especificada cuando la tarea debe comenzar.	Sí	Sí
Estado	TaskStatus	Indica estado o progreso de la tarea: NotStarted, InProgress, Completed, WaitingOnOthers, Deferred.	Sí	Sí
Asunto	Cadena	Una breve descripción o título de la tarea.	Sí	Sí

TaskFolder

Tipo: Microsoft.OutlookServices.TaskFolder

Carpeta que contiene tareas. En Outlook, el grupo de tareas predeterminado, My Tasks, contiene una carpeta de tareas predeterminada, Tasks, para el buzón del usuario. No puede cambiar el nombre ni eliminar estos grupos de tareas y carpetas predeterminados, pero puede crear grupos de tareas y carpetas de tareas adicionales.

Propiedad	Tipo	Descripción	¿Se puede escribir?	¿Se puede filtrar?
ChangeKey	Cadena	La versión de la carpeta de tareas.	No	No
Id	Cadena	El identificador exclusivo de la carpeta de tareas.	No	No
IsDefaultFolder	Booleano	Verdadero si la carpeta es la carpeta de tareas predeterminada.	No	Sí
Nombre	Cadena	El nombre de la carpeta de tareas.	Sí	Sí
ParentGroupKey	Edm.Guid	El identificador GUID exclusivo para el grupo primario de la carpeta de tareas.	No	No
Tareas	Colección(Task)	Las tareas en esta carpeta de tareas. Propiedad de navegación.	No	No

TaskGroup

Tipo: Microsoft.OutlookServices.TaskGroup

Un grupo de carpetas que contienen tareas. En Outlook, hay un grupo de tareas predeterminado My Tasks el cual no puede renombrar o eliminar. Sin embargo, puede crear grupos de tareas adicionales.

Propiedad	Tipo	Descripción	¿Se puede escribir?	¿Se puede filtrar?
ChangeKey	Cadena	La versión del grupo de tareas.	No	No
GroupKey	Edm.Guid	El identificador GUID exclusivo para el grupo de tareas.	No	No
Id	Cadena	Identificador único del grupo de tareas.	No	No
IsDefaultGroup	Booleano	Verdadero si el grupo de tareas es el grupo de tareas predeterminado.	No	Sí
Nombre	Cadena	Nombre del grupo de tareas.	Sí	Sí
TaskFolders	Colección(TaskFolder)	Las carpetas de tareas en este grupo de tareas. Propiedad de navegación.	No	No

Usuario

Usuario del sistema. El extremo Me se proporciona como un acceso directo para especificar el usuario actual mediante la 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. Normalmente, 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)	Grupos de calendario del usuario. Propiedad de navegación.	No	No
Calendarios	Colección(Calendar)	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
DisplayName	Cadena	El nombre para mostrar del usuario.	Sí	Sí
Eventos	Colección(Event)	Los eventos del usuario. El valor predeterminado muestra los eventos en el calendario predeterminado. Propiedad de navegación.	No	No
Id	Cadena	El identificador único del usuario.	No	No
InferenceClassification	InferenceClassification	Clasificación de relevancia de los mensajes del usuario según las designaciones explícitas que invalidan una relevancia o importancia inferida. Propiedad de navegación.	Sí	Sí
MailboxGuid	guid	El GUID asignado al buzón del usuario.	No	Sí
MailboxSettings	MailboxSettings	Configuración del buzón principal del usuario que inició sesión.	Sí	No
MailFolders	Colección(MailFolder)	Las carpetas en un buzón. Propiedad de navegación.	No	No
MasterCategories	Colección(OutlookCategory)	La lista maestra de categorías del usuario. Propiedad de navegación.	Sí	Sí
Mensajes	Colección(Message)	Mensajes en un buzón o carpeta. Propiedad de navegación.	No	No
RootFolder	MailFolder	La carpeta raíz del buzón del usuario. Propiedad de navegación.	No	No

Tipos complejos

• Asistente
• AttendeeAvailability
• AttendeeBase
• AutomaticRepliesMailTips (vista previa)
• AutomaticRepliesSetting
• DateTimeTimeZone
• EmailAddress
• Error (vista previa)
• FollowUpFlag (vista previa)
• GeoCoordinates
• InternetMessageHeader (vista previa)
• ItemBody
• LocaleInfo
• Location
• LocationConstraint
• LocationConstraintItem
• MailboxSettings
• MailTips (vista previa)
• MeetingTimeSuggestion
• MeetingTimeSuggestionsResult
• MentionsPreview (vista previa)
• MessageRuleActions (vista previa)
• MessageRulePredicates (vista previa)
• PatternedRecurrence
• Teléfono (vista previa)
• PhysicalAddress
• Recipient
• RecurrencePattern
• RecurrenceRange
• ResponseStatus
• SizeRange (vista previa)
• TimeConstraint
• TimeSlot
• TimeZoneInformation (vista previa)
• Website (vista previa)
• WorkingHours (vista previa)

Asistente

Asistente a un evento.

Tipo: Microsoft.OutlookServices.AttendeeBase

Propiedad	Tipo	Descripción
Estado	ResponseStatus	La respuesta (ninguna, aceptada, rechazada, etc.) y el tiempo.

AttendeeAvailability

El tipo y la disponibilidad de un asistente.

Tipo: Microsoft.OutlookServices.AttendeeAvailability

Propiedad	Tipo	Descripción
Asistente	AttendeeBase	El tipo de asistente, ya sea una persona o un recurso.
Disponibilidad	FreeBusyStatus	El estado de disponibilidad del asistente.

AttendeeBase

El tipo de asistente.

Tipo: Microsoft.OutlookServices.Recipient

Propiedad	Tipo	Descripción
Tipo	AttendeeType	El tipo de asistente. Los valores posibles son: Required, Optional y Resource. NOTA: Si el asistente es una persona, FindMeetingTimes siempre considera que la persona es del tipo Required.

AutomaticRepliesMailTips (versión preliminar)

Sugerencias de correo sobre respuestas automáticas configuradas en un buzón.

Tipo: Microsoft.OutlookServices.AutomaticRepliesMailTips

Propiedad	Tipo	Descripción
Mensaje	Cadena	El mensaje de respuesta automática.
MessageLanguage	LocaleInfo	El idioma en el que se encuentra el mensaje de respuesta automática.
ScheduledStartTime	DateTimeTimeZone	La fecha y la hora en que las respuestas automáticas están configuradas para comenzar.
ScheduledEndTime	DateTimeTimeZone	La fecha y la hora en que las respuestas automáticas se configuran para finalizar.

AutomaticRepliesSetting

Opciones de configuración para notificar de forma automática al remitente de un mensaje de correo entrante con un mensaje del usuario que ha iniciado sesión. Por ejemplo, una respuesta automática para notificar que el usuario que ha iniciado sesión no está disponible para responder a correos electrónicos.

Tipo: Microsoft.OutlookServices.AutomaticRepliesSetting

Propiedad	Tipo	Descripción
ExternalAudience	ExternalAudienceScope	Conjunto de audiencia externa a la organización del usuario que ha iniciado sesión y que recibirá el ExternalReplyMessage, si Status es AlwaysEnabled o Scheduled. Los valores son None = 0, ContactsOnly = 1, o All = 2.
ExternalReplyMessage	Cadena	La respuesta automática para enviar a la audiencia externa especificada, si Status es AlwaysEnabled o Scheduled.
InternalReplyMessage	Cadena	La respuesta automática para enviar a la audiencia interna de la organización del usuario que ha iniciado sesión, si Status es AlwaysEnabled o Scheduled.
ScheduledEndDateTime	DateTimeTimeZone	La fecha y hora en que se establece la finalización de las respuestas automáticas, si Status se establece en Scheduled. Puede establecer la zona horaria usando encabezado HTTP Prefer: outlook.timezone en la operación Get.
ScheduledStartDateTime	DateTimeTimeZone	La fecha y hora en que se establece el inicio de las respuestas automáticas, si Status se establece en Scheduled. Puede establecer la zona horaria usando encabezado HTTP Prefer: outlook.timezone en la operación Get.
Estado	AutomaticRepliesStatus	Estado de configuraciones para respuestas automáticas: Disabled = 0, AlwaysEnabled = 1, Scheduled = 2.

DateTimeTimeZone

Describe la fecha, la hora y la zona horaria de un momento dado.

Propiedad	Tipo	Descripción
DateTime	Fecha y hora	Un único punto temporal en una representación combinada de fecha y hora (<date>T<time>) según el formato ISO 8601
TimeZone	Cadena	Uno de los siguientes nombres de zona horaria.

La propiedad TimeZone puede establecerse en cualquiera de las zonas horarias compatibles con Windows, así como los nombres de zona horaria siguientes. Consulte TimeZone para más información.

Etc/GMT+12

Etc/GMT+11

Pacific/Honolulu

América/Anchorage

América/Santa Isabel

América/Los_Angeles

America/Phoenix

America/Chihuahua

America/Denver

America/Guatemala

America/Chicago

America/Mexico_City

America/Regina

America/Bogota

America/New_York

America/Indiana/Indianapolis

America/Caracas

America/Asuncion

America/Halifax

America/Cuiaba

America/La_Paz

America/Santiago

America/St_Johns

America/Sao_Paulo

America/Argentina/Buenos_Aires

America/Cayenne

America/Godthab

America/Montevideo

America/Bahia

Etc/GMT+2

Atlantic/Azores

Atlantic/Cape_Verde

Africa/Casablanca

Etc/GMT

Europe/London

Atlantic/Reykjavik

Europe/Berlin

Europe/Budapest

Europe/Paris

Europe/Warsaw

Africa/Lagos

Africa/Windhoek

Europe/Bucharest

Asia/Beirut

África/El_Cairo

Asia/Damasco

África/Johannesburgo

Europe/Kiev

Europe/Istanbul

Asia/Jerusalem

Asia/Amman

Asia/Baghdad

Europe/Kaliningrad

Asia/Riyadh

Africa/Nairobi

Asia/Tehran

Asia/Dubai

Asia/Baku

Europe/Moscow

Indian/Mauritius

Asia/Tbilisi

Asia/Yerevan

Asia/Kabul

Asia/Karachi

Asia/Tashkent

Asia/Kolkata

Asia/Colombo

Asia/Kathmandu

Asia/Almaty

Asia/Dhaka

Asia/Yekaterinburg

Asia/Rangoon

Asia/Bangkok

Asia/Novosibirsk

Asia/Shanghai

Asia/Krasnoyarsk

Asia/Singapore

Australia/Perth

Asia/Taipei

Asia/Ulaanbaatar

Asia/Irkutsk

Asia/Tokyo

Asia/Seoul

Australia/Adelaide

Australia/Darwin

Australia/Brisbane

Australia/Sydney

Pacific/Port_Moresby

Australia/Hobart

Asia/Yakutsk

Pacific/Guadalcanal

Asia/Vladivostok

Pacific/Auckland

Etc/GMT-12

Pacific/Fiji

Asia/Magadan

Pacific/Tongatapu

Pacific/Apia

Pacífico/Kiritimati

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.

Error (versión preliminar)

Un error que ocurre durante una acción.

Tipo: Microsoft.OutlookServices.Error

Propiedad	Tipo	Descripción
Mensaje	Cadena	Mensaje de error.
Código	Cadena	Código de error.

FollowUpFlag (versión preliminar)

Información sobre el seguimiento en una instancia de recurso.

Tipo: Microsoft.OutlookServices.FollowupFlag

Propiedad	Tipo	Descripción
CompletedDateTime	DateTimeTimeZone	La fecha y hora en que finalizó el seguimiento.
DueDateTime	DateTimeTimeZone	Fecha y hora en que se va a finalizar el seguimiento.
StartDateTime	DateTimeTimeZone	Fecha y hora en que va a iniciarse el seguimiento.
FlagStatus	FollowupFlagStatus	Representa si la instancia de recurso primario está marcada para seguimiento o si su seguimiento ha finalizado.

GeoCoordinates

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

Tipo: Microsoft.OutlookServices.GeoCoordinates

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

InternetMessageHeader (versión preliminar)

Un par clave-valor que representa un encabezado de mensaje de internet en el formato especificado por RFC2822 que proporciona detalles de la ruta de red tomada por un mensaje del remitente al destinatario.

Tipo: Microsoft.OutlookServices.InternetMessageHeader

Propiedad	Tipo	Descripción
Nombre	Cadena	La clave en el par clave-valor del encabezado del mensaje de internet.
Valor	Cadena	El valor en el par clave-valor del encabezado del mensaje de internet.

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.

LocaleInfo

Información sobre la configuración regional, como el idioma preferido y el país o región del usuario que inició sesión.

Tipo: Microsoft.OutlookServices.LocaleInfo

Propiedad	Tipo	Descripción
DisplayName	Cadena	Nombre que representa una configuración regional por su idioma natural, por ejemplo, "Inglés (Estados Unidos)".
Configuración regional	Cadena	Una configuración regional que incluye el idioma y el país/región. Por ejemplo, "en-us". El componente de idioma sigue los códigos de 2 letras como se define en ISO 639-1, y el componente de país sigue los códigos de 2 letras como se define en ISO 3166-1 alpha-2.

Location (versión preliminar)

La ubicación de un evento.

Tipo: Microsoft.OutlookServices.Location

Propiedad	Tipo	Descripció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.
DisplayName	Cadena	Nombre asociado a la ubicación.
LocationEmailAddress	Cadena	Dirección de correo electrónico opcional de la ubicación
LocationUri	Cadena	URI opcional que representa la ubicación.
LocationType	LocationType	El tipo de ubicación: Default, ConferenceRoom, HomeAddress, BusinessAddress,GeoCoordinates, StreetAddress, Hotel, Restaurant, LocalBusiness, PostalAddress.

LocationConstraint

Las condiciones establecidas por un cliente para la ubicación de una reunión.

Tipo: Microsoft.OutlookServices.LocationConstraint

Propiedad	Tipo	Descripción
IsRequired	booleano	El cliente solicita al servicio que incluya en la respuesta una ubicación de reunión para la reunión.
SuggestLocation	booleano	El cliente solicita al servicio que sugiera una o más ubicaciones de reunión.
Locations	Colección(LocationConstraintItem)	Una o más ubicaciones que el cliente solicita para una reunión.

LocationConstraintItem

Las condiciones establecidas por un cliente para verificar la disponibilidad de cada ubicación de una reunión y otra información sobre la ubicación.

Tipo: Microsoft.OutlookServices.Location

Propiedad	Tipo	Descripción
ResolveAvailability	booleano	Si se establece en verdadero y el recurso especificado está ocupado, FindMeetingTimes busca otro recurso que esté libre. Si se establece en falso y el recurso especificado está ocupado, FindMeetingTimes devuelve el recurso mejor clasificado en el caché del usuario sin verificar si está libre. Lo predeterminado es verdadero.

MailTips (versión preliminar)

Mensajes informativos que se muestran a los usuarios mientras redactan un mensaje. Por ejemplo, un mensaje de fuera de la oficina como una respuesta automática para un destinatario del mensaje.

Tipo: Microsoft.OutlookServices.MailTips

Propiedad	Tipo	Descripción
EmailAddress	EmailAddress	La dirección de correo electrónico del destinatario para recibir sugerencias de correo.
AutomaticReplies	AutomaticRepliesMailTips	Sugerencias por correo para la respuesta automática si el destinatario lo ha configurado.
MailboxFull	Booleano	El estado de lleno del buzón del destinatario.
CustomMailTip	Cadena	Una sugerencia de correo personalizada que se puede configurar en el buzón del destinatario.
ExternalMemberCount	Int32	La cantidad de miembros externos si el destinatario es una lista de distribución.
TotalMemberCount	Int32	La cantidad de miembros si el destinatario es una lista de distribución.
DeliveryRestricted	Booleano	Si el buzón del destinatario está restringido, por ejemplo, si solo acepta mensajes de una lista predefinida de remitentes, rechaza mensajes de una lista predefinida de remitentes o acepta mensajes de solo remitentes autenticados.
IsModerated	Booleano	Si el envío de mensajes al destinatario requiere aprobación. Por ejemplo, si el destinatario es una gran lista de distribución y se ha configurado un moderador para aprobar los mensajes enviados a esa lista de distribución, o si el envío de mensajes a un destinatario requiere la aprobación del administrador del destinatario.
RecipientScope	RecipientScopeType	El ámbito del destinatario, como interno, externo, socio. Por ejemplo, un administrador puede establecer que otra organización sea su "socio". El ámbito es útil si un administrador desea que ciertas sugerencias de correo sean accesibles para ciertos ámbitos. También es útil para los remitentes, para informarles de que su mensaje puede salir de la organización y ayudarles a tomar las decisiones correctas sobre la redacción, el tono y el contenido.
RecipientSuggestions	Colección(Recipient)	Destinatarios sugeridos basados ​​en contextos anteriores donde aparecen en el mismo mensaje.
MaxMessageSize	Int32	El tamaño máximo de mensaje que se ha configurado para la organización o el buzón del destinatario.
Error	Error	Errores que ocurren durante la acción GetMailTips.

MailboxSettings

Configuración para el buzón principal del usuario.

Tipo: Microsoft.OutlookServices.MailboxSettings

Propiedad	Tipo	Descripción
AutomaticRepliesSetting	AutomaticRepliesSetting	Configuración para configurar automáticamente el envío de respuestas a los mensajes entrantes.
TimeZone	Cadena	La zona horaria predeterminada del buzón del usuario.
Idioma	LocaleInfo	Representación de la configuración regional del usuario, como el idioma preferido y el país o región.
WorkingHours	WorkingHours	Días de la semana y horas de la zona horaria específica en la que trabaja el usuario.

MeetingTimeSuggestion

Sugerencia de reunión que incluye información como la hora de la reunión, la probabilidad de asistencia, la disponibilidad individual de los asistentes y las ubicaciones disponibles para reuniones.

Tipo: Microsoft.OutlookServices.MeetingTimeSuggestion

Propiedad	Tipo	Descripción
MeetingTimeSlot	TimeSlot	Un período de tiempo sugerido para la reunión.
Confianza	doble	Un porcentaje que representa la probabilidad de que acudan todos los asistentes.
OrganizerAvailability	FreeBusyStatus	Disponibilidad del organizador de la reunión para esta sugerencia de reunión: Free, Tentative, Busy, Oof, WorkingElsewhere, Unknown.
AttendeeAvailability	Colección(AttendeeAvailability)	Una matriz que muestra el estado de disponibilidad de cada asistente para esta sugerencia de reunión.
Locations	Colección(Location)	Una matriz que especifica el nombre y la ubicación geográfica de cada ubicación de reunión para esta sugerencia de reunión.
SuggestionReason	Cadena	Describe las razones para sugerir el horario de la reunión.

La confianza de una reunión

La propiedad Confidence de un objeto MeetingTimeSuggestion oscila entre 0 % y 100 %, y representa la posibilidad de que todos los asistentes asistan a la reunión en base a cada uno de sus estados de disponibilidad individual:

• Para cada asistente, un estado libre para una periodo de tiempo de reunión especificado se corresponde al 100 % de posibilidades de asistencia, un estado desconocido al 49 % y un estado ocupado al 0 %.
• La confianza de una sugerencia de hora de la reunión se calcula promediando la posibilidad de asistencia sobre todos los asistentes especificados para esa reunión.
• Puede usar el parámetro opcional MinimumAttendeePercentage para FindMeetingTimes para especificar que solo se devuelvan como resultado franjas horarias de reunión de al menos cierto nivel de confianza. Por ejemplo, puede especificar un MinimumAttendeePercentage del 80 % si solo desea sugerencias que tengan un 80 % de probabilidad o más de que todos los asistentes asistan. Si no especifica MinimumAttendeePercentage, FindMeetingTimes asume un valor de 50 %.
• Si hay varios candidatos para la hora de la reunión, la acción FindMeetingTimes ordena en primer lugar a los candidatos por su valor de confianza calculado de mayor a menor. Si hay candidatos con la misma confianza, la acción ordena a estos candidatos cronológicamente.

Por ejemplo, si una franja horaria de la reunión implica a tres asistentes con el siguiente estado de disponibilidad:

Asistente	Estado de disponibilidad	Posibilidades de asistencia (%)
Dana	Libre	100 %
Pelayo	Desconocido	49 %
Fanny	Ocupado	0 %

Entonces, la confianza de la franja horaria de la reunión, que es la posibilidad media de asistencia, es (100 % + 49 % + 0 %)/3 = 49,66 %.

Si especifica un valor MinimumAttendeePercentage del 80 % en una operación FindMeetingTimes, debido a que 49,66 % < 80 %, la operación no sugerirá esta franja horaria en la respuesta.

MeetingTimeSuggestionsResult

Una colección de sugerencias para la reunión, en caso de haberla, o el motivo de su cancelación, en caso de que se produzca.

Tipo: Microsoft.OutlookServices.MeetingTimeSuggestionsResult

Propiedad	Tipo	Descripción
MeetingTimeSuggestions	Colección(MeetingTimeSuggestion)	Matriz de sugerencias de reunión.
EmptySuggestionsReason	Cadena	Un motivo por el que no se devuelven sugerencias de reunión. Los valores posibles son: AttendeesUnavailable, LocationsUnavailable, OrganizerUnavailable, AttendeesUnavailableOrUnknown o Unknown.

Razones para no devolver sugerencias de reuniones

La propiedad EmptySuggestionsReason especifica una de las siguientes razones por las cuales la acción FindMeetingTimes no devuelve ninguna sugerencia de reunión. La propiedad es una cadena vacía si FindMeetingTimes devuelve cualquier sugerencia de reunión.

Valor	Razones
AttendeesUnavailable	Se conoce la disponibilidad de todos los asistentes, pero no hay suficientes asistentes disponibles para alcanzar el umbral de confianza de la reunión, que de forma predeterminada es del 50 %.
AttendeesUnavailableOrUnknown	Algunos (o todos) los asistentes tienen una disponibilidad desconocida, lo que provoca que la confianza en la reunión caiga por debajo del umbral establecido, que de forma predeterminada es del 50%. La disponibilidad de los asistentes puede ser desconocida si estos se encuentran fuera de la organización, o si hay un error al obtener la información de disponibilidad.
LocationsUnavailable	La propiedad IsRequired del parámetro LocationConstraint se especifica como obligatoria y aún no hay ninguna ubicación disponible para las franjas horarias calculadas.
OrganizerUnavailable	El parámetro IsOrganizerOptional es falso y el organizador aún no está disponible durante la ventana temporal solicitada.
Desconocido	No se conoce el motivo por el que no se devuelven sugerencias de reunión.

MentionsPreview (versión preliminar)

Representa información sobre menciones en una instancia de recurso.

Tipo: Microsoft.OutlookServices.MentionsPreview

Propiedad	Tipo	Descripción
IsMentioned	Booleano	Verdadero si el usuario registrado se menciona en la instancia de recurso primario. Solo lectura. Admite el filtrado.

MessageRuleActions (versión preliminar)

Representa el conjunto de acciones que están disponibles para una regla.

Tipo: Microsoft.OutlookServices.MessageRuleActions

Propiedad	Tipo	Descripción
AssignCategories	Colección (String)	Lista de categorías que se asignarán a un mensaje.
CopyToFolder	Cadena	Identificador de la carpeta donde se va a copiar un mensaje.
Eliminar	Booleano	Indica si un mensaje se debe mover a la carpeta Elementos eliminados.
ForwardAsAttachmentTo	Colección (Destinatario)	Direcciones de correo electrónico de los destinatarios a los que se debe reenviar un mensaje como datos adjuntos.
ForwardTo	Colección (Destinatario)	Direcciones de correo electrónico de los destinatarios a los que se debe reenviar un mensaje.
MarkAsRead	Booleano	Indica si un mensaje debe marcarse como leído.
MarkImportance	Importancia	Establece la importancia del mensaje, que puede ser: Low, Normal o High.
MoveToFolder	Cadena	Identificador de la carpeta a la que se moverá un mensaje.
PermanentDelete	Booleano	Indica si un mensaje se debe eliminar permanentemente sin guardarse en la carpeta Elementos eliminados.
RedirectTo	Recipient	Dirección de correo electrónico a la que se debe redirigir un mensaje.
StopProcessingRules	Booleano	Indica si se deben evaluar las reglas siguientes.

MessageRulePredicates (versión preliminar)

Representa el conjunto de condiciones y excepciones que están disponibles para una regla.

Tipo: Microsoft.OutlookServices.MessageRulePredicates

Propiedad	Tipo	Descripción
BodyContains	Colección (String)	Representa las cadenas que deben aparecer en el cuerpo de un mensaje entrante para que se aplique la condición o excepción.
BodyOrSubjectContains	Colección (String)	Representa las cadenas que deben aparecer en el cuerpo o el asunto de un mensaje entrante para que se aplique la condición o excepción.
Categories	Colección (String)	Representa las categorías con las que debe etiquetarse un mensaje entrante para que se aplique la condición o excepción.
FromAddresses	Colección (Destinatario)	Representa las direcciones de correo electrónico específicas de un de un mensaje entrante para que se aplique la condición o excepción.
HasAttachments	Booleano	Indica si un mensaje entrante debe tener datos adjuntos para que se aplique la condición o excepción.
HeaderContains	Colección (String)	Representa las cadenas que deben aparecer en los encabezados de un mensaje entrante para que se aplique la condición o excepción.
Importancia	Importancia	Importancia que se marca en un mensaje entrante para que se aplique la condición o excepción: , oLow Normal High
IsApprovalRequest	Booleano	Indica si un mensaje entrante debe ser una solicitud de aprobación para que se aplique la condición o excepción.
IsAutomaticForward	Booleano	Indica si un mensaje entrante debe reenviarse automáticamente para que se aplique la condición o excepción.
IsAutomaticReply	Booleano	Indica si un mensaje entrante debe ser una respuesta automática para que se aplique la condición o excepción.
IsEncrypted	Booleano	Indica si un mensaje entrante debe estar cifrado para que se aplique la condición o excepción.
IsMeetingRequest	Booleano	Indica si un mensaje entrante debe ser una convocatoria de reunión para que se aplique la condición o excepción.
IsMeetingResponse	Booleano	Indica si un mensaje entrante debe ser una respuesta a la reunión para que se aplique la condición o excepción.
IsNonDeliveryReport	Booleano	Indica si un mensaje entrante debe ser un informe de no entrega para que se aplique la condición o excepción.
IsPermissionControlled	Booleano	Indica si un mensaje entrante debe estar controlado por permisos (protegido por RMS) para que se aplique la condición o excepción.
IsReadReceipt	Booleano	Indica si un mensaje entrante debe ser una confirmación de lectura para que se aplique la condición o excepción.
IsSigned	Booleano	Indica si un mensaje entrante debe estar firmado con S/MIME para que se aplique la condición o excepción.
IsVoicemail	Booleano	Indica si un mensaje entrante debe ser un correo de voz para que se aplique la condición o excepción.
MessageActionFlag	MessageActionFlag	Representa el valor de marca de acción que aparece en un mensaje entrante para que se aplique la condición o excepción.
NotSentToMe	Booleano	Indica si el propietario del buzón no debe ser un destinatario de un mensaje entrante para que se aplique la condición o excepción.
ReceipentContains	Colección (String)	Representa las cadenas que aparecen en las propiedades ToRecipients o CcRecipients de un mensaje entrante para que se aplique la condición o excepción.
SenderContains	Colección (String)	Representa las cadenas que aparecen en la propiedad From de un mensaje entrante para que se aplique la condición o excepción.
Confidencialidad	Confidencialidad	Representa el nivel de confidencialidad que debe marcarse en un mensaje entrante para que se aplique la condición o excepción. Los valores posibles son: Normal, Personal, Private y Confidential.
SentCcMe	Booleano	Indica si el propietario del buzón debe estar en la propiedad CcRecipients de un mensaje entrante para que se aplique la condición o excepción.
SentOnlyToMe	Booleano	Indica si el propietario del buzón debe ser el único destinatario de un mensaje entrante para que se aplique la condición o excepción.
SentToAddresses	Colección (Destinatario)	Representa las direcciones de correo electrónico a las que debe enviarse un mensaje entrante para que se aplique la condición o excepción.
SentToMe	Booleano	Indica si el propietario del buzón debe estar en la propiedad ToRecipients de un mensaje entrante para que se aplique la condición o excepción.
SentToOrCcMe	Booleano	Indica si el propietario del buzón debe estar en una propiedad ToRecipients o CcRecipients de un mensaje entrante para que se aplique la condición o excepción.
SubjectContains	Colección (String)	Representa las cadenas que aparecen en el asunto de un mensaje entrante para que se aplique la condición o excepción.
WithinSizeRange	SizeRange	Especifica los tamaños máximo y mínimo (en kilobytes) en que un mensaje entrante debe estar comprendido para que una condición o excepción se aplique.

PatternedRecurrence

Patrón e intervalo de periodicidad.

Tipo: Microsoft.OutlookServices.PatternedRecurrence

Propiedad	Tipo	Descripción
Patrón	RecurrencePattern	Frecuencia de un evento.
RecurrenceTimeZone	Cadena	La zona horaria de las horas de inicio y fin. Consulte el tipo complejo DateTimeTimeZone para obtener la lista de zonas horarias admitidas.
Range	RecurrenceRange	Duración de un evento.

Phone

Representa un número de teléfono.

Tipo: Microsoft.OutlookServices.Phone

Propiedad	Tipo	Descripción
Número	cadena	El número de teléfono.
Tipo	Cadena	El tipo de número de teléfono. Valores posibles: Home, Business, Mobile, Other, Assistant, HomeFax, BusinessFax, OtherFax, Pager, Radio.

PhysicalAddress

La dirección física de un contacto.

Tipo: Microsoft.OutlookServices.PhysicalAddress

Propiedad	Tipo	Descripción
Calle	Cadena	Calle.
Población	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 - Semanal. Debe establecer el DaysOfWeek y el FirstDayOfWeek - Diario. No se necesita información adicional del patrón.
Intervalo	Int32	Número de unidades de un tipo de periodicidad determinado entre repeticiones.
DayOfMonth	Int32	El día del mes en el que ocurre el elemento.
Mes	Int32	El mes en el 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.

SizeRange (versión preliminar)

Especifica los tamaños máximo y mínimo (en kilobytes) que un mensaje entrante debe tener para que una condición o excepción se aplique.

Tipo: Microsoft.OutlookServices.SizeRange

Propiedad	Tipo	Descripción
MaximumSize	Int32	Tamaño máximo (en kilobytes) que un mensaje entrante debe tener para que una condición o excepción se aplique.
MinimumSize	Int32	Tamaño mínimo (en kilobytes) que un mensaje entrante debe tener para que una condición o excepción se aplique.

TimeConstraint

Restringe las sugerencias de hora de reunión a ciertas horas y días de la semana según la naturaleza de la actividad especificada y las franjas horarias disponibles.

Tipo: Microsoft.OutlookServices.TimeConstraint

Propiedad	Tipo	Descripción
ActivityDomain	ActivityDomain	Opcional, la naturaleza de la actividad: Work, Personal, Unrestricted, o Unknown.
Timeslots	Colección(TimeSlot)	Matriz de periodos de tiempo.

TimeSlot

Un periodo de tiempo.

Tipo: Microsoft.OutlookServices.TimeSlot

Propiedad	Tipo	Descripción
Iniciar	DateTimeTimeZone	Comienza un periodo de tiempo.
End	DateTimeTimeZone	Finaliza un periodo de tiempo.

TimeZoneInformation (versión preliminar)

Representa una zona horaria. Los formatos admitidos Windows y la zona horaria de la Autoridad de números asignados de internet (IANA) (también conocida como zona horaria Olson).

Tipo: Microsoft.OutlookServices.TimeZoneInformation

Propiedad	Tipo	Descripción
Alias	Cadena	Identificador de la zona horaria.
DisplayName	Cadena	Cadena de visualización que representa la zona horaria.

Website (versión preliminar)

Representa un sitio web.

Tipo: Microsoft.OutlookServices.Website

Propiedad	Tipo	Descripción
Dirección	Cadena	La URL del sitio web.
DisplayName	Cadena	Nombre para mostrar del sitio web.
Tipo	WebsiteType	El tipo de sitio web comúnmente asociado con un contacto. Los valores posibles son: Blog, Home, Other, Profile y Work.

WorkingHours (versión preliminar)

Representa los días de la semana y las horas de la zona horaria específica en la que trabaja el usuario.

Tipo: Microsoft.OutlookServices.WorkingHours

Propiedad	Tipo	Descripción
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.
StartTime	Edm.TimeOfDay	Hora del día en la que el usuario empieza a trabajar.
EndTime	Edm.TimeOfDay	Hora del día en la que el usuario deja de trabajar.
TimeZone	Cadena	Zona horaria a la que se aplica el horario laboral. Consulte DateTimeTimeZone para obtener una lista de zonas horarias válidas.

Enumeraciones

• ActivityDomain
• AutomaticRepliesStatus
• CategoryColor (vista previa)
• DayOfWeek
• ExternalAudienceScope
• FollowupFlagStatus (vista previa)
• FreeBusyStatus
• InferenceClassificationType
• LocationType (vista previa)
• MailTipsType (vista previa)
• MessageActionFlag (vista previa)
• PhoneType (vista previa)
• RecipientScopeType (vista previa)
• ReferenceAttachmentPermissions
• ReferenceAttachmentProviders
• TaskStatus
• TimeZoneStandard
• WebsiteType

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)

ActivityDomain

La naturaleza de una actividad.

Valores admitidos:

• Trabajo
• Personal
• No restringido
• Desconocido

AutomaticRepliesStatus

El estado de configuración para enviar automáticamente una respuesta cuando el buzón del usuario recibe un mensaje.

Valores admitidos:

• AlwaysEnabled (siempre activado)
• Deshabilitado
• Programado

CategoryColor (versión preliminar)

El color que caracteriza una categoría en el buzón del usuario. El color real que representa cada constante preestablecida depende del cliente de Outlook que se utiliza para mostrar las categorías.

Valor admitido	Color asignado al cliente de escritorio de Outlook
Preset0	Rojo
Preset1	Naranja
Preset2	Marrón
Preset3	Amarillo
Preset4	Verde
Preset5	Verde azulado
Preset6	Oliva
Preset7	Azul
Preset8	Púrpura
Preset9	Arándano
Preset10	Acero
Preset11	Acero oscuro
Preset12	Gris
Preset13	Gris oscuro
Preset14	Negro
Preset15	Rojo oscuro
Preset16	Anaranjado oscuro
Preset17	Marrón oscuro
Preset18	Amarillo oscuro
Preset19	Verde oscuro
Preset20	Verde azulado oscuro
Preset21	Oliva oscuro
Preset22	Azul oscuro
Preset23	Púrpura oscuro
Preset24	Arándano oscuro
Ninguno	Ningún color asignado

ExternalAudienceScope

El conjunto de público externo al cual enviar el ExternalReplyMessage.

Valores admitidos:

• Todo
• ContactsOnly (solo contactos)
• Ninguno

FollowupFlagStatus (versión preliminar)

Representa el estado del indicador de seguimiento para una instancia de recurso.

Valores admitidos:

• Completar
• Flagged (marcado)
• NotFlagged (sin marcar)

InferenceClassificationType

Representa la relevancia inferida de un mensaje en el que el usuario se debe concentrar.

Valores admitidos:

• Prioritarios
• Otro

LocationType (versión preliminar)

Los posibles tipos de ubicaciones.

Valores admitidos:

• Default (predeterminado)
• ConferenceRoom (sala de conferencias)
• HomeAddress (dirección particular)
• BusinessAddress (dirección comercial)
• GeoCoordinates (coordenadas geográficas)
• StreetAddress (dirección de la calle)
• Hotel
• Restaurant (restaurante)
• LocalBusiness (negocio local)
• PostalAddress (dirección postal)

MailTipsType (versión preliminar)

Una enumeración de marcas que representa las sugerencias de mensajes de correo solicitadas.

Valores admitidos:

• AutomaticReplies (respuestas automáticas)
• CustomMailTip (sugerencia de correo personalizada)
• DeliveryRestriction (restricción en la entrega)
• ExternalMemberCount (cantidad de miembros externos)
• MailboxFullStatus (estado de buzón lleno)
• MaxMessageSize
• ModerationStatus (estado de moderación)
• RecipientScope (ámbito de destinatarios)
• RecipientSuggestions (sugerencias de destinatarios)
• TotalMemberCount

MessageActionFlag (versión preliminar)

Especifica la acción que debe tomarse para un mensaje.

Valores admitidos:

• Cualquiera
• Llamada
• DoNotForward (no reenviar)
• FollowUp (seguimiento)
• FYI (para su información)
• Forward (reenviar)
• NoResponseNecessary (respuesta no necesaria)
• Lectura
• Responder
• ReplyToAll (responder a todos)
• Revisión

PhoneType (versión preliminar)

El tipo de números de teléfono comúnmente asociados con un contacto.

Valores admitidos:

• Assistant (asistente)
• Negocio
• BusinessFax (fax de empresa)
• Personal
• HomeFax (fax personal)
• Móvil
• Otro
• OtherFax (otro fax)
• Buscapersonas
• Radio

RecipientScopeType (versión preliminar)

Una enumeración de indicadores que representa los tipos de ámbitos de destinatario. Los administradores utilizan los ámbitos de los destinatarios para especificar que ciertas sugerencias de correo electrónico sean accesibles solo para un determinado ámbito.

Valores admitidos:

• Ninguno
• Interno
• Externo
• ExternalPartner (socio externo)
• ExternalNonPartner (externo no socio)

ReferenceAttachmentPermissions

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

Valores admitidos:

• Otro
• Vista
• 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

Confidencialidad

Indica el nivel de privacidad.

Valores admitidos:

• Importance
• Personal
• Privado
• Confidencial

TaskStatus

Especifica el estado o el progreso de una tarea.

Valores admitidos:

• Completadas
• Diferido
• InProgress
• NotStarted (no empezada)
• WaitingOnOthers (esperando a otras)

TimeZoneStandard (versión preliminar)

El formato para expresar zonas horarias.

Valores admitidos:

• Windows
• Iana

WebsiteType (versión preliminar)

Especifica el tipo de sitio web comúnmente asociado con un contacto.

Valores admitidos:

• Blog
• Personal
• Otro
• Perfil
• Trabajo

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 para paginar resultados

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

• $count para obtener el recuento de las entidades de 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.
Categoría	Busca en el campo Category.
CC	Busca en el campo Cc.
De	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.
Remitente	Busca en el campo Sender.
Asunto	Busca en el campo Subject.
A	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/beta/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/beta/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/beta/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/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

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	ReceivedDateTime gt 2014-09-01T00:00:00Z
ge	Mayor o igual que	LastModifiedDateTime ge 2014-09-01T00:00:00Z
lt	Menor que	ReceivedDateTime lt 2014-09-01T00:00:00Z
le	Menor o igual que	LastModifiedDateTime le 2014-09-01T00:00:00Z

Use comillas simples (') para delimitar cualquier valor de cadena dentro del 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 predeterminado del usuario que comienzan en o después de una fecha específica, puede filtrar en la propiedad Start.

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

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/beta/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/beta/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/beta/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/beta/me/messages?$filter=ReceivedDateTime 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/beta/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/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

Seleccionar propiedades específicas para devolver

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

El siguiente ejemplo obtiene las propiedades asunto, remitente y ReceivedDateTime para todos los mensajes en la Bandeja de entrada.

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

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 que no se puede usar el parámetro de consultas $orderby con $search.

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

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

El mismo ejemplo con codificación de URL:

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

Paginar resultados

Por defecto, una solicitud GET en una propiedad mensajes 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/beta/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/beta/me/messages?$top=5&$skip=5

La paginación se obtiene 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/beta/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/beta/me/messages/$count?$filter=IsRead eq false

El mismo ejemplo con codificación de URL.

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

• Devolver las propiedades de asunto, remitente y ReceivedDateTime.

• Devuelve solo los primeros cinco mensajes.

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

Al especificar $filter, el servidor inferirá un orden de clasificación para los resultados. Si usa $filter y $orderby a la vez, las propiedades en el $filter deben aparecer en primer lugar en la $orderby antes de otras propiedades y en el orden en el 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/beta/me/messages?
    $filter=Subject eq 'Good Times' AND Importance eq 'High'&
    $orderby=Subject,Importance,Sender

Este es el mismo ejemplo con codificación URL y sin saltos de línea.

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

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