Usar la API de REST de Correo de Outlook

  • Artículo

Importante

Las API de la versión /beta de Microsoft Graph están sujetas a cambios. No se admite el uso de estas API en aplicaciones de producción. Para determinar si una API está disponible en la versión 1.0, use el selector de Versión.

Microsoft Graph permite que su aplicación obtenga acceso autorizado a los datos de correo de Outlook de un usuario en una cuenta personal o de organización. Con los permisos de correo delegado o de aplicación adecuados, la aplicación puede acceder a los datos de correo del usuario que ha iniciado sesión o de cualquier usuario de un inquilino. Para obtener más información sobre los tokens de acceso, el registro de aplicaciones y los permisos delegados y de aplicación, consulte Conceptos básicos de autenticación y autorización.

La API de Microsoft Graph es compatible con el acceso a los datos del buzón principal y los buzones compartidos de los usuarios. Los datos pueden ser contactos personales, de correo electrónico o de calendario almacenados en un buzón en la nube de Exchange Online como parte de Microsoft 365 o en Exchange local en una implementación híbrida.

La API no permite el acceso a buzones de archivo locales, ni en Exchange Online ni en Exchange Server.

Uso de la API de REST de correo

Se realizan solicitudes de API de correo en nombre de un usuario que puede identificarse por la propiedad de id. de un usuario (un GUID único), la dirección de correo electrónico o el alias de acceso directo me para el usuario que ha iniciado sesión.

Email mensajes se representan mediante el recurso de mensaje y se organizan en una mailFolder. Los mensajes y las carpetas de correo se identifican mediante su propiedad id , que se puede obtener de GET las operaciones.

Importante

En general, no se debe suponer que los id. message y mailfolder son únicos e inmutables (no cambian) dentro de un buzón. Pueden cambiar tras determinadas acciones como copiar o mover. Puede optar por usar id. inmutables para conservar el mismo id siempre que el mensaje permanezca en el mismo buzón, con unas pocas excepciones como enviar un borrador del mensaje. Para obtener más información, vea duración de los id. inmutables.

Los cuerpos del mensaje se pueden mostrar en formato de texto o HTML.

Puede usar nombres de carpeta conocidos (como Inbox, Drafts, SentItems o DeletedItems) para identificar ciertas carpetas de correo que existen de forma predeterminada para todos los usuarios. Para obtener una lista de los nombres de carpeta conocidos compatibles, vea Tipo de recurso mailFolder.

Por ejemplo, puede obtener los mensajes en la carpeta Elementos enviados de Outlook del usuario que inició la sesión, sin obtener primero el id. de carpeta:

GET /me/mailFolders('SentItems')/messages?$select=sender,subject

Casos de uso comunes

El recurso message expone propiedades como categories, conversationId, flag e importance que corresponden a las funciones disponibles en la interfaz de usuario, lo que permite a las aplicaciones automatizarse o integrarse con la experiencia de usuario integrada de Outlook.

La API de Microsoft Graph también proporciona métodos y acciones que admiten casos de uso común de mensajes.

Casos de uso Recursos de REST Consulte también
Acciones centradas en el usuario
Borrador, leer, responder, reenviar, enviar, actualizar o eliminar los mensajes message Métodos de message
Delegar a otro usuario para enviar mensajes en nombre del propietario del buzón message Establecer las propiedades de y remitente en un mensaje
Permitir que el usuario vea primero los mensajes más importantes inferenceClassificationOverride Bandeja de entrada Prioritarios
Consultar mensajes y obtenerlos en una carpeta de búsqueda mailSearchFolder Métodos de mailSearchFolder
Obtener el contenido MIME de un mensaje o los datos adjuntos de un mensaje message Obtener Contenido MIME
Enviar mensajes con contenido MIME message Enviar contenido MIME
Agregar, obtener o eliminar datos adjuntos de un mensaje attachment,
fileAttachment,
itemAttachment,
referenceAttachment,
message		 Métodos de attachment
Obtener las opciones de idioma y zona horaria de un usuario localeInfo,
timeZoneInformation		 supportedLanguages,
supportedTimeZones
Obtener o actualizar la configuración regional, la zona horaria, el horario laboral o la respuesta automática de un usuario mailboxSettings,
automaticRepliesSetting,
localeInfo,
workingHours		 Obtener la configuración del buzón del usuario,
Actualizar la configuración del buzón del usuario,
Obtener sugerencias de correo electrónico del estado especial de otros destinatarios, como fuera de la oficina user,
mailTips		 Get MailTips
Avisar al usuario si se le menciona en otros mensajes (versión preliminar) mention (versión preliminar) Obtener detalles de @menciones en un mensaje
Cancelar la suscripción de un usuario de una lista de distribución de correo electrónico (versión preliminar) message (versión preliminar) Unsubscribe
Administración de carpetas y correo
Organizar los mensajes en una jerarquía de carpetas del correo mailFolder Métodos de mailFolder
Clasificar mensajes por categorías outlookCategory Métodos de outlookCategory
Usar reglas de la Bandeja de entrada para automatizar acciones, como el reenvío de mensajes entrantes específicos messageRule Métodos de messageRule
Obtener los encabezados de mensajes de Internet de un mensaje message Permite obtener la propiedad internetMessageHeaders de un mensaje.
Buscar y filtrar mensajes message Parámetros de consulta
Obtener notificaciones de los cambios en los mensajes de una carpeta subscription Trabajar con webhooks en Microsoft Graph
Sincronizar la jerarquía de carpetas del correo o los mensajes message Obtener los cambios incrementales en los mensajes de una carpeta
Desarrollo de aplicaciones
Agregar datos personalizados de aplicaciones como encabezados de mensajes de Internet de un mensaje message Permite agregar datos personalizados a la colección internetMessageHeaders del mensaje.
Agregar datos personalizados de aplicaciones a un mensaje mediante el uso de extensiones openTypeExtension,
schemaExtension		 Agregar datos personalizados a los recursos mediante extensiones
Datos personalizados de acceso para las propiedades de MAPI de Outlook subexpuestas singleValueLegacyExtendedProperty,
multiValueLegacyExtendedProperty		 Información general sobre las propiedades extendidas de Outlook

Siguientes pasos

La API de correo puede ofrecer nuevas formas de comunicarse con los usuarios: