Table of contents
TOC
Collapse the table of content
Expand the table of content
Última actualización: 29/06/2018

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

Esta documentación trata de recursos nuevos o modificados para múltiples ubicaciones de eventos, uso compartido de calendario, menciones @, respuestas rápidas, idioma y opciones de zona horaria que están marcadas como "(versión preliminar)". Las características de la versión preliminar están sujetas a cambios antes de la finalización, y pueden romper el código que las use. Por ello, en general, debería utilizar solo una versión de producción de una API en su código de producción. Si está disponible, la versión 2.0 es actualmente la versión preferida.

La versión 1.0 de la API de REST de Outlook está obsoleta. A partir del 1 de noviembre de 2018, las aplicaciones ya no podrán utilizar la autenticación básica con el extremo REST versión 1.0 (https://outlook.office.com/api/v1.0)). El 1 de noviembre de 2019, el extremo REST versión 1.0 se retirará completamente y la documentación de la versión 1.0 se eliminará poco después. Comience a migrar su aplicación para utilizar la API de REST de Outlook en versión 1.0 de Microsoft Graph. Vea más detalles en nuestro anuncio.

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

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

Nota Para simplificar la referencia, en el resto de este artículo se utiliza "Outlook.com" para incluir estos dominios de cuenta Microsoft.

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? Utilice el control en la esquina superior derecha y seleccione la versión que desee.

¿No está interesado en la versión 2.0 de la API? Utilice el control en la esquina superior derecha y seleccione la versión que desee.

¿No está interesado en la versión 1.0 de la API? Utilice el control en la esquina superior derecha y seleccione la versión que desee.

Recursos de las API de REST

Consejo Puede ver el documento de metadatos completo para el modelo de datos de la entidad Correo, Calendario, Contactos y Tarea navegando hasta el extremo $metadata en un explorador web (ejemplo: https://outlook.office.com/api/beta/$metadata).

Consejo Puede ver el documento de metadatos completo para el modelo de datos de la entidad Correo, Calendario, Contactos y Tarea navegando hasta el extremo $metadata en un explorador web (ejemplo: https://outlook.office.com/api/v2.0/$metadata).

Consejo Puede ver el documento de metadatos completo para el modelo de datos de la entidad Correo, Calendario, Contactos y Tarea navegando hasta el extremo $metadata en un explorador web (ejemplo: https://outlook.office.com/api/v1.0/$metadata).

Attachment

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 fileAttachment, itemAttachment y referenceAttachment correspondientes se derivan del recurso Attachment.

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

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

Tipo: Microsoft.OutlookServices.Entity

PropiedadTipoDescripción¿Se puede escribir?¿Se puede filtrar?
ContentTypeCadenaEl tipo MIME del archivo adjunto.No
IsInlineBooleanotrue si los datos adjuntos son datos adjuntos insertados; de lo contrario, false.
LastModifiedDateTimeDateTimeOffsetLa 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
NameCadenaNombre para mostrar de los datos adjuntos. Esto no necesita ser el nombre real del archivo.
SizeInt32La longitud en bytes de los datos adjuntos.NoNo

Calendar

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.

PropiedadTipoDescripción¿Se puede escribir?¿Se puede filtrar?
CanEditBooleanoEs 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
CanShareBooleanoEs 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
CanViewPrivateItemsBooleanoEs verdadero si el usuario puede leer elementos del calendario que se marcaron como privados; de lo contrario, es falso.No
ChangeKeyCadenaIdentifica 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.NoNo
ColorCalendarColorEspecifica 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
IdCadenaEl identificador exclusivo del calendario.NoNo
IsDefaultCalendarBooleanoEs verdadero si este calendario es el calendario predeterminado del usuario, de lo contrario es falso.
IsSharedBooleanoVerdadero 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
IsSharedWithMeBooleanoVerdadero 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
NameCadenaEl nombre del calendario.
OwnerEmailAddressSi 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
CalendarViewColección(Event)La vista calendario del calendario. Propiedad de navegación.NoNo
EventosColección(Event)Los eventos en el calendario. Propiedad de navegación.NoNo
MultiValueExtendedPropertiesUna colecciónUna colección de propiedades extendidas multivalor de tipo MultiValueLegacyExtendedProperty. Es una propiedad de navegación. Vea más información sobre propiedades extendidas.
SingleValueExtendedPropertiesUna colecciónUna colección de propiedades extendidas de un solo valor SingleValueLegacyExtendedProperty. Es una propiedad de navegación. Vea más información sobre propiedades extendidas.
PropiedadTipoDescripción¿Se puede escribir?¿Se puede filtrar?
CanEditBooleanoEs 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
CanShareBooleanoEs 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
CanViewPrivateItemsBooleanoEs verdadero si el usuario puede leer elementos del calendario que se marcaron como privados; de lo contrario, es falso.No
ChangeKeyCadenaIdentifica 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.NoNo
ColorCalendarColorEspecifica 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
IdCadenaEl identificador exclusivo del calendario.NoNo
NameCadenaEl nombre del calendario.
OwnerEmailAddressSi 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
CalendarViewColección(Event)La vista calendario del calendario. Propiedad de navegación.NoNo
EventosColección(Event)Los eventos en el calendario. Propiedad de navegación.NoNo
MultiValueExtendedPropertiesUna colecciónUna colección de propiedades extendidas multivalor de tipo MultiValueLegacyExtendedProperty. Es una propiedad de navegación. Vea más información sobre propiedades extendidas.
SingleValueExtendedPropertiesUna colecciónUna colección de propiedades extendidas de un solo valor SingleValueLegacyExtendedProperty. Es una propiedad de navegación. Vea más información sobre propiedades extendidas.
PropiedadTipoDescripción¿Se puede escribir?¿Se puede filtrar?
NameCadenaEl nombre del calendario.
ChangeKeyCadenaIdentifica 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.NoNo
ColorCalendarColorEspecifica 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
IdCadenaEl identificador exclusivo del calendario.NoNo
CalendarViewColección(Event)La vista calendario del calendario. Propiedad de navegación.NoNo
EventosColección(Event)Los eventos en el calendario. Propiedad de navegación.NoNo

CalendarGroup

Un grupo de calendarios.

Nota Outlook.com solo admite el grupo de calendarios predeterminado al que se puede acceder mediante el acceso directo ../me/calendars. No puede eliminar ese 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.

PropiedadTipoDescripción¿Se puede escribir?¿Se puede filtrar?
NameCadenaNombre del grupo.
ChangeKeyCadenaIdentifica 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.NoNo
ClassIdCadenaEl identificador de clase.No
IdCadenaEl identificador exclusivo del grupo de calendarios.NoNo
CalendariosColección(Calendar)Los calendarios en el grupo de calendarios. Propiedad de navegación.NoNo

Contact

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.

PropiedadTipoDescripción¿Se puede escribir?¿Se puede filtrar?
AssistantNameCadenaEl nombre del ayudante del contacto.
BirthdaydatetimeoffsetEl cumpleaños del contacto.
CategoriesColección(String)Las categorías asociadas con el contacto.No
ChangeKeyCadenaIdentifica 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.NoNo
ChildrenColección(String)Los nombres de los hijos del contacto.
CompanyNameCadenaEl nombre de la empresa del contacto.
CreatedDateTimedatetimeoffsetLa hora en que se creó el contacto.No
DepartmentCadenaEl departamento del contacto.
DisplayNameCadenaEl nombre para mostrar del contacto.
EmailAddressesColección(EmailAddress)Las direcciones de correo electrónico del contacto.No
ExtensionsColección(Extension)La colección de extensiones de datos de tipo abierto definidas para el contacto. Propiedad de navegación.No
FileAsCadenaEl nombre con el que se ha archivado el contacto.
FlagFollowupFlagInformación sobre cualquier seguimiento del contacto.
GenderCadenaEl género del contacto.
GenerationCadenaLa generación del contacto.
GivenNameCadenaEl nombre del contacto.
IdCadenaEl identificador exclusivo del contacto.NoNo
ImAddressesColección(String)Las direcciones de mensajería instantánea (MI) del contacto.No
InitialsCadenaLas iniciales del contacto.
JobTitleCadenaEl puesto del contacto.
LastModifiedDateTimedatetimeoffsetLa hora en que se modificó el contacto.No
ManagerCadenaEl nombre del administrador del contacto.
MiddleNameCadenaEl segundo nombre del contacto.
NickNameCadenaEl sobrenombre del contacto.
OfficeLocationCadenaLa ubicación de la oficina del contacto.
ParentFolderIdCadenaEl identificador de la carpeta principal del contacto.NoNo
PersonalNotesCadenaLas notas del usuario sobre el contacto.
PhonesColección(Phone)Números de teléfono asociados con el contacto, por ejemplo, teléfono residencial, teléfono móvil y teléfono comercial.
PostalAddressesColección PhysicalAddressDirecciones asociadas con el contacto, por ejemplo, dirección particular y dirección comercial.No
ProfessionCadenaLa profesión del contacto.
SpouseNameCadenaEl nombre del cónyuge del contacto.
SurnameCadenaLos apellidos del contacto.
TitleCadenaEl título del contacto.No
Sitios webColección(Website)Sitios web asociados con el contacto.No
WeddingAnniversaryFechaEl aniversario de bodas del contacto.
YomiCompanyNameCadenaEl nombre fonético japonés de la empresa del contacto. Esta propiedad es opcional.No
YomiGivenNameCadenaEl nombre (nombre de pila) fonético japonés del contacto. Esta propiedad es opcional.No
YomiSurnameCadenaEl apellido fonético japonés del contacto. Esta propiedad es opcional.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, consulte API de REST de propiedades extendidas.

PropiedadTipoDescripción¿Se puede escribir?¿Se puede filtrar?
AssistantNameCadenaEl nombre del ayudante del contacto.
BirthdaydatetimeoffsetEl cumpleaños del contacto.
BusinessAddressPhysicalAddressLa dirección del trabajo del contacto.
BusinessHomePageCadenaLa página principal de la empresa del contacto.
BusinessPhonesColección(String)Los números de teléfono del trabajo del contacto.No
CategoriesColección(String)Las categorías asociadas con el contacto.No
ChangeKeyCadenaIdentifica 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.NoNo
ChildrenColección(String)Los nombres de los hijos del contacto.
CompanyNameCadenaEl nombre de la empresa del contacto.
DepartmentCadenaEl departamento del contacto.
CreatedDateTimedatetimeoffsetLa hora en que se creó el contacto.No
LastModifiedDateTimedatetimeoffsetLa hora en que se modificó el contacto.No
DisplayNameCadenaEl nombre para mostrar del contacto.
EmailAddressesColección(EmailAddress)Las direcciones de correo electrónico del contacto.No
ExtensionsColección(Extension)La colección de extensiones de datos de tipo abierto definidas para el contacto. Propiedad de navegación.No
FileAsCadenaEl nombre con el que se ha archivado el contacto.
GenerationCadenaLa generación del contacto.
GivenNameCadenaEl nombre del contacto.
HomeAddressPhysicalAddressLa dirección particular del contacto.
HomePhonesColección(String)Los números de teléfono particular del contacto.No
IdCadenaEl identificador exclusivo del contacto.NoNo
ImAddressesColección(String)Las direcciones de mensajería instantánea (MI) del contacto.No
InitialsCadenaLas iniciales del contacto.
JobTitleCadenaEl puesto del contacto.
ManagerCadenaEl nombre del administrador del contacto.
MiddleNameCadenaEl segundo nombre del contacto.
MobilePhone1CadenaEl número de teléfono móvil del contacto.
NickNameCadenaEl sobrenombre del contacto.
OfficeLocationCadenaLa ubicación de la oficina del contacto.
OtherAddressPhysicalAddressOtras direcciones del contacto.
ParentFolderIdCadenaEl identificador de la carpeta principal del contacto.NoNo
PersonalNotesCadenaLas notas del usuario sobre el contacto.
ProfessionCadenaLa profesión del contacto.
SpouseNameCadenaEl nombre del cónyuge del contacto.
SurnameCadenaLos apellidos del contacto.
TitleCadenaEl título del contacto.No
YomiCompanyNameCadenaEl nombre fonético japonés de la empresa del contacto.No
YomiGivenNameCadenaEl nombre (nombre de pila) fonético japonés del contacto.No
YomiSurnameCadenaEl apellido fonético japonés del contacto.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, consulte API de REST de propiedades extendidas.

PropiedadTipoDescripción¿Se puede escribir?¿Se puede filtrar?
AssistantNameCadenaEl nombre del ayudante del contacto.
BirthdaydatetimeoffsetEl cumpleaños del contacto.
BusinessAddressPhysicalAddressLa dirección del trabajo del contacto.
BusinessHomePageCadenaLa página principal de la empresa del contacto.
BusinessPhonesColección(String)Los números de teléfono del trabajo del contacto.No
CategoriesColección(String)Las categorías asociadas con el contacto.No
ChangeKeyCadenaIdentifica 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.NoNo
ChildrenColección(String)Los nombres de los hijos del contacto.
CompanyNameCadenaEl nombre de la empresa del contacto.
DepartmentCadenaEl departamento del contacto.
DateTimeCreateddatetimeoffsetLa hora en que se creó el contacto.No
DateTimeLastModifieddatetimeoffsetLa hora en que se modificó el contacto.No
DisplayNameCadenaEl nombre para mostrar del contacto.
EmailAddressesColección(EmailAddress)Las direcciones de correo electrónico del contacto.No
FileAsCadenaEl nombre con el que se ha archivado el contacto.
GenerationCadenaLa generación del contacto.
GivenNameCadenaEl nombre del contacto.
HomeAddressPhysicalAddressLa dirección particular del contacto.
HomePhonesColección(String)Los números de teléfono particular del contacto.No
IdCadenaEl identificador exclusivo del contacto.NoNo
ImAddressesColección(String)Las direcciones de mensajería instantánea (MI) del contacto.No
InitialsCadenaLas iniciales del contacto.
JobTitleCadenaEl puesto del contacto.
ManagerCadenaEl nombre del administrador del contacto.
MiddleNameCadenaEl segundo nombre del contacto.
MobilePhone1CadenaEl número de teléfono móvil del contacto.
NickNameCadenaEl sobrenombre del contacto.
OfficeLocationCadenaLa ubicación de la oficina del contacto.
OtherAddressPhysicalAddressOtras direcciones del contacto.
ParentFolderIdCadenaEl identificador de la carpeta principal del contacto.NoNo
PersonalNotesCadenaLas notas del usuario sobre el contacto.
ProfessionCadenaLa profesión del contacto.
SpouseNameCadenaEl nombre del cónyuge del contacto.
SurnameCadenaLos apellidos del contacto.
TitleCadenaEl título del contacto.No
YomiCompanyNameCadenaEl nombre fonético japonés de la empresa del contacto. Esta propiedad es opcional.No
YomiGivenNameCadenaEl nombre (nombre de pila) fonético japonés del contacto. Esta propiedad es opcional.No
YomiSurnameCadenaEl apellido fonético japonés del contacto. Esta propiedad es opcional.No

ContactFolder

Una carpeta que contiene contactos.

Tipo: Microsoft.OutlookServices.ContactFolder

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

Consulte Operaciones ContactFolder para ver las acciones admitidas.

PropiedadTipoDescripción¿Se puede escribir?¿Se puede filtrar?
ChildFoldersColección(ContactFolder)La colección de carpetas secundarias en la carpeta. Propiedad de navegación.NoNo
ContactsColección(Contact)Los contactos en la carpeta. Propiedad de navegación.NoNo
DisplayNameCadenaEl nombre para mostrar de la carpeta.
IdCadenaIdentificador exclusivo de la carpeta de contactos.NoNo
ParentFolderIdCadenaEl identificador de la carpeta principal de la carpeta.NoNo
WellKnownNameCadenaEl nombre de la carpeta si la carpeta es una carpeta reconocida. Actualmente contacts es la única carpeta de contactos reconocida.NoNo
MultiValueExtendedPropertiesUna colecciónUna colección de propiedades extendidas multivalor de tipo MultiValueLegacyExtendedProperty. Es una propiedad de navegación. Vea más información sobre propiedades extendidas.
SingleValueExtendedPropertiesUna colecciónUna colección de propiedades extendidas de un solo valor SingleValueLegacyExtendedProperty. Es una propiedad de navegación. Vea más información sobre propiedades extendidas.
PropiedadTipoDescripción¿Se puede escribir?¿Se puede filtrar?
ChildFoldersColección(ContactFolder)La colección de carpetas secundarias en la carpeta. Propiedad de navegación.NoNo
ContactsColección(Contact)Los contactos en la carpeta. Propiedad de navegación.NoNo
DisplayNameCadenaEl nombre para mostrar de la carpeta.
IdCadenaIdentificador exclusivo de la carpeta de contactos.NoNo
ParentFolderIdCadenaEl identificador de la carpeta principal de la carpeta.NoNo
MultiValueExtendedPropertiesUna colecciónUna colección de propiedades extendidas multivalor de tipo MultiValueLegacyExtendedProperty. Es una propiedad de navegación. Vea más información sobre propiedades extendidas.
SingleValueExtendedPropertiesUna colecciónUna colección de propiedades extendidas de un solo valor SingleValueLegacyExtendedProperty. Es una propiedad de navegación. Vea más información sobre propiedades extendidas.
PropiedadTipoDescripción¿Se puede escribir?¿Se puede filtrar?
ChildFoldersColección(ContactFolder)La colección de carpetas secundarias en la carpeta. Propiedad de navegación.NoNo
ContactsColección(Contact)Los contactos en la carpeta. Propiedad de navegación.NoNo
DisplayNameCadenaEl nombre para mostrar de la carpeta.
IdCadenaIdentificador exclusivo de la carpeta de contactos.NoNo
ParentFolderIdCadenaEl identificador de la carpeta principal de la carpeta.NoNo

Event

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.

PropiedadTipoDescripción¿Se puede escribir?¿Se puede filtrar?
AttachmentsColección(Attachment)La colección de datos adjuntos FileAttachment, ItemAttachment, yReferenceAttachment para el evento. Propiedad de navegación.NoNo
AttendeesColección(Attendee)La colección de asistentes del evento.No
BodyItemBodyEl cuerpo del mensaje asociado con el evento.No
BodyPreviewCadenaLa vista previa del mensaje asociado al evento.NoNo
CalendarCalendarEl calendario que contiene el evento. Propiedad de navegación.NoNo
CategoriesColección(String)Las categorías asociadas con el evento.No
ChangeKeyCadenaIdentifica 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.NoNo
CreatedDateTimedatetimeoffsetLa fecha y hora en que se creó el evento.No
EndDateTimeTimeZoneLa fecha y hora en que finaliza el evento.
ExtensionsColección(Extension)La colección de extensiones de datos de tipo abierto definidas para el evento. Propiedad de navegación.No
HasAttachmentsbooleanoSe establece como verdadero si el evento tiene datos adjuntos.No
IdCadenaEl identificador exclusivo del evento.NoNo
ImportanceImportanceLa importancia del evento: Low, Normal, High.
InstancesColección(Event)Las instancias del evento. Propiedad de navegación.NoNo
iCalUIDCadenaUn identificador único que comparten todas las instancias de un evento a través de calendarios diferentes.No
IsAllDaybooleanoSe establece en verdadero si el evento dura todo el día. Ajustar esta propiedad requiere ajustar las propiedades Start y End del evento también.
IsCancelledbooleanoSe establece como verdadero si el evento ha sido cancelado.
IsOrganizerbooleanoSe establece como verdadero si el remitente del mensaje también es el organizador.
IsReminderOnBooleanoSe establece en verdadero si se establece una alerta para recordarle el evento al usuario.
LastModifiedDateTimedatetimeoffsetLa fecha y hora en que el evento fue modificado por última vez.No
LocationLocationInformación de ubicación del evento.
LocationsColección(Location)Las ubicaciones donde se celebra el evento o en las que se asiste.
OnlineMeetingUrlCadenaUna dirección URL para una reunión en línea.No
OrganizadorRecipientEl organizador del evento.
OriginalEndTimeZoneCadenaZona horaria de finalización que se estableció cuando se creó el evento. Consulte DateTimeTimeZone para obtener una lista de zonas horarias válidas.No
OriginalStartTimeZoneCadenaLa zona horaria de inicio que se estableció cuando se creó el evento. Consulte DateTimeTimeZone para obtener una lista de zonas horarias válidas.No
RecurrencePatternedRecurrenceEl patrón de periodicidad del evento.No
ReminderMinutesBeforeStartInt32El número de minutos antes de la hora de inicio del evento en que se producirá la alerta del recordatorio.No
ResponseRequestedbooleanoSe establece en verdadero si el remitente quiere una respuesta cuando el evento se acepta o rechaza.
ResponseStatusResponseStatusIndica el tipo de respuesta que se envía en respuesta a un mensaje de evento.No
SensitivitySensitivityIndica el nivel de privacidad del evento: Normal, Personal, Private, Confidential.
SeriesMasterIdCadenaLas categorías asignadas al elemento.No
ShowAsFreeBusyStatusEl estado para mostrar: Free, Tentative, Busy, Oof, WorkingElsewhere, Unknown.
StartDateTimeTimeZoneLa hora de inicio del evento.
SubjectCadenaEl texto de la línea de asunto del evento.
TipoEventTypeEl tipo de evento: SingleInstance, Occurrence, Exception, SeriesMaster.
WebLinkCadenaLa 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.
NoNo

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, consulte API de REST de propiedades extendidas.

PropiedadTipoDescripción¿Se puede escribir?¿Se puede filtrar?
AttachmentsColección(Attachment)La colección de datos adjuntos FileAttachment, ItemAttachment, yReferenceAttachment para el evento. Propiedad de navegación.NoNo
AttendeesColección(Attendee)La colección de asistentes del evento.No
BodyItemBodyEl cuerpo del mensaje asociado con el evento.No
BodyPreviewCadenaLa vista previa del mensaje asociado al evento.NoNo
CalendarCalendarEl calendario que contiene el evento. Propiedad de navegación.NoNo
CategoriesColección(String)Las categorías asociadas con el evento.No
ChangeKeyCadenaIdentifica 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.NoNo
CreatedDateTimedatetimeoffsetLa fecha y hora en que se creó el evento.No
LastModifiedDateTimedatetimeoffsetLa fecha y hora en que el evento fue modificado por última vez.No
EndDateTimeTimeZoneHora de finalización del evento.
ExtensionsColección(Extension)La colección de extensiones de datos de tipo abierto definidas para el evento. Propiedad de navegación.No
HasAttachmentsbooleanoSe establece como verdadero si el evento tiene datos adjuntos.No
IdCadenaEl identificador exclusivo del evento.NoNo
ImportanceImportanceLa importancia del evento: Low, Normal, High.
InstancesColección(Event)Las instancias del evento. Propiedad de navegación.NoNo
iCalUIDCadenaUn identificador único que comparten todas las instancias de un evento a través de calendarios diferentes.No
IsAllDaybooleanoSe establece en verdadero si el evento dura todo el día. Ajustar esta propiedad requiere ajustar las propiedades Start y End del evento también.
IsCancelledbooleanoSe establece como verdadero si el evento ha sido cancelado.
IsOrganizerbooleanoSe establece como verdadero si el remitente del mensaje también es el organizador.
IsReminderOnBooleanoSe establece en verdadero si se establece una alerta para recordarle el evento al usuario.
LocationLocationLa ubicación del evento.
OnlineMeetingUrlCadenaUna dirección URL para una reunión en línea.No
OrganizadorRecipientEl organizador del evento.
OriginalEndTimeZoneCadenaZona horaria de finalización que se estableció cuando se creó el evento. Consulte DateTimeTimeZone para obtener una lista de zonas horarias válidas.No
OriginalStartTimeZoneCadenaLa zona horaria de inicio que se estableció cuando se creó el evento. Consulte DateTimeTimeZone para obtener una lista de zonas horarias válidas.No
RecurrencePatternedRecurrenceEl patrón de periodicidad del evento.No
ReminderMinutesBeforeStartInt32El número de minutos antes de la hora de inicio del evento en que se producirá la alerta del recordatorio.No
ResponseRequestedbooleanoSe establece en verdadero si el remitente quiere una respuesta cuando el evento se acepta o rechaza.
ResponseStatusResponseStatusIndica el tipo de respuesta que se envía en respuesta a un mensaje de evento.No
SensitivitySensitivityIndica el nivel de privacidad del evento: Normal = 0, Personal = 1, Private = 2, Confidential = 3.
SeriesMasterIdCadenaLas categorías asignadas al elemento.No
ShowAsFreeBusyStatusEl estado que se mostrará: Free = 0, Tentative = 1, Busy = 2, Oof = 3, WorkingElsewhere = 4, Unknown = -1.
StartDateTimeTimeZoneLa hora de inicio del evento.
TipoEventTypeEl tipo de evento: SingleInstance = 0, Occurrence = 1, Exception = 2, SeriesMaster = 3.
WebLinkCadenaLa 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.
NoNo

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, consulte API de REST de propiedades extendidas.

PropiedadTipoDescripción¿Se puede escribir?¿Se puede filtrar?
AttachmentsColección(Attachment)La colección de datos adjuntos FileAttachment y ItemAttachment para el evento. Propiedad de navegación.NoNo
AttendeesColección(Attendee)La colección de asistentes del evento.No
BodyItemBodyEl cuerpo del mensaje asociado con el evento.No
BodyPreviewCadenaLa vista previa del mensaje asociado al evento.NoNo
CalendarCalendarEl calendario que contiene el evento. Propiedad de navegación.NoNo
CategoriesColección(String)Las categorías asociadas con el evento.No
ChangeKeyCadenaIdentifica 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.NoNo
DateTimeCreateddatetimeoffsetLa fecha y hora en que se creó el evento.No
DateTimeLastModifieddatetimeoffsetLa fecha y hora en que el evento fue modificado por última vez.No
EnddatetimeoffsetLa fecha y hora en que finaliza el evento.

De manera predeterminada, la hora de finalización está en formato UTC. Puede especificar una zona horaria opcional en EndTimeZone, expresar la hora de finalización en esa zona horaria e incluir una diferencia horaria de UTC. Tenga en cuenta que, si usa EndTimeZone, debe especificar también un valor para StartTimeZone.

En este ejemplo, se especifica el 25 de febrero de 2015, a las 21:34 en hora estándar del Pacífico: "2015-02-25T21:34:00-08:00".
EndTimeZoneCadenaIdentifica la zona horaria de la reunión para la hora de finalización de la reunión (ver la propiedad End). Esta propiedad se establece con el nombre de la zona horaria tal como está almacenada en Windows. Puede obtener los nombres de zona horaria llamando a System.TimeZoneInfo.GetSystemTimeZones().

Esta propiedad es opcional para la versión 1.0. Sin embargo, esta propiedad se debe usar si se usa la propiedad StartTimeZone.

Consulte TimeZone para más información.
No
HasAttachmentsbooleanoSe establece como verdadero si el evento tiene datos adjuntos.No
IdCadenaEl identificador exclusivo del evento.NoNo
ImportanceImportanceLa importancia del evento: Low, Normal, High.
InstancesColección(Event)Las instancias del evento. Propiedad de navegación.NoNo
iCalUIDCadenaUn identificador único que comparten todas las instancias de un evento a través de calendarios diferentes.No
IsAllDaybooleanoSe establece en verdadero si el evento dura todo el día. Ajustar esta propiedad requiere ajustar las propiedades Start y End del evento también.
IsCancelledbooleanoSe establece como verdadero si el evento ha sido cancelado.
IsOrganizerbooleanoSe establece como verdadero si el remitente del mensaje también es el organizador.
LocationLocationLa ubicación del evento.
OrganizadorRecipientEl organizador del evento.
RecurrencePatternedRecurrenceEl patrón de periodicidad del evento.No
ResponseRequestedbooleanoSe establece en verdadero si el remitente quiere una respuesta cuando el evento se acepta o rechaza.
ResponseStatusResponseStatusIndica el tipo de respuesta que se envía en respuesta a un mensaje de evento.No
SensitivitySensitivityIndica el nivel de privacidad del evento: Normal = 0, Personal = 1, Private = 2, Confidential = 3.
SeriesMasterIdCadenaLas categorías asignadas al elemento.No
ShowAsFreeBusyStatusEl estado que se mostrará: Free = 0, Tentative = 1, Busy = 2, Oof = 3, WorkingElsewhere = 4, Unknown = -1.
StartdatetimeoffsetLa hora de inicio del evento.

De manera predeterminada, la hora de inicio está en formato UTC. Puede especificar una zona horaria opcional en StartTimeZone, expresar la hora de inicio en esa zona horaria e incluir una diferencia horaria de UTC. Tenga en cuenta que, si usa StartTimeZone, debe especificar también un valor para EndTimeZone.

En este ejemplo, se especifica el 25 de febrero de 2015, a las 19:34 en hora estándar del Pacífico: "2015-02-25T19:34:00-08:00".
StartTimeZoneCadenaIdentifica la zona horaria de la reunión para la hora de inicio de la reunión (vea la propiedad Start). Esta propiedad hace que el servicio gestione los cambios de zona horaria en lugar del cliente. Esta propiedad se establece con el nombre de la zona horaria tal como está almacenada en Windows. Puede obtener los nombres de zona horaria llamando a System.TimeZoneInfo.GetSystemTimeZones().

Esta propiedad es opcional para la versión 1.0. Sin embargo, esta propiedad se debe usar si se usa la propiedad EndTimeZone.

Un valor de ejemplo para esta propiedad es "Hora estándar del Pacífico". Consulte TimeZone para más información.
No
SubjectCadenaEl texto de la línea de asunto del evento.
TipoEventTypeEl tipo de evento: SingleInstance = 0, Occurrence = 1, Exception = 2, SeriesMaster = 3.
WebLinkCadenaLa 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.
NoNo

EventMessage

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

Tipo base: Message

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

Acción/verboPermissionDescripción
Crear un mensaje de evento (POST)N/DNo permitido. Dará como resultado un código de respuesta 400.
Actualizar un mensaje de evento (PATCH)Mail.WritePuede 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.WriteLa misma acción que para un Message.
Mover un mensaje de evento (POST)Mail.WriteLa misma acción que para un Message.
Copiar un mensaje de evento (POST)Mail.WriteLa misma acción que para un Message.
Crear borrador de mensaje de respuesta (POST)Mail.WriteLa misma acción que para un Message.
Crear borrador de responder a todos los mensajes (POST)Mail.WriteLa misma acción que para un Message.
Crear una respuesta (POST)Mail.WriteLa misma acción que para un Message.
Crear una respuesta a todos (POST)Mail.WriteLa misma acción que para un Message.
Enviar un mensaje de evento existente (POST)Mail.WriteSolo puede enviar un mensaje de evento donde la propiedad IsDraft tenga un valor de verdadero. A continuación, el mensaje se guarda en la carpeta Elementos enviados.
Crear un mensaje de evento de reenviar borradorMail.WriteLa misma acción que para un Message.
Reenviar un mensaje de eventoMail.WriteLa misma acción que para un Message.

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

PropiedadTipoDescripción¿Se puede escribir?¿Se puede filtrar?
EndDateTimeDateTimeTimeZoneLa fecha y hora en que finaliza el evento asociado.
EventEventEl 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.NoNo
IsAllDayBooleanoIndica si el evento dura todo el día. Ajustar esta propiedad requiere ajustar las propiedades StartDateTime y EndDateTime del evento también.
IsOutOfDateBooleanoIndica si esta solicitud de reunión se ha desactualizado debido a una solicitud más reciente.NoNo
LocationLocationLa ubicación del evento asociado.
MeetingMessageTypeMeetingMessageTypeEl tipo de mensaje de evento: None = 0, MeetingRequest = 1, MeetingCancelled = 2, MeetingAccepted = 3, MeetingTentativelyAccepted = 4, MeetingDeclined = 5No
RecurrencePatternedRecurrenceEl patrón de periodicidad del evento asociado.No
StartDateTimeDateTimeTimeZoneLa hora de inicio del evento asociado.
TipoEventTypeEl tipo del evento asociado: SingleInstance = 0, Occurrence = 1, Exception = 2, SeriesMaster = 3.
PropiedadTipoDescripción¿Se puede escribir?¿Se puede filtrar?
EventEventEl 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.NoNo
MeetingMessageTypeMeetingMessageTypeEl tipo de mensaje de evento: None = 0, MeetingRequest = 1, MeetingCancelled = 2, MeetingAccepted = 3, MeetingTentativelyAccepted = 4, MeetingDeclined = 5No
PropiedadTipoDescripción¿Se puede escribir?¿Se puede filtrar?
EventEventEl 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.NoNo
MeetingMessageTypeMeetingMessageTypeEl tipo de mensaje de evento: None = 0, MeetingRequest = 1, MeetingCancelled = 2, MeetingAccepted = 3, MeetingTentativelyAccepted = 4, MeetingDeclined = 5No

EventMessageRequest (versión preliminar)

Un mensaje que representa una solicitud de reunión.

Tipo base: EventMessage

PropiedadTipoDescripción¿Se puede escribir?¿Se puede filtrar?
PreviousEndDateTimeDateTimeTimeZoneLa fecha y hora de finalización anterior de la reunión solicitada.No
PreviousLocationLocationLa ubicación anterior de la reunión solicitada.No
PreviousStartDateTimeDateTimeTimeZoneLa fecha y hora de inicio previas de la reunión solicitada.No

Actualmente, esta característica está disponible en la versión beta. Para obtener más información, utilice el control de la esquina superior derecha del artículo y seleccione beta.

Actualmente, esta característica está disponible en la versión beta. Para obtener más información, utilice el control de la esquina superior derecha del artículo y seleccione beta.

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

PropiedadTipoDescripción¿Se puede escribir?¿Se puede filtrar?
ValueColección(String)Colección de valores de propiedad.No
PropertyIdCadenaEl identificador de la propiedad. Esto se usa para identificar la propiedad.NoNo

SingleValueLegacyExtendedProperty

Una propiedad extendida que contiene un solo valor.

Tipo: Microsoft.OutlookServices.SingleValueLegacyExtendedProperty

PropiedadTipoDescripción¿Se puede escribir?¿Se puede filtrar?
ValueCadenaValor de la propiedad.No
PropertyIdCadenaEl identificador de la propiedad. Esto se usa para identificar la propiedad.No

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.

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

PropiedadTipoDescripción¿Se puede escribir?¿Se puede filtrar?
ValueColección(String)Colección de valores de propiedad.No
PropertyIdCadenaEl identificador de la propiedad. Esto se usa para identificar la propiedad.NoNo

SingleValueLegacyExtendedProperty

Una propiedad extendida que contiene un solo valor.

Tipo: Microsoft.OutlookServices.SingleValueLegacyExtendedProperty

PropiedadTipoDescripción¿Se puede escribir?¿Se puede filtrar?
ValueCadenaValor de la propiedad.No
PropertyIdCadenaEl identificador de la propiedad. Esto se usa para identificar la propiedad.No

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.

Actualmente, esta característica está disponible en la versión beta y 2.0. Para obtener más información, utilice el control de la esquina superior derecha del artículo y seleccione las versión que quiere elegir.

FileAttachment

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

Tipo: Microsoft.OutlookServices.FileAttachment

Tipo base: Microsoft.OutlookServices.Attachment

PropiedadTipoDescripción¿Se puede escribir?
ContentBytesbinarioEl contenido binario del archivo.No
ContentIdCadenaEl identificador de los datos de adjuntos del almacén de Exchange.No
ContentLocationCadenaEl identificador uniforme de recursos (URI) que corresponde a la ubicación del contenido de los datos adjuntos.No
ContentTypeCadenaEl tipo de contenido de los datos adjuntos.
LastModifiedDateTimedatetimeoffsetLa fecha y hora de la última modificación de los datos adjuntos.No
IdCadenaEl identificador de los datos adjuntos.No
IsInlinebooleanoSe establece en verdadero si se trata de datos adjuntos en línea.
NameCadenaEl 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.
SizeInt32El tamaño en bytes de los datos adjuntos.No

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

Tipo: Microsoft.OutlookServices.FileAttachment

Tipo base: Microsoft.OutlookServices.Attachment

PropiedadTipoDescripción¿Se puede escribir?
ContentBytesbinarioEl contenido binario del archivo.No
ContentIdCadenaEl identificador de los datos de adjuntos del almacén de Exchange.No
ContentLocationCadenaEl identificador uniforme de recursos (URI) que corresponde a la ubicación del contenido de los datos adjuntos.No
ContentTypeCadenaEl tipo de contenido de los datos adjuntos.
LastModifiedDateTimedatetimeoffsetLa fecha y hora de la última modificación de los datos adjuntos.No
IdCadenaEl identificador de los datos adjuntos.No
IsInlinebooleanoSe establece en verdadero si se trata de datos adjuntos en línea.
NameCadenaEl 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.
SizeInt32El tamaño en bytes de los datos adjuntos.No

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

Tipo: Microsoft.OutlookServices.FileAttachment

Tipo base: Microsoft.OutlookServices.Attachment

PropiedadTipoDescripción¿Se puede escribir?
ContentBytesbinarioEl contenido binario del archivo.No
ContentIdCadenaEl identificador de los datos de adjuntos del almacén de Exchange.No
ContentLocationCadenaEl identificador uniforme de recursos (URI) que corresponde a la ubicación del contenido de los datos adjuntos.No
ContentTypeCadenaEl tipo de contenido de los datos adjuntos.
DateTimeLastModifieddatetimeoffsetLa fecha y hora de la última modificación de los datos adjuntos.No
IdCadenaEl identificador de los datos adjuntos.No
IsContactPhotobooleanoObsoleta
IsInlinebooleanoSe establece en verdadero si se trata de datos adjuntos en línea.
NameCadenaEl 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.
SizeInt32El tamaño en bytes de los datos adjuntos.No

Folder / MailFolder

Nota En la versión beta, la entidad y el tipo anteriormente conocido como Folder han sido renombrados como MailFolder.

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

Tipo: Microsoft.OutlookServices.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.

PropiedadTipoDescripción¿Se puede escribir?¿Se puede filtrar?
ChildFolderCountInt32La cantidad de carpetas en la carpeta.No
ChildFoldersColección(MailFolder)La colección de carpetas secundarias en la carpeta. Propiedad de navegación.NoNo
DisplayNameCadenaEl nombre para mostrar de la carpeta.
IdCadenaEl identificador exclusivo de la carpeta. Puede usar los siguientes nombres conocidos para acceder a la carpeta correspondiente: Inbox, Drafts, SentItems, DeletedItems.NoNo
MessageRulesColección(MessageRule)Conjunto de reglas que se aplican a la Bandeja de entrada. Propiedad de navegación.NoNo
MessagesColección(Message)La colección de mensajes en la carpeta. Propiedad de navegación.NoNo
ParentFolderIdCadenaEl identificador exclusivo para la carpeta primaria de la carpeta.NoNo
TotalItemCountInt32La cantidad de elementos en la carpeta.No
UnreadItemCountInt32El número de elementos en la carpeta marcados como no leídos.No
WellKnownNameCadenaEl nombre bien conocido de la carpeta, como clutter, deleteditems, drafts, inbox, junkemail, outbox, o sentitems.No
MultiValueExtendedPropertiesUna colecciónUna colección de propiedades extendidas multivalor de tipo MultiValueLegacyExtendedProperty. Es una propiedad de navegación. Vea más información sobre propiedades extendidas.
SingleValueExtendedPropertiesUna colecciónUna colección de propiedades extendidas de un solo valor SingleValueLegacyExtendedProperty. Es una propiedad de navegación. Vea más información sobre propiedades extendidas.

Acceder a recuentos de elementos de forma eficaz

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

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

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

Nota En la versión 2.0, la entidad y el tipo anteriormente conocido como Folder han sido renombrados como MailFolder.

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

Tipo: Microsoft.OutlookServices.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.

PropiedadTipoDescripción¿Se puede escribir?¿Se puede filtrar?
ChildFolderCountInt32La cantidad de carpetas en la carpeta.No
ChildFoldersColección(MailFolder)La colección de carpetas secundarias en la carpeta. Propiedad de navegación.NoNo
DisplayNameCadenaEl nombre para mostrar de la carpeta.
IdCadenaEl identificador exclusivo de la carpeta. Puede usar los siguientes nombres conocidos para acceder a la carpeta correspondiente: Inbox, Drafts, SentItems, DeletedItems.NoNo
MessagesColección(Message)La colección de mensajes en la carpeta. Propiedad de navegación.NoNo
ParentFolderIdCadenaEl identificador exclusivo para la carpeta primaria de la carpeta.NoNo
TotalItemCountInt32La cantidad de elementos en la carpeta.No
UnreadItemCountInt32El número de elementos en la carpeta marcados como no leídos.No
MultiValueExtendedPropertiesUna colecciónUna colección de propiedades extendidas multivalor de tipo MultiValueLegacyExtendedProperty. Es una propiedad de navegación. Vea más información sobre propiedades extendidas.
SingleValueExtendedPropertiesUna colecciónUna colección de propiedades extendidas de un solo valor SingleValueLegacyExtendedProperty. Es una propiedad de navegación. Vea más información sobre propiedades extendidas.

Acceder a recuentos de elementos de forma eficaz

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

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

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

Nota En versiones posteriores a la 1.0, el tipo y la entidad Folder han sido renombrados como MailFolder.

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

Tipo: Microsoft.OutlookServices.Folder

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

Consulte Operaciones Folder para ver las acciones admitidas.

PropiedadTipoDescripción¿Se puede escribir?¿Se puede filtrar?
ChildFolderCountInt32La cantidad de carpetas en la carpeta.No
ChildFoldersColección(Folder)La colección de carpetas secundarias en la carpeta. Propiedad de navegación.NoNo
DisplayNameCadenaEl nombre para mostrar de la carpeta.
IdCadenaEl identificador exclusivo de la carpeta. Puede usar los siguientes nombres conocidos para acceder a la carpeta correspondiente: Inbox, Drafts, SentItems, DeletedItems.NoNo
MessagesColección(Message)La colección de mensajes en la carpeta. Propiedad de navegación.NoNo
ParentFolderIdCadenaEl identificador exclusivo para la carpeta primaria de la carpeta.NoNo
TotalItemCountInt32La cantidad de elementos en la carpeta.No
UnreadItemCountInt32El número de elementos en la carpeta marcados como no leídos.No

Acceder a recuentos de elementos de forma eficaz

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

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

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

InferenceClassification

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

PropiedadTipoDescripción¿Se puede escribir?
OverridesColección(InferenceClassificationOverride)Un conjunto de modificaciones para que un usuario clasifique siempre los mensajes de remitentes específicos de ciertas maneras, tal como lo admite InferenceClassificationType. Propiedad de navegación.

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

PropiedadTipoDescripción¿Se puede escribir?
OverridesColección(InferenceClassificationOverride)Un conjunto de modificaciones para que un usuario clasifique siempre los mensajes de remitentes específicos de ciertas maneras, tal como lo admite InferenceClassificationType. Propiedad de navegación.

Actualmente, esta característica está disponible en la versión 2.0 y beta. Para obtener más información, utilice el control en la esquina superior derecha del artículo y seleccione una de estas versiones.

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

PropiedadTipoDescripción¿Se puede escribir?
ClassifyAsInferenceClassificationTypeEspecifica cómo se deben clasificar siempre los mensajes entrantes de un remitente determinado. Focused=0, Other=1.
IdCadenaEl identificador exclusivo de la invalidación.No
SenderEmailAddressEmailAddressInformación de la dirección de correo del remitente para el que se creó el reemplazo.

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

Tipo: Microsoft.OutlookServices.InferenceClassificationOverride

PropiedadTipoDescripción¿Se puede escribir?
ClassifyAsInferenceClassificationTypeEspecifica cómo se deben clasificar siempre los mensajes entrantes de un remitente determinado. Focused=0, Other=1.
IdCadenaEl identificador exclusivo de la invalidación.No
SenderEmailAddressEmailAddressLa dirección de correo del remitente para el que se creó la invalidación.

Actualmente, esta característica está disponible en la versión 2.0 y beta. Para obtener más información, utilice el control en la esquina superior derecha del artículo y seleccione una de estas versiones.

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

PropiedadTipoDescripción¿Se puede escribir?
ContentTypeCadenaEl tipo de contenido de los datos adjuntos.
LastModifiedDateTimedatetimeoffsetÚltima fecha y hora en que se modificaron los datos adjuntos.No
IdCadenaEl identificador de los datos adjuntos.No
ElementoElementoEvento o mensaje adjunto. Propiedad de navegación.
IsInlinebooleanoSe establece en verdadero si los datos adjuntos están insertados, como una imagen incrustada en el cuerpo del elemento.
NameCadenaNombre para mostrar de los datos adjuntos.
SizeInt32El tamaño en bytes de los datos adjuntos.

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

PropiedadTipoDescripción¿Se puede escribir?
ContentTypeCadenaEl tipo de contenido de los datos adjuntos.
LastModifiedDateTimedatetimeoffsetÚltima fecha y hora en que se modificaron los datos adjuntos.No
IdCadenaEl identificador de los datos adjuntos.No
ElementoElementoEvento o mensaje adjunto. Propiedad de navegación.
IsInlinebooleanoSe establece en verdadero si los datos adjuntos están insertados, como una imagen incrustada en el cuerpo del elemento.
NameCadenaNombre para mostrar de los datos adjuntos.
SizeInt32El tamaño en bytes de los datos adjuntos.

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

Tipo: Microsoft.OutlookServices.ItemAttachment

Tipo base: Microsoft.OutlookServices.Attachment

PropiedadTipoDescripción¿Se puede escribir?
ContentTypeCadenaEl tipo de contenido de los datos adjuntos.
DateTimeLastModifieddatetimeoffsetÚltima fecha y hora en que se modificaron los datos adjuntos.No
IdCadenaEl identificador de los datos adjuntos.No
ElementoElementoEvento o mensaje adjunto. Propiedad de navegación.
IsInlinebooleanoSe establece en verdadero si los datos adjuntos están insertados, como una imagen incrustada en el cuerpo del elemento.
NameCadenaNombre para mostrar de los datos adjuntos.
SizeInt32El tamaño en bytes de los datos adjuntos.

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 notificaciones 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

PropiedadTipoDescripción¿Se puede escribir?¿Se puede filtrar?
ApplicationCadenaEl nombre de la aplicación donde se crea la mención. Opcional. No utilizado y predeterminado como nulo para Message.No
ClientReferenceCadenaUn identificador exclusivo que representa un primario de la instancia de recurso. Opcional. No utilizado y predeterminado como nulo para Message.
CreatedByEmailAddressLa información de correo electrónico del usuario que hizo la mención. Necesario.No
CreatedDateTimeDateTimeOffsetLa fecha y hora en que se creó la mención en el cliente.NoNo
DeepLinkCadenaUn vínculo web profundo al contexto de la mención en la instancia de recurso. Opcional. No utilizado y predeterminado como nulo para Message.No
IdCadenaEl identificador exclusivo de una mención en una instancia de recurso.NoNo
MentionedEmailAddressLa información de correo electrónico de la persona mencionada. Necesario.No
MentionTextCadenaContenido de la mención. Opcional. No utilizado y predeterminado como nulo para Message.No
ServerCreatedDateTimeDateTimeOffsetLa fecha y hora en que se creó la mención en el servidor. Opcional. No utilizado y predeterminado como nulo para Message.NoNo

Actualmente, esta característica solo está disponible en la versión beta. Para obtener más información, utilice el control de la esquina superior derecha del artículo y seleccione beta.

Actualmente, esta característica solo está disponible en la versión beta. Para obtener más información, utilice el control de la esquina superior derecha del artículo y seleccione beta.

Message

Un mensaje en una carpeta de buzón.

Tipo: Microsoft.OutlookServices.Message

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

Consulte Operaciones Message para ver las acciones admitidas.

PropiedadTipoDescripción¿Se puede escribir?¿Se puede filtrar?¿Se puede buscar?
AttachmentsColección(Attachment)Los datos adjuntos fileAttachment y itemAttachment del mensaje. Propiedad de navegación.No
BccRecipientsCollección(Recipient)Los destinatarios Cco del mensaje.No
BodyItemBodyEl cuerpo del mensaje.NoPredeterminado
BodyPreviewCadenaLos primeros 255 caracteres del contenido del cuerpo del mensaje.NoNo
CategoriesColección (cadena)Las categorías asociadas al mensaje.
CcRecipientsCollección(Recipient)Los destinatarios Cc del mensaje.No
ChangeKeyCadenaLa versión del mensaje.NoNoNo
ConversationIdCadenaEl identificador de la conversación a la que pertenece el correo electrónico.NoNo
ConversationIndexBinarioIndica la posición relativa del elemento dentro de la conversación a la que pertenece el correo electrónico.NoNoNo
CreatedDateTimedatetimeoffsetLa fecha y la hora de creación del mensaje.NoNo
ExtensionsColección(Extension)La colección de extensiones de datos de tipo abierto definidas para el mensaje. Propiedad de navegación.NoNo
FlagFollowupFlagInformación sobre cualquier seguimiento del mensaje.
DeRecipientEl propietario del buzón y el remitente del mensaje.
HasAttachmentsbooleanoIndica si el mensaje tiene datos adjuntos.No
IdCadenaEl identificador exclusivo del mensaje.NoNoNo
ImportanceImportanceLa importancia del mensaje: Bajo = 0, Normal = 1, Alto = 2.
InferenceClassificationInferenceClassificationTypeLa clasificación del mensaje para el usuario, según la importancia o relevancia inferida, o según una invalidación explícita.No
InternetMessageIdCadenaEl identificador del mensaje en el formato especificado por RFC2822.NoNoNo
InternetMessageHeadersColección(InternetMessageHeader)La colección de encabezados de mensaje de internet en el formato especificado por RFC2822.NoNoNo
IsDeliveryReceiptRequestedbooleanoIndica si se solicita confirmación de lectura para el mensaje.No
IsDraftbooleanoIndica si el mensaje es un borrador. Un mensaje es un borrador si no se ha enviado todavía.NoNo
IsReadbooleanoIndica si se ha leído el mensaje.No
IsReadReceiptRequestedbooleanoIndica si se solicita confirmación de lectura para el mensaje.No
LastModifiedDateTimedatetimeoffsetLa fecha y la hora de la última modificación del mensaje.NoNo
MentionsColecció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.NoNo
MentionsPreviewMentionsPreviewInformació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.NoNoNo
MultiValueExtendedPropertiesUna colecciónUna colección de propiedades extendidas multivalor de tipo MultiValueLegacyExtendedProperty. Es una propiedad de navegación. Vea más información sobre propiedades extendidas.No
ParentFolderIdCadenaEl identificador exclusivo para la carpeta primaria del mensaje.NoNoNo
ReceivedDateTimedatetimeoffsetLa fecha y la hora en las que se recibió el mensaje.No
ReplyToCollección(Recipient)Las direcciones de correo electrónico que se utilizan al responder.NoNoNo
SenderRecipientLa cuenta que se utiliza realmente para generar el mensaje.Predeterminado
SentDateTimedatetimeoffsetLa fecha y la hora de envío del mensaje.NoNo
SingleValueExtendedPropertiesUna colecciónUna colección de propiedades extendidas de un solo valor SingleValueLegacyExtendedProperty. Es una propiedad de navegación. Vea más información sobre propiedades extendidas.No
SubjectCadenaEl asunto del mensaje.Predeterminado
ToRecipientsCollección(Recipient)Los destinatarios Para del mensaje.No
UniqueBodyItemBodyEl cuerpo del mensaje que es exclusivo de la conversación.NoNoNo
UnsubscribeDataColección (cadena)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.NoNoNo
UnsubscribeEnabledbooleanoIndica 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.NoNoNo
WebLinkCadenaLa 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.
NoNo
PropiedadTipoDescripción¿Se puede escribir?¿Se puede filtrar?¿Se puede buscar?
AttachmentsColección(Attachment)Los datos adjuntos fileAttachment y itemAttachment del mensaje. Propiedad de navegación.No
BccRecipientsCollección(Recipient)Los destinatarios Cco del mensaje.No
BodyItemBodyEl cuerpo del mensaje.NoPredeterminado
BodyPreviewCadenaLos primeros 255 caracteres del contenido del cuerpo del mensaje.NoNo
CategoriesColección (cadena)Las categorías asociadas al mensaje.
CcRecipientsCollección(Recipient)Los destinatarios Cc del mensaje.No
ChangeKeyCadenaLa versión del mensaje.NoNoNo
ConversationIdCadenaEl identificador de la conversación a la que pertenece el correo electrónico.NoNo
CreatedDateTimedatetimeoffsetLa fecha y la hora de creación del mensaje.NoNo
ExtensionsColección(Extension)La colección de extensiones de datos de tipo abierto definidas para el mensaje. Propiedad de navegación.NoNo
DeRecipientEl propietario del buzón y el remitente del mensaje.
HasAttachmentsbooleanoIndica si el mensaje tiene datos adjuntos.No
IdCadenaEl identificador exclusivo del mensaje.NoNoNo
ImportanceImportanceLa importancia del mensaje: Bajo = 0, Normal = 1, Alto = 2.
InferenceClassificationInferenceClassificationTypeLa clasificación del mensaje para el usuario, según la importancia o relevancia inferida, o según una invalidación explícita.
IsDeliveryReceiptRequestedbooleanoIndica si se solicita confirmación de lectura para el mensaje.No
IsDraftbooleanoIndica si el mensaje es un borrador. Un mensaje es un borrador si no se ha enviado todavía.NoNo
IsReadbooleanoIndica si se ha leído el mensaje.No
IsReadReceiptRequestedbooleanoIndica si se solicita confirmación de lectura para el mensaje.No
LastModifiedDateTimedatetimeoffsetLa fecha y la hora de la última modificación del mensaje.NoNo
MultiValueExtendedPropertiesUna colecciónUna colección de propiedades extendidas multivalor de tipo MultiValueLegacyExtendedProperty. Es una propiedad de navegación. Vea más información sobre propiedades extendidas.No
ParentFolderIdCadenaEl identificador exclusivo para la carpeta primaria del mensaje.NoNoNo
ReceivedDateTimedatetimeoffsetLa fecha y la hora en las que se recibió el mensaje.No
ReplyToCollección(Recipient)Las direcciones de correo electrónico que se utilizan al responder.NoNoNo
SenderRecipientLa cuenta que se utiliza realmente para generar el mensaje.Predeterminado
SingleValueExtendedPropertiesUna colecciónUna colección de propiedades extendidas de un solo valor SingleValueLegacyExtendedProperty. Es una propiedad de navegación. Vea más información sobre propiedades extendidas.No
SentDateTimedatetimeoffsetLa fecha y la hora de envío del mensaje.NoNo
SubjectCadenaEl asunto del mensaje.Predeterminado
ToRecipientsCollección(Recipient)Los destinatarios Para del mensaje.No
UniqueBodyItemBodyEl cuerpo del mensaje que es exclusivo de la conversación.NoNoNo
WebLinkCadenaLa 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.
NoNo
PropiedadTipoDescripción¿Se puede escribir?¿Se puede filtrar?¿Se puede buscar?
AttachmentsColección(Attachment)Los datos adjuntos fileAttachment y itemAttachment del mensaje. Propiedad de navegación.No
BccRecipientsCollección(Recipient)Los destinatarios Cco del mensaje.No
BodyItemBodyEl cuerpo del mensaje.NoPredeterminado
BodyPreviewCadenaLos primeros 255 caracteres del contenido del cuerpo del mensaje.NoNo
CategoriesColección (cadena)Las categorías asociadas al mensaje.
CcRecipientsCollección(Recipient)Los destinatarios Cc del mensaje.No
ChangeKeyCadenaLa versión del mensaje.NoNoNo
ConversationIdCadenaEl identificador de la conversación a la que pertenece el correo electrónico.NoNo
DateTimeCreateddatetimeoffsetLa fecha y la hora de creación del mensaje.NoNo
DateTimeLastModifieddatetimeoffsetLa fecha y la hora de la última modificación del mensaje.NoNo
DateTimeReceiveddatetimeoffsetLa fecha y la hora en las que se recibió el mensaje.No
DateTimeSentdatetimeoffsetLa fecha y la hora de envío del mensaje.NoNo
DeRecipientEl propietario del buzón y el remitente del mensaje.
HasAttachmentsbooleanoIndica si el mensaje tiene datos adjuntos.
IdCadenaEl identificador exclusivo del mensaje.NoNoNo
ImportanceImportanceLa importancia del mensaje: Bajo = 0, Normal = 1, Alto = 2.
IsDeliveryReceiptRequestedbooleanoIndica si se solicita confirmación de lectura para el mensaje.No
IsDraftbooleanoIndica si el mensaje es un borrador. Un mensaje es un borrador si no se ha enviado todavía.NoNo
IsReadbooleanoIndica si se ha leído el mensaje.No
IsReadReceiptRequestedbooleanoIndica si se solicita confirmación de lectura para el mensaje.No
ParentFolderIdCadenaEl identificador exclusivo para la carpeta primaria del mensaje.NoNoNo
ReplyToCollección(Recipient)Las direcciones de correo electrónico que se utilizan al responder.NoNo
SenderRecipientLa cuenta que se utiliza realmente para generar el mensaje.Predeterminado
SubjectCadenaEl asunto del mensaje.Predeterminado
ToRecipientsCollección(Recipient)Los destinatarios Para del mensaje.No
UniqueBodyItemBodyEl cuerpo del mensaje que es exclusivo de la conversación.NoNoNo
WebLinkCadenaLa 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.
NoNo

Quitar un script de la propiedad Body

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

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

Prefer: outlook.allow-unsafe-html

Configuración de las propiedades From y Sender

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

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

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

MessageRule (versión preliminar)

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

Tipo: Microsoft.OutlookServices.MessageRule

PropiedadTipoDescripción¿Se puede escribir?
AccionesMessageRuleActionsAcciones que se van a realizar en un mensaje cuando se cumplan las condiciones correspondientes.
CondicionesMessageRulePredicatesCondiciones que, cuando se cumplan, activarán las acciones correspondientes a esa regla.
DisplayNameCadenaNombre para mostrar de la regla.
ExcepcionesMessageRulePredicatesRepresenta las condiciones de excepción de la regla.
HasErrorBooleanoIndica si la regla es una condición de error.No
IsEnabledBooleanoIndica si la regla está habilitada para que se aplique a los mensajes.
IsReadOnlyBooleanoIndica si la regla es de solo lectura y la API de REST de reglas no la puede modificar ni eliminar.
SequenceInt32Indica el orden en que se ejecuta la regla entre otras reglas.

Actualmente, esta característica está disponible en la versión beta. Para obtener más información, utilice el control de la esquina superior derecha del artículo y seleccione beta.

Actualmente, esta característica está disponible en la versión beta. Para obtener más información, utilice el control de la esquina superior derecha del artículo y seleccione beta.

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.

PropiedadTipoDescripción¿Se puede escribir?¿Se puede filtrar?
DisplayNameCadenaUn nombre exclusivo para esta categoría en el buzón del usuario.No
ColorCategoryColorUna constante preestablecida que representa el color mapeado para esta categoría.

Actualmente, esta característica está disponible en la versión beta. Para obtener más información, utilice el control de la esquina superior derecha del artículo y seleccione beta.

Actualmente, esta característica está disponible en la versión beta. Para obtener más información, utilice el control de la esquina superior derecha del artículo y seleccione beta.

Photo

Tipo: Microsoft.OutlookServices.Photo

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

PropiedadTipoDescripción¿Se puede escribir?¿Se puede filtrar?
HeightintEl alto de la foto.NoNo
IdCadenaEl identificador exclusivo de la foto.NoNo
AnchointEl ancho de la foto.NoNo

Tipo: Microsoft.OutlookServices.Photo

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

PropiedadTipoDescripción¿Se puede escribir?¿Se puede filtrar?
HeightintEl alto de la fotoNoNo
IdCadenaEl identificador exclusivo de la foto.NoNo
AnchointEl ancho de la foto.NoNo

Actualmente, esta característica está disponible en la versión 2.0 y beta. Para obtener más información, utilice el control en la esquina superior derecha del artículo y seleccione una de estas versiones.

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.

PropiedadTipoDescripción¿Se puede escribir?¿Se puede filtrar?
ContentTypeCadenaEl tipo MIME del archivo adjunto. Opcional.No
IdCadenaEl identificador exclusivo de la referencia adjunta.NoNo
IsFolderBooleanoEspecifica 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.No
IsInlineBooleanotrue si los datos adjuntos son datos adjuntos insertados; de lo contrario, false. Opcional.
LastModifiedDateTimeDateTimeOffsetLa 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
NameCadenaNombre para mostrar de los datos adjuntos. Esto no necesita ser el nombre real del archivo. Necesario.
PermissionReferenceAttachmentPermissionsEspecifica 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.No
PreviewUrlCadenaSe 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.No
ProviderTypeReferenceAttachmentProvidersEl tipo de proveedor que admite los datos adjuntos de este ContentType. Los valores posibles son: Other, OneDriveBusiness, OneDriveConsumer y Dropbox. Opcional.
SizeInt32La longitud en bytes de los datos adjuntos. Opcional.NoNo
SourceUrlCadenaURL para obtener el contenido de datos adjuntos. Si se trata de una URL a una carpeta, para que la carpeta se muestre correctamente en Outlook o Outlook en la web establezca IsFolder en verdadero. Necesario.No
ThumbnailUrlCadenaSe 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.No

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.

PropiedadTipoDescripción¿Se puede escribir?¿Se puede filtrar?
ContentTypeCadenaEl tipo MIME del archivo adjunto. Opcional.No
IdCadenaEl identificador exclusivo de la referencia adjunta.NoNo
IsFolderBooleanoEspecifica 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.No
IsInlineBooleanotrue si los datos adjuntos son datos adjuntos insertados; de lo contrario, false. Opcional.
LastModifiedDateTimeDateTimeOffsetLa 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
NameCadenaNombre para mostrar de los datos adjuntos. Esto no necesita ser el nombre real del archivo. Necesario.
PermissionReferenceAttachmentPermissionsEspecifica 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.No
PreviewUrlCadenaSe 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.No
ProviderTypeReferenceAttachmentProvidersEl tipo de proveedor que admite los datos adjuntos de este ContentType. Los valores posibles son: Other, OneDriveBusiness, OneDriveConsumer y Dropbox. Opcional.
SizeInt32La longitud en bytes de los datos adjuntos. Opcional.NoNo
SourceUrlCadenaURL para obtener el contenido de datos adjuntos. Si se trata de una URL a una carpeta, para que la carpeta se muestre correctamente en Outlook o Outlook en la web establezca IsFolder en verdadero. Necesario.No
ThumbnailUrlCadenaSe 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.No

Actualmente, esta característica está disponible en la versión beta. Para obtener más información, utilice el control de la esquina superior derecha del artículo y seleccione beta.

Task

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.

Nota

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. Consulte más información sobre configurar StartDateTime y DueDateTimey devolver propiedades relacionadas con la fecha en una zona horaria personalizada.

PropiedadTipoDescripción¿Se puede escribir?¿Se puede filtrar?
AssignedToCadenaEl nombre de la persona a la que se le ha asignado la tarea.No
AttachmentsColección(Attachment)La colección de datos adjuntos FileAttachment, ItemAttachment, yReferenceAttachment para la tarea. Propiedad de navegación.NoNo
BodyItemBodyEl cuerpo de la tarea que generalmente contiene información sobre la tarea. Tenga en cuenta que solo se admite el tipo de HTML.No
CategoriesColección(String)Las categorías asociadas con la tarea.
ChangeKeyCadenaLa versión de la tarea.NoNo
CompletedDateTimeDateTimeTimeZoneLa fecha en la zona horaria especificada en que se finalizó la tarea.
CreatedDateTimeDateTimeOffsetLa fecha y la hora en que se creó la tarea. Por defecto, está en UTC. Puede proporcionar una zona horaria personalizada en el encabezado de solicitud.No
DueDateTimeDateTimeTimeZoneLa fecha en la zona horaria especificada en la que se debe finalizar la tarea.
HasAttachmentsbooleanoEstablezca en verdadero si la tarea tiene datos adjuntos.No
IdCadenaEl identificador exclusivo de la tarea.NoNo
ImportanceImportanceLa importancia del evento: Low, Normal, High.
IsReminderOnbooleanoSe establece en verdadero si se establece una alerta para recordarle la tarea al usuario.No
LastModifiedDateTimeDateTimeOffsetLa 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
OwnerCadenaEl nombre de la persona que creó la tarea.No
ParentFolderIdCadenaEl identificador exclusivo para la carpeta primaria de la tarea.NoNo
RecurrencePatternedRecurrenceEl patrón de periodicidad de la tarea.No
ReminderDateTimeDateTimeTimeZoneLa fecha y hora de una alerta de recordatorio de la tarea que se producirá.No
SensitivitySensitivityIndica el nivel de privacidad del evento: Normal, Personal, Private, Confidential.
StartDateTimeDateTimeTimeZoneLa fecha en la zona horaria especificada cuando la tarea debe comenzar.
StatusTaskStatusIndica estado o progreso de la tarea: NotStarted, InProgress, Completed, WaitingOnOthers, Deferred.
SubjectCadenaUna breve descripción o título de la 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.

Nota

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. Consulte más información sobre configurar StartDateTime y DueDateTimey devolver propiedades relacionadas con la fecha en una zona horaria personalizada.

PropiedadTipoDescripción¿Se puede escribir?¿Se puede filtrar?
AssignedToCadenaEl nombre de la persona a la que se le ha asignado la tarea.No
AttachmentsColección(Attachment)La colección de datos adjuntos FileAttachment y ItemAttachment para la tarea. Propiedad de navegación.NoNo
BodyItemBodyEl cuerpo de la tarea que generalmente contiene información sobre la tarea. Tenga en cuenta que solo se admite el tipo de HTML.No
CategoriesColección(String)Las categorías asociadas con la tarea.
ChangeKeyCadenaLa versión de la tarea.NoNo
CompletedDateTimeDateTimeTimeZoneLa fecha en la zona horaria especificada en que se finalizó la tarea.
CreatedDateTimeDateTimeOffsetLa fecha y la hora en que se creó la tarea. Por defecto, está en UTC. Puede proporcionar una zona horaria personalizada en el encabezado de solicitud.No
DueDateTimeDateTimeTimeZoneLa fecha en la zona horaria especificada en la que se debe finalizar la tarea.
HasAttachmentsbooleanoEstablezca en verdadero si la tarea tiene datos adjuntos.No
IdCadenaEl identificador exclusivo de la tarea.NoNo
ImportanceImportanceLa importancia del evento: Low, Normal, High.
IsReminderOnbooleanoSe establece en verdadero si se establece una alerta para recordarle la tarea al usuario.No
LastModifiedDateTimeDateTimeOffsetLa 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
OwnerCadenaEl nombre de la persona que creó la tarea.No
ParentFolderIdCadenaEl identificador exclusivo para la carpeta primaria de la tarea.NoNo
RecurrencePatternedRecurrenceEl patrón de periodicidad de la tarea.No
ReminderDateTimeDateTimeTimeZoneLa fecha y hora de una alerta de recordatorio de la tarea que se producirá.No
SensitivitySensitivityIndica el nivel de privacidad del evento: Normal, Personal, Private, Confidential.
StartDateTimeDateTimeTimeZoneLa fecha en la zona horaria especificada cuando la tarea debe comenzar.
StatusTaskStatusIndica estado o progreso de la tarea: NotStarted, InProgress, Completed, WaitingOnOthers, Deferred.
SubjectCadenaUna breve descripción o título de la tarea.

Actualmente, esta característica está disponible en la versión beta y 2.0. Para obtener más información, utilice el control en la esquina superior derecha del artículo y seleccione una de estas versiones.

TaskFolder

Tipo: Microsoft.OutlookServices.TaskFolder

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

PropiedadTipoDescripción¿Se puede escribir?¿Se puede filtrar?
ChangeKeyCadenaLa versión de la carpeta de tareas.NoNo
IdCadenaEl identificador exclusivo de la carpeta de tareas.NoNo
IsDefaultFolderBooleanoVerdadero si la carpeta es la carpeta de tareas predeterminada.No
NameCadenaEl nombre de la carpeta de tareas.
ParentGroupKeyEdm.GuidEl identificador GUID exclusivo para el grupo primario de la carpeta de tareas.NoNo
TareasColección(Task)Las tareas en esta carpeta de tareas. Propiedad de navegación.NoNo

Tipo: Microsoft.OutlookServices.TaskFolder

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

PropiedadTipoDescripción¿Se puede escribir?¿Se puede filtrar?
ChangeKeyCadenaLa versión de la carpeta de tareas.NoNo
IdCadenaEl identificador exclusivo de la carpeta de tareas.NoNo
IsDefaultFolderBooleanoVerdadero si la carpeta es la carpeta de tareas predeterminada.No
NameCadenaEl nombre de la carpeta de tareas.
ParentGroupKeyEdm.GuidEl identificador GUID exclusivo para el grupo primario de la carpeta de tareas.NoNo
TareasColección(Task)Las tareas en esta carpeta de tareas. Propiedad de navegación.NoNo

Actualmente, esta característica está disponible en la versión beta y 2.0. Para obtener más información, utilice el control en la esquina superior derecha del artículo y seleccione una de estas versiones.

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.

PropiedadTipoDescripción¿Se puede escribir?¿Se puede filtrar?
ChangeKeyCadenaLa versión del grupo de tareas.NoNo
GroupKeyEdm.GuidEl identificador GUID exclusivo para el grupo de tareas.NoNo
IdCadenaEl identificador exclusivo del grupo de tareas.NoNo
IsDefaultGroupBooleanoVerdadero si el grupo de tareas es el grupo de tareas predeterminado.No
NameCadenaEl nombre del grupo de tareas.
TaskFoldersColección(TaskFolder)Las carpetas de tareas en este grupo de tareas. Propiedad de navegación.NoNo

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.

PropiedadTipoDescripción¿Se puede escribir?¿Se puede filtrar?
ChangeKeyCadenaLa versión del grupo de tareas.NoNo
GroupKeyEdm.GuidEl identificador GUID exclusivo para el grupo de tareas.NoNo
IdCadenaEl identificador exclusivo del grupo de tareas.NoNo
IsDefaultGroupBooleanoVerdadero si el grupo de tareas es el grupo de tareas predeterminado.No
NameCadenaEl nombre del grupo de tareas.
TaskFoldersColección(TaskFolder)Las carpetas de tareas en este grupo de tareas. Propiedad de navegación.NoNo

Actualmente, esta característica está disponible en la versión beta y 2.0. Para obtener más información, utilice el control en la esquina superior derecha del artículo y seleccione una de estas versiones.

User

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

Tipo: Microsoft.OutlookServices.User

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

Nota La entidad User incluye muchas propiedades y relaciones (propiedades de navegación) que se aumentan con frecuencia. La siguiente sección describe solo un subconjunto. Para información actual, refiérase a la definición User en el correspondiente archivo de metadatos para su versión.

PropiedadTipoDescripción¿Se puede escribir?¿Se puede filtrar?
AliasCadenaEl alias del usuario. Por lo general, la dirección SMTP del usuario.
CalendarCalendarEl calendario principal del usuario. Propiedad de navegación.NoNo
CalendarGroupsColección(CalendarGroup)Obtiene los grupos de calendarios del usuario. Propiedad de navegación.NoNo
CalendariosColección(Calendar)Los calendarios del usuario. Propiedad de navegación.NoNo
CalendarViewColección(Event)La vista calendario del calendario. Propiedad de navegación.NoNo
ContactFoldersColección(ContactFolder)Las carpetas de contactos del usuario. Propiedad de navegación.NoNo
ContactsColección(Contact)Los contactos del usuario. Propiedad de navegación.NoNo
DisplayNameCadenaEl nombre para mostrar del usuario.
EventosColección(Event)Los eventos del usuario. El valor predeterminado es mostrar Eventos en el calendario predeterminado. Propiedad de navegación.NoNo
IdCadenaEl identificador exclusivo del usuario.NoNo
InferenceClassificationInferenceClassificationClasificació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.
MailboxGuidguidEl GUID asignado al buzón del usuario.No
MailboxSettingsMailboxSettingsConfiguración del buzón principal del usuario que inició sesión.No
MailFoldersColección(MailFolder)Las carpetas en un buzón. Propiedad de navegación.NoNo
MasterCategoriesColección(OutlookCategory)La lista maestra de categorías del usuario. Propiedad de navegación.
MessagesColección(Message)Los mensajes en un buzón o carpeta. Propiedad de navegación.NoNo
RootFolderMailFolderLa carpeta raíz del buzón del usuario. Propiedad de navegación.NoNo
PropiedadTipoDescripción¿Se puede escribir?¿Se puede filtrar?
AliasCadenaEl alias del usuario. Por lo general, la dirección SMTP del usuario.
CalendarCalendarEl calendario principal del usuario. Propiedad de navegación.NoNo
CalendarGroupsColección(CalendarGroup)Obtiene los grupos de calendarios del usuario. Propiedad de navegación.NoNo
CalendariosColección(Calendar)Los calendarios del usuario. Propiedad de navegación.NoNo
CalendarViewColección(Event)La vista calendario del calendario. Propiedad de navegación.NoNo
ContactFoldersColección(ContactFolder)Las carpetas de contactos del usuario. Propiedad de navegación.NoNo
ContactsColección(Contact)Los contactos del usuario. Propiedad de navegación.NoNo
DisplayNameCadenaEl nombre para mostrar del usuario.
EventosColección(Event)Los eventos del usuario. El valor predeterminado es mostrar Eventos en el calendario predeterminado. Propiedad de navegación.NoNo
IdCadenaEl identificador exclusivo del usuario.NoNo
InferenceClassificationInferenceClassificationClasificació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.
MailboxGuidguidEl GUID asignado al buzón del usuario.No
MailboxSettingsMailboxSettingsConfiguración del buzón principal del usuario que inició sesión.No
MailFoldersColección(MailFolder)Las carpetas en un buzón. Propiedad de navegación.NoNo
MessagesColección(Message)Los mensajes en un buzón o carpeta. Propiedad de navegación.NoNo
RootFolderMailFolderLa carpeta raíz del buzón del usuario. Propiedad de navegación.NoNo
PropiedadTipoDescripción¿Se puede escribir?¿Se puede filtrar?
AliasCadenaEl alias del usuario. Por lo general, la dirección SMTP del usuario.
CalendarCalendarEl calendario principal del usuario. Propiedad de navegación.NoNo
CalendarGroupsColección(CalendarGroup)Obtiene los grupos de calendarios del usuario. Propiedad de navegación.NoNo
CalendariosColección(Calendar)Los calendarios del usuario. Propiedad de navegación.NoNo
CalendarViewColección(Event)La vista calendario del calendario. Propiedad de navegación.NoNo
ContactFoldersColección(ContactFolder)Las carpetas de contactos del usuario. Propiedad de navegación.NoNo
ContactsColección(Contact)Los contactos del usuario. Propiedad de navegación.NoNo
DisplayNameCadenaEl nombre para mostrar del usuario.
EventosColección(Event)Los eventos del usuario. El valor predeterminado es mostrar Eventos en el calendario predeterminado. Propiedad de navegación.NoNo
CarpetasColección(Folder)Las carpetas en un buzón o carpeta. Propiedad de navegación.NoNo
IdCadenaEl identificador exclusivo del usuario.NoNo
MailboxGuidguidEl GUID asignado al buzón del usuario.No
MessagesColección(Message)Los mensajes en un buzón o carpeta. Propiedad de navegación.NoNo
RootFolderCarpetaLa carpeta raíz del buzón del usuario. Propiedad de navegación.NoNo

Tipos complejos

Attendee | AttendeeAvailability | AttendeeBase | AutomaticRepliesMailTips (versión preliminar) | AutomaticRepliesSetting | DateTimeTimeZone | EmailAddress | Error (versión preliminar) | FollowUpFlag (versión preliminar) | GeoCoordinates | InternetMessageHeader (versión preliminar) | ItemBody | LocaleInfo | Location | LocationConstraint | LocationConstraintItem | MailboxSettings | MailTips (versión preliminar) | MeetingTimeSuggestion | MeetingTimeSuggestionsResult | MentionsPreview (versión preliminar) | MessageRuleActions (versión preliminar) | MessageRulePredicates (versión preliminar) | PatternedRecurrence | Phone (versión preliminar) | PhysicalAddress | Recipient | RecurrencePattern | RecurrenceRange | ResponseStatus | SizeRange (versión preliminar) | TimeConstraint | TimeSlot | TimeZoneInformation (versión preliminar) | Website (versión preliminar) | WorkingHours (versión preliminar) |

Attendee

Un asistente a un evento.

Tipo: Microsoft.OutlookServices.AttendeeBase

PropiedadTipoDescripción
StatusResponseStatusLa respuesta (ninguna, aceptada, rechazada, etc.) y el tiempo.

AttendeeAvailability

El tipo y la disponibilidad de un asistente.

Tipo: Microsoft.OutlookServices.AttendeeAvailability

PropiedadTipoDescripción
AttendeeAttendeeBaseEl tipo de asistente, ya sea una persona o un recurso.
DisponibilidadFreeBusyStatusEl estado de disponibilidad del asistente.

AttendeeBase

El tipo de asistente.

Tipo: Microsoft.OutlookServices.Recipient

PropiedadTipoDescripción
TipoAttendeeTypeEl 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

PropiedadTipoDescripción
MessageCadenaEl mensaje de respuesta automática.
MessageLanguageLocaleInfoEl idioma en el que se encuentra el mensaje de respuesta automática.
ScheduledStartTimeDateTimeTimeZoneLa fecha y la hora en que las respuestas automáticas están configuradas para comenzar.
ScheduledEndTimeDateTimeTimeZoneLa 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

PropiedadTipoDescripción
ExternalAudienceExternalAudienceScopeEl conjunto de audiencia externa a la organización del usuario que ha iniciado sesión que recibirá el ExternalReplyMessage, si Status es AlwaysEnabled o Scheduled. Los valores son None = 0, ContactsOnly = 1, o All = 2.
ExternalReplyMessageCadenaLa respuesta automática para enviar a la audiencia externa especificada, si Status es AlwaysEnabled o Scheduled.
InternalReplyMessageCadenaLa 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.
ScheduledEndDateTimeDateTimeTimeZoneLa 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.
ScheduledStartDateTimeDateTimeTimeZoneLa 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.
StatusAutomaticRepliesStatusEstado de configuraciones para respuestas automáticas: Disabled = 0, AlwaysEnabled = 1, Scheduled = 2.

Attendee | AttendeeAvailability | AttendeeBase | AutomaticRepliesSetting | DateTimeTimeZone| EmailAddress | GeoCoordinates | ItemBody | LocaleInfo | Location | LocationConstraint | LocationConstraintItem | MailboxSettings | MeetingTimeSuggestion | MeetingTimeSuggestionsResult | PatternedRecurrence | PhysicalAddress | Recipient | RecurrencePattern | RecurrenceRange | ResponseStatus | TimeConstraint | TimeSlot |

Attendee

Un asistente a un evento.

Tipo: Microsoft.OutlookServices.Recipient

PropiedadTipoDescripción
StatusResponseStatusLa respuesta (ninguna, aceptada, rechazada, etc.) y el tiempo.
TipoAttendeeTypeEl tipo de asistente. Los valores posibles son: Required, Optional y Resource.

AttendeeAvailability

El tipo y la disponibilidad de un asistente.

Tipo: Microsoft.OutlookServices.AttendeeAvailability

PropiedadTipoDescripción
AttendeeAttendeeBaseEl tipo de asistente, ya sea una persona o un recurso.
DisponibilidadFreeBusyStatusEl estado de disponibilidad del asistente.

AttendeeBase

El tipo de asistente.

Tipo: Microsoft.OutlookServices.Recipient

PropiedadTipoDescripción
TipoAttendeeTypeEl 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.

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

PropiedadTipoDescripción
ExternalAudienceExternalAudienceScopeEl conjunto de audiencia externa a la organización del usuario que ha iniciado sesión que recibirá el ExternalReplyMessage, si Status es AlwaysEnabled o Scheduled. Los valores son None = 0, ContactsOnly = 1, o All = 2.
ExternalReplyMessageCadenaLa respuesta automática para enviar a la audiencia externa especificada, si Status es AlwaysEnabled o Scheduled.
InternalReplyMessageCadenaLa 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.
ScheduledEndDateTimeDateTimeTimeZoneLa 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.
ScheduledStartDateTimeDateTimeTimeZoneLa 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.
StatusAutomaticRepliesStatusEstado de configuraciones para respuestas automáticas: Disabled = 0, AlwaysEnabled = 1, Scheduled = 2.

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

Attendee

Un asistente a un evento.

Tipo: Microsoft.OutlookServices.Recipient

PropiedadTipoDescripción
StatusResponseStatusLa respuesta (ninguna, aceptada, rechazada, etc.) y el tiempo.
TipoAttendeeTypeEl tipo de asistente: Required, Optional, Resource.

DateTimeTimeZone

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

PropiedadTipoDescripción
DateTimeDateTimeUn único punto temporal en una representación combinada de fecha y hora (<date>T<time>) según el formato ISO 8601
TimeZoneCadenaUno 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

America/Anchorage

America/Santa_Isabel

America/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

Africa/Cairo

Asia/Damasco

Africa/Johannesburg

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

Pacific/Kiritimati

DateTimeTimeZone

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

PropiedadTipoDescripción
DateTimeDateTimeUn único punto temporal en una representación combinada de fecha y hora (<date>T<time>) según el formato ISO 8601.
TimeZoneCadenaUno 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

America/Anchorage

America/Santa_Isabel

America/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

Africa/Cairo

Asia/Damasco

Africa/Johannesburg

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

Pacific/Kiritimati

EmailAddress

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

Tipo: Microsoft.OutlookServices.EmailAddress

PropiedadTipoDescripción
NameCadenaNombre para mostrar de la persona o entidad.
AddressCadenaDirección de correo de la persona o entidad.
PropiedadTipoDescripción
NameCadenaNombre para mostrar de la persona o entidad.
AddressCadenaDirección de correo de la persona o entidad.
PropiedadTipoDescripción
NameCadenaNombre para mostrar de la persona o entidad.
AddressCadenaDirección de correo de la persona o entidad.

Error (versión preliminar)

Un error que ocurre durante una acción.

Tipo: Microsoft.OutlookServices.Error

PropiedadTipoDescripción
MessageCadenaMensaje de error.
CódigoCadenaCódigo de error.

FollowUpFlag (versión preliminar)

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

Tipo: Microsoft.OutlookServices.FollowupFlag

PropiedadTipoDescripción
CompletedDateTimeDateTimeTimeZoneLa fecha y hora en que finalizó el seguimiento.
DueDateTimeDateTimeTimeZoneFecha y hora en que se va a finalizar el seguimiento.
StartDateTimeDateTimeTimeZoneFecha y hora en que va a iniciarse el seguimiento.
FlagStatusFollowupFlagStatusRepresenta 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

PropiedadTipoDescripción
AltitudedobleLa altitud de la ubicación.
LatitudedobleLa latitud de la ubicación.
LongitudedobleLa longitud de la ubicación.
AccuracydobleLa precisión del sensor que proporciona la latitud y la longitud.
AltitudeAccuracydobleLa 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

PropiedadTipoDescripción
NameCadenaLa clave en el par clave-valor del encabezado del mensaje de internet.
ValueCadenaEl 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

PropiedadTipoDescripción
ContentTypeBodyTypeEl tipo de contenido: Texto = 0, HTML = 1.
ContenidoCadenaEl 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

PropiedadTipoDescripción
DisplayNameCadenaUn nombre que representa una configuración regional por su lenguaje natural, por ejemplo, "Inglés (Estados Unidos)".
LocaleCadenaUna 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

PropiedadTipoDescripción
AddressPhysicalAddressLa dirección física de la ubicación.
CoordenadasGeoCoordinatesCoordenadas geográficas y elevación de la ubicación.
DisplayNameCadenaNombre asociado a la ubicación.
LocationEmailAddressCadenaDirección de correo electrónico opcional de la ubicación.
LocationUriCadenaURI opcional que representa la ubicación.
LocationTypeLocationTypeEl 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

PropiedadTipoDescripción
IsRequiredbooleanoEl cliente solicita al servicio que incluya en la respuesta una ubicación de reunión para la reunión.
SuggestLocationbooleanoEl cliente solicita al servicio que sugiera una o más ubicaciones de reunión.
LocationsColecció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

PropiedadTipoDescripción
ResolveAvailabilitybooleanoSi 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

PropiedadTipoDescripción
EmailAddressEmailAddressLa dirección de correo electrónico del destinatario para recibir sugerencias de correo.
AutomaticRepliesAutomaticRepliesMailTipsSugerencias por correo para la respuesta automática si el destinatario lo ha configurado.
MailboxFullBooleanoEl estado de lleno del buzón del destinatario.
CustomMailTipCadenaUna sugerencia de correo personalizada que se puede configurar en el buzón del destinatario.
ExternalMemberCountInt32La cantidad de miembros externos si el destinatario es una lista de distribución.
TotalMemberCountInt32La cantidad de miembros si el destinatario es una lista de distribución.
DeliveryRestrictedBooleanoSi 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.
IsModeratedBooleanoSi 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.
RecipientScopeRecipientScopeTypeEl á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.
RecipientSuggestionsColección(Recipient)Destinatarios sugeridos basados ​​en contextos anteriores donde aparecen en el mismo mensaje.
MaxMessageSizeInt32El tamaño máximo de mensaje que se ha configurado para la organización o el buzón del destinatario.
ErrorErrorErrores que ocurren durante la acción GetMailTips.

MailboxSettings

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

Tipo: Microsoft.OutlookServices.MailboxSettings

PropiedadTipoDescripción
AutomaticRepliesSettingAutomaticRepliesSettingConfiguración para configurar automáticamente el envío de respuestas a los mensajes entrantes.
TimeZoneCadenaLa zona horaria predeterminada del buzón del usuario.
LanguageLocaleInfoRepresentación de la configuración regional del usuario, como el idioma preferido y el país o región.
WorkingHoursWorkingHoursLos días de la semana y horas de la zona horaria específica en la que trabaja el usuario.

MeetingTimeSuggestion

Una sugerencia de reunión que incluye información como la hora de la reunión, posibilidad de asistencia, disponibilidad individual de los asistentes y ubicaciones de reuniones disponibles.

Tipo: Microsoft.OutlookServices.MeetingTimeSuggestion

PropiedadTipoDescripción
MeetingTimeSlotTimeSlotUn período de tiempo sugerido para la reunión.
ConfidencedobleUn porcentaje que representa la probabilidad de que asistan todos los convocados.
OrganizerAvailabilityFreeBusyStatusDisponibilidad del organizador de la reunión para esta sugerencia de reunión: Free, Tentative, Busy, Oof, WorkingElsewhere, Unknown.
AttendeeAvailabilityColección(AttendeeAvailability)Una matriz que muestra el estado de disponibilidad de cada asistente para esta sugerencia de reunión.
LocationsColecció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.
SuggestionReasonCadenaDescribe 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, tomando como base 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 un candidato de hora de 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 múltiples candidatos para el horario de la reunión, la acción FindMeetingTimes primero ordena 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 tres asistentes con el siguiente estado de disponibilidad:

AsistenteEstado de disponibilidadPosibilidades de asistencia (%)
DanaLibre100 %
PelayoDesconocido49 %
FannyOcupado0 %

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

PropiedadTipoDescripción
MeetingTimeSuggestionsColección(MeetingTimeSuggestion)Un matriz de sugerencias de reunión.
EmptySuggestionsReasonCadenaUna razón para no devolver ninguna sugerencia de reunión. Los valores posibles son: AttendeesUnavailable, LocationsUnavailable, OrganizerUnavailable, AttendeesUnavailableOrUnknown y 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.

ValorRazones
AttendeesUnavailableSe 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 %.
AttendeesUnavailableOrUnknownAlgunos (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.
LocationsUnavailableLa propiedad IsRequired del parámetro LocationConstraint se especifica como obligatoria y aún no hay ninguna ubicación disponible para las franjas horarias calculadas.
OrganizerUnavailableEl parámetro IsOrganizerOptional es falso y el organizador aún no está disponible durante la ventana temporal solicitada.
DesconocidoNo 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

PropiedadTipoDescripción
IsMentionedBooleanoVerdadero 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

PropiedadTipoDescripción
AssignCategoriesColección (cadena)Una lista de categorías que se asignarán a un mensaje.
CopyToFolderCadenaIdentificador de la carpeta donde se va a copiar un mensaje.
EliminarBooleanoIndica si un mensaje se debe mover a la carpeta Elementos eliminados.
ForwardAsAttachmentToCollección(Recipient)Direcciones de correo electrónico de los destinatarios a los que se debe reenviar un mensaje como datos adjuntos.
ForwardToCollección(Recipient)Direcciones de correo electrónico de los destinatarios a los que se debe reenviar un mensaje.
MarkAsReadBooleanoIndica si un mensaje debe marcarse como leído.
MarkImportanceImportanceEstablece la importancia del mensaje, que puede ser: Low, Normal o High.
MoveToFolderCadenaEl identificador de la carpeta a la que se moverá un mensaje.
PermanentDeleteBooleanoIndica si un mensaje se debe eliminar permanentemente sin guardarse en la carpeta Elementos eliminados.
RedirectToRecipientDirección de correo electrónico a la que se debe redirigir un mensaje.
StopProcessingRulesBooleanoIndica 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

PropiedadTipoDescripción
BodyContainsColección (cadena)Representa las cadenas que deben aparecer en el cuerpo de un mensaje entrante para que se aplique la condición o excepción.
BodyOrSubjectContainsColección (cadena)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.
CategoriesColección (cadena)Representa las categorías con las que debe etiquetarse un mensaje entrante para que se aplique la condición o excepción.
FromAddressesCollección(Recipient)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.
HasAttachmentsBooleanoIndica si un mensaje entrante debe tener datos adjuntos para que se aplique la condición o excepción.
HeaderContainsColección (cadena)Representa las cadenas que deben aparecer en los encabezados de un mensaje entrante para que se aplique la condición o excepción.
ImportanceImportance
IsApprovalRequestBooleanoIndica si un mensaje entrante debe ser una solicitud de aprobación para que se aplique la condición o excepción.
IsAutomaticForwardBooleanoIndica si un mensaje entrante debe reenviarse automáticamente para que se aplique la condición o excepción.
IsAutomaticReplyBooleanoIndica si un mensaje entrante debe ser una respuesta automática para que se aplique la condición o excepción.
IsEncryptedBooleanoIndica si un mensaje entrante debe estar cifrado para que se aplique la condición o excepción.
IsMeetingRequestBooleanoIndica si un mensaje entrante debe ser una convocatoria de reunión para que se aplique la condición o excepción.
IsMeetingResponseBooleanoIndica si un mensaje entrante debe ser una respuesta a la reunión para que se aplique la condición o excepción.
IsNonDeliveryReportBooleanoIndica si un mensaje entrante debe ser un informe de no entrega para que se aplique la condición o excepción.
IsPermissionControlledBooleanoIndica si un mensaje entrante debe estar controlado por permisos (protegido por RMS) para que se aplique la condición o excepción.
IsReadReceiptBooleanoIndica si un mensaje entrante debe ser una confirmación de lectura para que se aplique la condición o excepción.
IsSignedBooleanoIndica si un mensaje entrante debe estar firmado con S/MIME para que se aplique la condición o excepción.
IsVoicemailBooleanoIndica si un mensaje entrante debe ser un correo de voz para que se aplique la condición o excepción.
MessageActionFlagMessageActionFlagRepresenta el valor de marca de acción que aparece en un mensaje entrante para que se aplique la condición o excepción.
NotSentToMeBooleanoIndica 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.
ReceipentContainsColección (cadena)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.
SenderContainsColección (cadena)Representa las cadenas que aparecen en la propiedad From de un mensaje entrante para que se aplique la condición o excepción.
SensitivitySensitivityRepresenta 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.
SentCcMeBooleanoIndica 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.
SentOnlyToMeBooleanoIndica 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.
SentToAddressesCollección(Recipient)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.
SentToMeBooleanoIndica 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.
SentToOrCcMeBooleanoIndica 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.
SubjectContainsColección (cadena)Representa las cadenas que aparecen en el asunto de un mensaje entrante para que se aplique la condición o excepción.
WithinSizeRangeSizeRangeEspecifica 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.

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

PropiedadTipoDescripción
DisplayNameCadenaUn nombre que representa una configuración regional por su lenguaje natural, por ejemplo, "Inglés (Estados Unidos)".
LocaleCadenaUna 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

La ubicación de un evento.

Tipo: Microsoft.OutlookServices.Location

PropiedadTipoDescripción
DisplayNameCadenaNombre asociado a la ubicación.
AddressPhysicalAddressLa dirección física de la ubicación.
CoordenadasGeoCoordinatesCoordenadas geográficas y elevación de la ubicación.
LocationEmailAddressCadenaDirección de correo electrónico opcional de la ubicación.

LocationConstraint

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

Tipo: Microsoft.OutlookServices.LocationConstraint

PropiedadTipoDescripción
IsRequiredbooleanoEl cliente solicita al servicio que incluya en la respuesta una ubicación de reunión para la reunión.
SuggestLocationbooleanoEl cliente solicita al servicio que sugiera una o más ubicaciones de reunión.
LocationsColecció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

PropiedadTipoDescripción
ResolveAvailabilitybooleanoSi 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.

MailboxSettings

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

Tipo: Microsoft.OutlookServices.MailboxSettings

PropiedadTipoDescripción
AutomaticRepliesSettingAutomaticRepliesSettingConfiguración para configurar automáticamente el envío de respuestas a los mensajes entrantes.
TimeZoneCadenaLa zona horaria predeterminada del buzón del usuario.
LanguageLocaleInfoRepresentación de la configuración regional del usuario, como el idioma preferido y el país o región.

MeetingTimeSuggestion

Una sugerencia de reunión que incluye información como la hora de la reunión, posibilidad de asistencia, disponibilidad individual de los asistentes y ubicaciones de reuniones disponibles.

Tipo: Microsoft.OutlookServices.MeetingTimeSuggestion

PropiedadTipoDescripción
MeetingTimeSlotTimeSlotUn período de tiempo sugerido para la reunión.
ConfidencedobleUn porcentaje que representa la probabilidad de que asistan todos los convocados.
OrganizerAvailabilityFreeBusyStatusDisponibilidad del organizador de la reunión para esta sugerencia de reunión: Free, Tentative, Busy, Oof, WorkingElsewhere, Unknown.
AttendeeAvailabilityColección(AttendeeAvailability)Una matriz que muestra el estado de disponibilidad de cada asistente para esta sugerencia de reunión.
LocationsColecció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.
SuggestionReasonCadenaDescribe 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, tomando como base 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 un candidato de hora de 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 múltiples candidatos para el horario de la reunión, la acción FindMeetingTimes primero ordena 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 tres asistentes con el siguiente estado de disponibilidad:

AsistenteEstado de disponibilidadPosibilidades de asistencia (%)
DanaLibre100 %
PelayoDesconocido49 %
FannyOcupado0 %

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

PropiedadTipoDescripción
MeetingTimeSuggestionsColección(MeetingTimeSuggestion)Un matriz de sugerencias de reunión.
EmptySuggestionsReasonCadenaUna razón para no devolver ninguna sugerencia de reunión. Los valores posibles son: AttendeesUnavailable, LocationsUnavailable, OrganizerUnavailable, AttendeesUnavailableOrUnknown y 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.

ValorRazones
AttendeesUnavailableSe 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 %.
AttendeesUnavailableOrUnknownAlgunos (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.
LocationsUnavailableLa propiedad IsRequired del parámetro LocationConstraint se especifica como obligatoria y aún no hay ninguna ubicación disponible para las franjas horarias calculadas.
OrganizerUnavailableEl parámetro IsOrganizerOptional es falso y el organizador aún no está disponible durante la ventana temporal solicitada.
DesconocidoNo se conoce el motivo por el que no se devuelven sugerencias de reunión.

Location

La ubicación de un evento.

Tipo: Microsoft.OutlookServices.Location

PropiedadTipoDescripción
DisplayNameCadenaNombre asociado a la ubicación.
AddressPhysicalAddressLa dirección física de la ubicación.
CoordenadasGeoCoordinatesCoordenadas geográficas y elevación de la ubicación.

PatternedRecurrence

Patrón e intervalo de periodicidad.

Tipo: Microsoft.OutlookServices.PatternedRecurrence

PropiedadTipoDescripción
PatternRecurrencePatternLa frecuencia de un evento.
RecurrenceTimeZoneCadenaLa zona horaria de las horas de inicio y fin. Consulte el tipo complejo DateTimeTimeZone para obtener la lista de zonas horarias admitidas.
RangeRecurrenceRangeLa duración de un evento.
PropiedadTipoDescripción
PatternRecurrencePatternLa frecuencia de un evento.
RangeRecurrenceRangeLa duración de un evento.
PropiedadTipoDescripción
PatternRecurrencePatternLa frecuencia de un evento.
RangeRecurrenceRangeLa duración de un evento.

Phone

Representa un número de teléfono.

Tipo: Microsoft.OutlookServices.Phone

PropiedadTipoDescripción
NumbercadenaEl número de teléfono.
TipoCadenaEl 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

PropiedadTipoDescripción
StreetCadenaLa calle.
CityCadenaLa ciudad.
StateCadenaEl estado.
CountryOrRegionCadenaEl país o región. Se trata de un valor de cadena de formato libre, por ejemplo, "Estados Unidos".
PostalCodeCadenaEl 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

PropiedadTipoDescripción
EmailAddressEmailAddressDirección de correo del destinatario.

RecurrencePattern

La frecuencia de un evento.

Tipo: Microsoft.OutlookServices.RecurrencePattern

PropiedadTipoDescripción
TipoRecurrencePatternTypeEl tipo de patrón de periodicidad: Daily = 0, Weekly = 1, AbsoluteMonthly = 2, RelativeMonthly = 3, AbsoluteYearly = 4, RelativeYearly = 5.
Reglas de patrones:
- AbsoluteYearly. Debe establecer el Month y DayOfMonth de la ocurrencia
- RelativeYearly. Debe establecer el índice Month, DaysOfWeeky FirstDayOfWeek
- AbsoluteMonthly. Debe establecer el DayOfMonth
- RelativeMonthly. Debe establecer el índice FirstDayOfWeek índice y el RecurrenceRange.NumberOfOccurrences
- Weekly. Debe establecer el DaysOfWeek y el FirstDayOfWeek
- Daily. No se necesita información adicional del patrón.
IntervalInt32Número de unidades de un tipo de periodicidad determinado entre repeticiones.
DayOfMonthInt32El día del mes en que ocurre el elemento.
MesInt32El mes en que ocurre el elemento. Se trata de un número entre 1 y 12.
DaysOfWeekColecció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.
FirstDayOfWeekDayOfWeekEl día de la semana: domingo = 0, lunes = 1, martes = 2, miércoles = 3, jueves = 4, viernes = 5, sábado = 6.
IndexWeekIndexEl índice de la semana: Primero = 0, Segundo = 1, Tercero = 2, Cuarto = 3, Último = 4.

RecurrenceRange

La duración de un evento.

Tipo: Microsoft.OutlookServices.RecurrenceRange

PropiedadTipoDescripción
TipoRecurrenceRangeTypeEl rango de periodicidad: EndDate = 0, NoEnd = 1, Numbered = 2.
StartDatedatetimeoffsetRequerido: la fecha de inicio de la serie.
EndDatedatetimeoffsetRequerido para los patrones de fecha límite: la fecha de finalización de la serie. Debe ser posterior a la fecha de inicio.
NumberOfOccurrencesInt32Requerido para patrones Numbered: cuántas veces repetir el evento.

ResponseStatus

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

Tipo: Microsoft.OutlookServices.ResponseStatus

PropiedadTipoDescripción
ResponseResponseTypeEl tipo de respuesta: None, Organizer, TentativelyAccepted, Accepted, Declined, NotResponded.
TimedatetimeoffsetLa 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

PropiedadTipoDescripción
MaximumSizeInt32El tamaño máximo (en kilobytes) que un mensaje entrante debe tener para que una condición o excepción se aplique.
MinimumSizeInt32El 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

PropiedadTipoDescripción
ActivityDomainActivityDomainOpcional, la naturaleza de la actividad: Work, Personal, Unrestricted, o Unknown.
TimeslotsColección(TimeSlot)Un matriz de periodos de tiempo.

TimeSlot

Un periodo de tiempo.

Tipo: Microsoft.OutlookServices.TimeSlot

PropiedadTipoDescripción
StartDateTimeTimeZoneCuándo comienza un periodo de tiempo.
EndDateTimeTimeZoneCuándo 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

PropiedadTipoDescripción
AliasCadenaIdentificador de la zona horaria.
DisplayNameCadenaUna cadena de visualización que representa la zona horaria.

Website (versión preliminar)

Representa un sitio web.

Tipo: Microsoft.OutlookServices.Website

PropiedadTipoDescripción
AddressCadenaLa URL del sitio web.
DisplayNameCadenaNombre para mostrar del sitio web.
TipoWebsiteTypeEl 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

PropiedadTipoDescripción
DaysOfWeekColecció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.
StartTimeEdm.TimeOfDayLa hora del día en la que el usuario empieza a trabajar.
EndTimeEdm.TimeOfDayLa hora del día en la que el usuario deja de trabajar.
TimeZoneCadenaZona horaria a la que se aplica el horario laboral. Consulte DateTimeTimeZone para obtener una lista de zonas horarias válidas.

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

PropiedadTipoDescripción
ActivityDomainActivityDomainOpcional, la naturaleza de la actividad: Work, Personal, Unrestricted, o Unknown.
TimeslotsColección(TimeSlot)Un matriz de periodos de tiempo.

TimeSlot

Un periodo de tiempo.

Tipo: Microsoft.OutlookServices.TimeSlot

PropiedadTipoDescripción
StartDateTimeTimeZoneCuándo comienza un periodo de tiempo.
EndDateTimeTimeZoneCuándo finaliza un periodo de tiempo.

Enumeraciones

ActivityDomain | AutomaticRepliesStatus | CategoryColor (versión preliminar) | DayOfWeek | ExternalAudienceScope |
FollowupFlagStatus (versión preliminar) | FreeBusyStatus | InferenceClassificationType | LocationType (versión preliminar) | MailTipsType (versión preliminar) | MessageActionFlag (versión preliminar) | PhoneType (versión preliminar) | RecipientScopeType (versión preliminar) | ReferenceAttachmentPermissions | ReferenceAttachmentProviders | TaskStatus | TimeZoneStandard | WebsiteType

ActivityDomain | AutomaticRepliesStatus | DayOfWeek | ExternalAudienceScope |
FreeBusyStatus | InferenceClassificationType | TaskStatus

ActivityDomain

La naturaleza de una actividad.

Valores admitidos:

  • Work (trabajo)
  • Personal
  • Unrestricted (sin restricciones)
  • Unknown (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 habilitado)
  • Disabled (deshabilitado)
  • Scheduled (programado)

DayOfWeek

El conjunto de días de la semana.

Valores admitidos:

  • Sunday (domingo)
  • Monday (lunes)
  • Tuesday (martes)
  • Wednesday (miércoles)
  • Thursday (jueves)
  • Friday (viernes)
  • Saturday (sábado)

ExternalAudienceScope

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

Valores admitidos:

  • All (todos)
  • ContactsOnly (solo contactos)
  • None (ninguno)

FreeBusyStatus

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

Valores admitidos:

  • Busy (ocupado)
  • Free (libre)
  • Oof
  • Tentative (provisional)
  • Unknown (desconocido)
  • WorkingElsewhere (trabajando en otro lugar)

InferenceClassificationType

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

Valores admitidos:

  • Focused (prioritario)
  • Other (otro)

ActivityDomain

La naturaleza de una actividad.

Valores admitidos:

  • Work (trabajo)
  • Personal
  • Unrestricted (sin restricciones)
  • Unknown (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)
  • Disabled (deshabilitado)
  • Scheduled (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 admitidoColor asignado al cliente de escritorio de Outlook
Preset0Rojo
Preset1Naranja
Preset2Marrón
Preset3Amarillo
Preset4Verde
Preset5Verde azulado
Preset6Oliva
Preset7Azul
Preset8Púrpura
Preset9Arándano
Preset10Acero
Preset11Acero oscuro
Preset12Gris
Preset13Gris oscuro
Preset14Negro
Preset15Rojo oscuro
Preset16Anaranjado oscuro
Preset17Marrón oscuro
Preset18Amarillo oscuro
Preset19Verde oscuro
Preset20Verde azulado oscuro
Preset21Oliva oscuro
Preset22Azul oscuro
Preset23Púrpura oscuro
Preset24Arándano oscuro
NoneNingún color asignado

ExternalAudienceScope

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

Valores admitidos:

  • All (todos)
  • ContactsOnly (solo contactos)
  • None (ninguno)

FollowupFlagStatus (versión preliminar)

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

Valores admitidos:

  • Complete (completo)
  • Flagged (marcado)
  • NotFlagged (sin marcar)

InferenceClassificationType

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

Valores admitidos:

  • Focused (prioritario)
  • Other (otro)

LocationType (versión preliminar)

Los posibles tipos de ubicaciones.

Valores admitidos:

  • Default (predeterminado)
  • ConferenceRoom (sala de conferencias)
  • HomeAddress
  • 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 (tamaño máximo del mensaje)
  • ModerationStatus (estado de moderación)
  • RecipientScope (ámbito de destinatarios)
  • RecipientSuggestions (sugerencias de destinatarios)
  • TotalMemberCount (cantidad de miembros total)

MessageActionFlag (versión preliminar)

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

Valores admitidos:

  • Any (cualquiera)
  • Call (llamar)
  • DoNotForward (no reenviar)
  • FollowUp (seguimiento)
  • FYI (para su información)
  • Forward (reenviar)
  • NoResponseNecessary (respuesta no necesaria)
  • Read (leer)
  • Reply (responder)
  • ReplyToAll (responder a todos)
  • Review (revisar)

PhoneType (versión preliminar)

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

Valores admitidos:

  • Assistant (asistente)
  • Business (empresa)
  • BusinessFax (fax de empresa)
  • Home (personal)
  • HomeFax (fax personal)
  • Mobile (móvil)
  • Other (otro)
  • OtherFax (otro fax)
  • Pager (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:

  • None (ninguno)
  • Internal (interno)
  • External (externo)
  • ExternalPartner (socio externo)
  • ExternalNonPartner (externo no socio)

ReferenceAttachmentPermissions

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

Valores admitidos:

  • Other (otro)
  • View (ver)
  • Edit (editar)
  • AnonymousView (ver anónimo)
  • AnonymousEdit (editar anónimo)
  • OrganizationView (ver organización)
  • OrganizationEdit (editar organización)

ReferenceAttachmentProviders

Posibles proveedores de almacenamiento de archivos para las referencias adjuntas.

Valores admitidos:

  • Dropbox
  • OneDriveBusiness
  • OneDriveConsumer
  • Other (otro)

Sensitivity

Indica el nivel de privacidad.

Valores admitidos:

  • Normal
  • Personal
  • Private (privado)
  • Confidential (confidencial)

TaskStatus

Especifica el estado o el progreso de una tarea.

Valores admitidos:

  • Completed (completada)
  • Deferred (postergada)
  • InProgress (en progreso)
  • 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
  • Home (personal)
  • Other (otro)
  • Profile (perfil)
  • Work (trabajo)

TaskStatus

Especifica el estado o el progreso de una tarea.

Valores admitidos:

  • Completed (completada)
  • Deferred (postergada)
  • InProgress (en progreso)
  • NotStarted (no empezada)
  • WaitingOnOthers (esperando a otras)

Usar 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 entidades en una colección. Este parámetro va en la ruta URL: .../me/calendars/$count

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

Solicitudes de búsqueda

Puede usar el parámetro $search para restringir los resultados de una solicitud a los mensajes que coincidan con una expresión de búsqueda. Los 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.

Nota Puede obtener hasta 250 resultados de una solicitud $search. Puede usar $search solo con mensajes. La búsqueda de contactos y eventos de calendario no se admite.

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."
  }
}
PropiedadDescripción
AttachmentBusca los datos adjuntos especificados por título.
BccBusca en el campo Bcc.
Body o ContentBusca en el campo Body. Solo compatible con búsquedas predeterminadas.
CategoryBusca en el campo Category.
CcBusca en el campo Cc.
FromBusca en el campo From.
HasBusca en el campo HasAttachments.
ParticipantsBusca en los campos To, Ccy Bcc.
ReceivedBusca en el campo Received una fecha específica expresada como MM/DD/AAAA.
SenderBusca en el campo Sender.
SubjectBusca en el campo Subject.
ToBusca 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

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/v2.0/me/messages?$search="pizza"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Solicitudes de filtrado

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

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

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

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

{
  "error":
  {
    "code":"ErrorInvalidUrlQueryFilter",
    "message":"'contains' and 'startswith' are not supported for filtering.  Use Search instead."
  }
}
OperadorTipoEjemplo
andAnd lógico (utilizado para combinar múltiples criterios)TotalCount gt 0 and ChildFolderCount eq 0
orOr lógico (usado para combinar múltiples criterios)TotalCount gt 0 or ChildFolderCount eq 0
eqIgual aIsRead eq false
neNo igual aImportance ne Microsoft.Exchange.Services.OData.Model.Importance'High'
gtMayor queReceivedDateTime gt 2014-09-01T00:00:00Z
geMayor o igual queLastModifiedDateTime ge 2014-09-01T00:00:00Z
ltMenor queReceivedDateTime lt 2014-09-01T00:00:00Z
leMenor o igual queLastModifiedDateTime 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
OperadorTipoEjemplo
andAnd lógico (utilizado para combinar múltiples criterios)TotalCount gt 0 and ChildFolderCount eq 0
orOr lógico (usado para combinar múltiples criterios)TotalCount gt 0 or ChildFolderCount eq 0
eqIgual aIsRead eq false
neNo igual aImportance ne Microsoft.Exchange.Services.OData.Model.Importance'High'
gtMayor queReceivedDateTime gt 2014-09-01T00:00:00Z
geMayor o igual queLastModifiedDateTime ge 2014-09-01T00:00:00Z
ltMenor queReceivedDateTime lt 2014-09-01T00:00:00Z
leMenor o igual queLastModifiedDateTime le 2014-09-01T00:00:00Z

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

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

Para obtener todos los eventos en el calendario 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/v2.0/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/v2.0/me/events?$filter=Subject eq 'Mega Charity Bash'

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

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

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

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

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

GET https://outlook.office.com/api/v2.0/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/v2.0/me/messages?$filter=From/EmailAddress/Address eq 'hr@contoso.com'

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

GET https://outlook.office.com/api/v2.0/me/events?$filter=Start/DateTime%20ge%20%272016-04-01T08:00%27
GET https://outlook.office.com/api/v2.0/me/events?$filter=Subject%20eq%20%27Mega%20Charity%20Bash%27
GET https://outlook.office.com/api/v2.0/me/messages?$filter=IsRead%20eq%20false
GET https://outlook.office.com/api/v2.0/me/messages?$filter=HasAttachments%20eq%20true
GET https://outlook.office.com/api/v2.0/me/messages?$filter=ReceivedDateTime%20ge%202014-09-01
GET https://outlook.office.com/api/v2.0/me/messages?$filter=From/EmailAddress/Address%20eq%20%27hr@contoso.com%27
OperadorTipoEjemplo
andAnd lógico (utilizado para combinar múltiples criterios)TotalCount gt 0 and ChildFolderCount eq 0
orOr lógico (usado para combinar múltiples criterios)TotalCount gt 0 or ChildFolderCount eq 0
eqIgual aIsRead eq false
neNo igual aImportance ne Microsoft.Exchange.Services.OData.Model.Importance'High'
gtMayor queDateTimeReceived gt 2014-09-01T00:00:00Z
geMayor o igual queDateTimeLastModified ge 2014-09-01T00:00:00Z
ltMenor queDateTimeReceived lt 2014-09-01T00:00:00Z
leMenor o igual queDateTimeLastModified le 2014-09-01T00:00:00Z

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Seleccionar propiedades específicas para devolver

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

Nota Al recibir elementos de correo, calendario y contacto, use siempre $select para excluir propiedades innecesarias en la carga útil de respuesta a fin de mantener un rendimiento razonable de la aplicación. Si no incluye un parámetro $select, se devuelven todas las propiedades de los elementos.

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

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

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

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

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

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

Ordenar resultados

Puede ordenar los resultados usando el parámetro de consulta $orderby. Establezca el valor de este parámetro en un nombre de propiedad y, opcionalmente, especifique el orden ascendente (predeterminado) o descendente. Recuerde, no puede usar el parámetro de consulta $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

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/v2.0/me/messages?$orderby=ReceivedDateTime desc

El mismo ejemplo con codificación de URL:

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

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

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

El mismo ejemplo con codificación de URL:

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

Paginar resultados

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

GET https://outlook.office.com/api/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
GET https://outlook.office.com/api/v2.0/me/messages?$top=5

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

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

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

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

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

Contar entidades en una colección

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

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

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

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

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

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

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

El mismo ejemplo con codificación de URL.

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

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

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

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

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

El mismo ejemplo con codificación de URL.

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

Juntando las piezas

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

  • Devuelve solo los elementos con Importance establecido en High.

  • Devuelve solo las propiedades Subject, Sender y ReceivedDateTime.

  • Devuelve solo los primeros cinco mensajes.

Nota La codificación de URL no se utiliza y se han agregado saltos de línea para que el ejemplo sea más fácil de leer.

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

Cuando especifica $filter el servidor deducirá un orden de clasificación para los resultados. Si usa tanto $filter como $orderby, las propiedades en $filter deben figurar primero en el $orderby antes de cualquier otra propiedad, y se deben enumerar en el orden en que aparecen en el parámetro $filter. El siguiente ejemplo muestra una consulta filtrada por las dos propiedades Subject e Importance, y luego ordenadas por las propiedades Subject, Importance y Sender.

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

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

https://outlook.office.com/api/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
  • Devuelve solo los elementos con Importance establecido en High.

  • Devuelve solo las propiedades Subject, Sender y ReceivedDateTime.

  • Devuelve solo los primeros cinco mensajes.

Nota La codificación de URL no se utiliza y se han agregado saltos de línea para que el ejemplo sea más fácil de leer.

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

Cuando especifica $filter el servidor deducirá un orden de clasificación para los resultados. Si usa tanto $filter como $orderby, las propiedades en $filter deben figurar primero en el $orderby antes de cualquier otra propiedad, y se deben enumerar en el orden en que aparecen en el parámetro $filter. El siguiente ejemplo muestra una consulta filtrada por las dos propiedades Subject e Importance, y luego ordenadas por las propiedades Subject, Importance y Sender.

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

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

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

https://outlook.office.com/api/v2.0/me/messages?$filter=Subject%20eq%20%27Good%20Times%27%20AND%20Importance%20eq%20%27High%27&$orderby=Subject,Importance,Sender
  • Devuelve solo los elementos con Importance establecido en High.

  • Devuelve solo las propiedades Subject, Sender y ReceivedDateTime.

  • Devuelve solo los primeros cinco mensajes.

Nota La codificación de URL no se utiliza y se han agregado saltos de línea para que el ejemplo sea más fácil de leer.

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

Cuando especifica $filter el servidor deducirá un orden de clasificación para los resultados. Si usa tanto $filter como $orderby, las propiedades en $filter deben figurar primero en el $orderby antes de cualquier otra propiedad, y se deben enumerar en el orden en que aparecen en el parámetro $filter. El siguiente ejemplo muestra una consulta filtrada por las dos propiedades Subject e Importance, y luego ordenadas por las propiedades Subject, Importance y Sender.

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

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

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

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