tipo de recurso de mensaje

  • Artículo

Espacio de nombres: microsoft.graph

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.

Mensaje en una carpeta de buzón.

El número máximo total de destinatarios incluidos en las propiedades toRecipients, ccRecipients y bccRecipients para un único mensaje de correo electrónico enviado desde un buzón de Exchange Online es 500. Para más información, consulte Límites de envíos.

Este recurso admite:

  • La adición de sus propios datos como encabezados de mensaje personalizados de Internet. La adición de encabezados personalizados solo al crear un mensaje y otorgarles un nombre que comience por "x-". Una vez enviado el mensaje, no se pueden modificar los encabezados. Para obtener los encabezados de un mensaje, aplique el $select parámetro consulta en una operación obtener mensaje.
  • La adición de sus propios datos, como las propiedades personalizadas, como extensiones.
  • La suscripción a notificaciones de cambios.
  • El uso de una consulta delta para realizar un seguimiento de adiciones, eliminaciones y actualizaciones incrementales al proporcionar una función delta.

Métodos

Método Tipo devuelto Descripción
Enumerar mensajes Colección message Obtiene todos los mensajes del buzón del usuario que ha iniciado sesión (incluidas las carpetas Elementos eliminados y Otros correos).
Crear mensaje message Permite crear un borrador de un mensaje nuevo.
Obtener mensaje mensaje Lee las propiedades y las relaciones del objeto de mensaje.
Actualizar mensaje Actualiza el objeto de mensaje.
Eliminar Ninguno Elimina el objeto de mensaje.
copy Mensaje Copia un mensaje a una carpeta.
createForward Mensaje Permite crear un borrador de mensaje de reenvío para incluir un comentario o actualizar propiedades de mensaje, todo desde una misma llamada createForward. Después, puede actualizar o enviar el borrador.
createReply Mensaje Permite crear un borrador de mensaje de respuesta para incluir un comentario o actualizar propiedades de mensaje, todo desde una misma llamada createReply. Después, puede actualizar o enviar el borrador.
createReplyAll Mensaje Permite crear un borrador de mensaje de respuesta a todos para incluir un comentario o actualizar propiedades de mensaje, todo desde una misma llamada createReplyAll. Después, puede actualizar o enviar el borrador.
delta Colección message Obtenga un conjunto de mensajes que se agregaron, eliminaron o actualizaron en una carpeta especificada.
forward Ninguno Permite reenviar un mensaje, agregar un comentario o modifica cualquier propiedad actualizable, todo ello en una llamada forward (reenvío). El mensaje se guarda en la carpeta Elementos enviados.
markAsJunk message Marque un mensaje como no deseado. Esta API agrega el remitente a la lista de remitentes bloqueados y mueve el mensaje a la carpeta junk Email, cuando moveToJunk es true.
markAsNotJunk message Marque un mensaje como no basura. Esta API quita el remitente de la lista de remitentes bloqueados y mueve el mensaje a la carpeta Bandeja de entrada , cuando moveToInbox es true.
move Mensaje Mueve un mensaje a una carpeta. Se crea una nueva copia del mensaje en la carpeta de destino.
reply Ninguno Permite responder al remitente de un mensaje, agregar un comentario o modificar propiedades actualizables, todo ello en una llamada reply. El mensaje se guarda en la carpeta Elementos enviados.
replyAll Ninguno Permite responder a todos los destinatarios de un mensaje al especificar un comentario y modificar las propiedades actualizables de la respuesta, todo ello mediante el uso del método replyAll. El mensaje se guarda en la carpeta Elementos enviados.
send Ninguno Envía un borrador de mensaje creado anteriormente. El mensaje se guarda en la carpeta Elementos enviados.
unsubscribe Ninguno Permite enviar un mensaje con los datos y la dirección especificados en el primer comando “mailto” en el encabezado List-Unsubscribe.
Attachments
Enumerar datos adjuntos Colección attachment Permite obtener todos los datos adjuntos de un mensaje.
Agregar datos adjuntos Dato adjunto Agrega un dato adjunto nuevo a un mensaje publicándolo en la colección de datos adjuntos.
Extensiones abiertas
Crear extensión abierta openTypeExtension Crea una extensión abierta y agrega propiedades personalizadas en una instancia nueva o un recurso existente.
Obtener extensión abierta Colección openTypeExtension Obtiene una extensión abierta identificada por el nombre de extensión.
Extensiones de esquema
Agregar valores de extensión de esquema Cree una definición de extensión de esquema y, después, úsela para agregar datos escritos personalizados a un recurso.
Propiedades extendidas
Crear propiedad extendida de valor único mensaje Crea una o más propiedades extendidas de valor único en un mensaje nuevo o existente.
Obtener mensaje con propiedad extendida de valor único mensaje Obtiene mensajes que contienen una propiedad extendida de valor único mediante el uso de $expand o $filter.
Crear propiedad extendida de varios valores mensaje Crea una o más propiedades extendidas de varios valores en un mensaje nuevo o existente.
Obtener mensaje con propiedad extendida de varios valores mensaje Obtiene un mensaje que contiene una propiedad extendida de varios valores mediante el uso de $expand.

Propiedades

Propiedad Tipo Descripción
bccRecipients Colección recipient Los destinatarios Cco: del mensaje.
body itemBody El cuerpo del mensaje. Puede mostrarse en formato de texto o HTML. Conozca más sobre HTML seguro en el cuerpo del mensaje.
bodyPreview String Los primeros 255 caracteres del cuerpo del mensaje. Se muestra en formato de texto. Si el mensaje contiene instancias de mention, esta propiedad también contendría una concatenación de estas menciones.
ccRecipients Colección recipient Los destinatarios Cc: del mensaje.
changeKey String La versión del mensaje.
conversationId String Identificador de la conversación a la que pertenece el correo electrónico.
conversationIndex Edm.Binary Indica la posición del mensaje en la conversación.
createdDateTime DateTimeOffset La fecha y la hora de creación del mensaje.

La información de fecha y hora tiene el formato ISO 8601 y siempre pertenece a la zona horaria UTC. Por ejemplo, la medianoche en la zona horaria UTC del 1 de enero de 2014 sería 2014-01-01T00:00:00Z.
flag followupFlag Valor de marca que indica el estado, la fecha de inicio, la fecha de vencimiento o la fecha de finalización del mensaje.
from recipient El propietario del buzón desde el que se envía el mensaje. En la mayoría de los casos, este valor es igual que el de la propiedad sender, excepto en escenarios de uso compartido o delegación. El valor debe corresponder al buzón real usado. Conozca más sobre el establecimiento de las propiedades from y sender de un mensaje.
hasAttachments Booleano Indica si el mensaje tiene datos adjuntos. Esta propiedad no incluye datos adjuntos insertados, por lo que si un mensaje contiene solo datos adjuntos insertados, esta propiedad es false. Para comprobar la existencia de datos adjuntos insertados, analice la propiedad body para buscar un src atributo, como <IMG src="cid:image001.jpg@01D26CD8.6C05F070">.
id Cadena Identificador único del mensaje. De forma predeterminada, este valor cambia cuando el elemento se mueve de un contenedor (como una carpeta o un calendario) a otro. Para cambiar este comportamiento, use el encabezado Prefer: IdType="ImmutableId". Vea Obtener identificadores inmutables para recursos de Outlook para obtener más información. Solo lectura.
importance importance La importancia del mensaje. Los valores posibles son low, normal, y high.
inferenceClassification inferenceClassificationType La clasificación del mensaje para el usuario, según relevancia inferida, importancia o según una invalidación explícita. Los valores posibles son focused y other.
internetMessageHeaders Colección internetMessageHeader Una colección de encabezados de mensaje definidos por RFC5322. El conjunto incluye encabezados de mensaje que indican la ruta de red realizada por un mensaje desde el remitente hasta el destinatario. También puede contener los encabezados de mensaje personalizados que contienen datos de la aplicación para el mensaje.

Se devuelve solo al aplicar una opción de consulta $select. Solo lectura.
internetMessageId Cadena Identificador del mensaje en el formato especificado por RFC5322. Solo se puede actualizar si isDraft es “true”.
isDeliveryReceiptRequested Booleano Indica si se solicita confirmación de lectura para el mensaje.
isDraft Boolean Indica si el mensaje es un borrador. Un mensaje es un borrador si no se ha enviado todavía.
isRead Booleano Indica si se ha leído el mensaje.
isReadReceiptRequested Booleano Indica si se solicita confirmación de lectura para el mensaje.
lastModifiedDateTime DateTimeOffset La fecha y la hora de la última modificación del mensaje.

La información de fecha y hora tiene el formato ISO 8601 y siempre pertenece a la zona horaria UTC. Por ejemplo, la medianoche en la zona horaria UTC del 1 de enero de 2014 sería 2014-01-01T00:00:00Z.
mentionsPreview mentionsPreview Obtiene información sobre las menciones de un mensaje. Al procesar una solicitud GET /messages, el servidor establece esta propiedad y la incluye de forma predeterminada en la respuesta. El servidor devuelve NULL si no hay menciones en el mensaje. Opcional.
parentFolderId String El identificador único para el mailFolder principal del mensaje.
receivedDateTime DateTimeOffset La fecha y la hora en las que se recibió el mensaje.

La información de fecha y hora tiene el formato ISO 8601 y siempre pertenece a la zona horaria UTC. Por ejemplo, la medianoche en la zona horaria UTC del 1 de enero de 2014 sería 2014-01-01T00:00:00Z.
replyTo Colección recipient Las direcciones de correo electrónico que se utilizan al responder.
sender recipient La cuenta que se utiliza realmente para generar el mensaje. En la mayoría de los casos, este valor es el mismo que el de la propiedad from. Puede establecer esta propiedad como un valor distinto al enviar un mensaje desde un buzón compartido, para un calendario compartido o como delegado. En cualquier caso, el valor debe corresponder al buzón real usado. Conozca más sobre el establecimiento de las propiedades from y sender de un mensaje.
sentDateTime DateTimeOffset La fecha y la hora de envío del mensaje.

La información de fecha y hora tiene el formato ISO 8601 y siempre pertenece a la zona horaria UTC. Por ejemplo, la medianoche en la zona horaria UTC del 1 de enero de 2014 sería 2014-01-01T00:00:00Z.
subject String El asunto del mensaje.
toRecipients Colección recipient Los destinatarios Para: del mensaje.
uniqueBody itemBody La parte del cuerpo del mensaje que es única del mensaje actual. uniqueBody no se devuelve de forma predeterminada, pero se puede recuperar para un mensaje determinado mediante el uso de la ?$select=uniqueBody consulta. Puede mostrarse en formato de texto o HTML.
unsubscribeData Cadena Entradas válidas analizadas desde el encabezado List-Unsubscribe. Son los datos del comando “mail” en el encabezado List-Unsubscribe si la propiedad UnsubscribeEnabled es “true”.
unsubscribeEnabled Booleano Indica si el mensaje permite cancelar la suscripción. Tiene un valor de “true” si el encabezado List-Unsubscribe cumple con rfc-2369.
webLink String La dirección URL para abrir el mensaje en Outlook en la Web.

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 está establecido en 0, el explorador muestra el mensaje en el panel Outlook en la Web revisión.

El mensaje se abre en el explorador si ha iniciado sesión en el buzón a través de Outlook en la Web. Se le pedirá que inicie sesión si aún no ha iniciado sesión con el explorador.

No se puede tener acceso a esta dirección URL desde un iFrame.

Relaciones

Relación Tipo Descripción
attachments Colección attachment Los datos adjuntos fileAttachment y itemAttachment del mensaje.
extensions Colección Extension La colección de extensiones abiertas definidas para el mensaje. Admite valores NULL.
mentions Colección mention Colección de menciones en el mensaje, ordenadas por el elemento createdDateTime desde el más reciente al más antiguo. De forma predeterminada, GET /messages no devuelve esta propiedad si no aplica $expand en la propiedad.
multiValueExtendedProperties Colección multiValueLegacyExtendedProperty La colección de propiedades extendidas de varios valores definidas para el mensaje. Admite un valor NULL.
singleValueExtendedProperties Colección singleValueLegacyExtendedProperty La colección de propiedades extendidas de valor único definidas para el mensaje. Admite valores NULL.

Representación JSON

La siguiente es una representación JSON del recurso

{
  "bccRecipients": [{"@odata.type": "microsoft.graph.recipient"}],
  "body": {"@odata.type": "microsoft.graph.itemBody"},
  "bodyPreview": "string",
  "categories": ["string"],
  "ccRecipients": [{"@odata.type": "microsoft.graph.recipient"}],
  "changeKey": "string",
  "conversationId": "string",
  "conversationIndex": "String (binary)",
  "createdDateTime": "String (timestamp)",
  "flag": {"@odata.type": "microsoft.graph.followupFlag"},
  "from": {"@odata.type": "microsoft.graph.recipient"},
  "hasAttachments": true,
  "id": "string (identifier)",
  "importance": "String",
  "inferenceClassification": "String",
  "internetMessageHeaders": [{"@odata.type": "microsoft.graph.internetMessageHeader"}],
  "internetMessageId": "String",
  "isDeliveryReceiptRequested": true,
  "isDraft": true,
  "isRead": true,
  "isReadReceiptRequested": true,
  "lastModifiedDateTime": "String (timestamp)",
  "mentionsPreview": {"@odata.type": "microsoft.graph.mentionsPreview"},
  "parentFolderId": "string",
  "receivedDateTime": "String (timestamp)",
  "replyTo": [{"@odata.type": "microsoft.graph.recipient"}],
  "sender": {"@odata.type": "microsoft.graph.recipient"},
  "sentDateTime": "String (timestamp)",
  "subject": "string",
  "toRecipients": [{"@odata.type": "microsoft.graph.recipient"}],
  "uniqueBody": {"@odata.type": "microsoft.graph.itemBody"},
  "unsubscribeData": "string",
  "unsubscribeEnabled": true,
  "webLink": "string",

  "attachments": [{"@odata.type": "microsoft.graph.attachment"}],
  "extensions": [{"@odata.type": "microsoft.graph.extension"}],
  "mentions": [{"@odata.type": "microsoft.graph.mention"}],
  "multiValueExtendedProperties": [{"@odata.type": "microsoft.graph.multiValueLegacyExtendedProperty"}],
  "singleValueExtendedProperties": [{"@odata.type": "microsoft.graph.singleValueLegacyExtendedProperty"}]
}

Contenido relacionado