Type de ressource « message »
Espace de noms: microsoft.graph
Importante
Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .
Message dans une ressource mailFolder.
Le nombre maximal de destinataires inclus dans les propriétés toRecipients, ccRecipientset bccRecipients pour un seul message e-mail envoyé à partir d’une boîte aux lettres Exchange Online est 500. Pour plus d’informations, voir Limites d’envoi.
Cette ressource prend en charge les fonctions suivantes :
- Ajouter vos propres données comme en-têtes de message Internet personnalisés. Ajouter des en-têtes personnalisés uniquement lorsque vous créez un message et nommer en commençant par « x- ». Une fois le message envoyé, vous ne pouvez pas modifier les en-têtes. Pour obtenir les en-têtes d’un message, appliquer le
$selectparamètre de requête dans une opérationafficher un message. - Ajout de vos propres données aux propriétés personnalisées à l’aide des extensions.
- Abonnementaux notifications de modification.
- Utilisation de la requête delta pour effectuer le suivi des suppressions, des mises à jour et des ajouts incrémentiels à l’aide de la fonction delta.
Méthodes
| Méthode | Type de retour | Description |
|---|---|---|
| Répertorier des messages | collection message | Obtient tous les messages dans la boîte aux lettres de l’utilisateur connecté (y compris les dossiers Éléments supprimés et Courrier pêle-mêle). |
| Créer un brouillon de message | message | Crée le brouillon d’un nouveau message. |
| Obtenir un message | message | Lis les propriétés et les relations de l’objet « message ». |
| Mettre à jour un message | message | Met à jour l’objet du message. |
| Supprimer le message | Aucun | Supprime l’objet du message. |
| Copier le message | Message | Copie un message vers un dossier. |
| Créer un brouillon pour transférer le message | Message | Créer un brouillon transférer un message à inclure un commentaire ou mettre à jour les propriétés de message dans un appelcreateForward. Vous pouvez ensuite mettre à jour ou envoyer le brouillon. |
| Créer un brouillon pour répondre | Message | Créer un brouillon transférer un message à inclure un commentaire ou mettre à jour les propriétés de message dans un appelcreateReply. Vous pouvez ensuite mettre à jour ou envoyer le brouillon. |
| Créer un brouillon pour répondre à tous | Message | Créer un brouillon transférer un message à inclure un commentaire ou mettre à jour les propriétés de message dans un appelcreateReplyAll. Vous pouvez ensuite mettre à jour ou envoyer le brouillon. |
| Obtenir la fonction message delta | collection message | Obtenez un ensemble de messages qui ont été ajoutés, supprimés ou mis à jour dans un dossier spécifié. |
| Transférer le message | Aucun | Transférer un message, ajouter un commentaire ou modifier les propriétés modifiables dans un appeltransférer. Le message est ensuite enregistré dans le dossier des éléments envoyés. |
| Marquer comme courrier indésirable | message | Marquer un message comme indésirable. Cette API ajoute l’expéditeur à la liste des expéditeurs bloqués et déplace le message vers le dossier Courrier indésirable , quand moveToJunk a la valeur true. |
| Marquer comme non indésirable | message | Marquer un message comme n’étant pas indésirable. Cette API supprime l’expéditeur de la liste des expéditeurs bloqués et déplace le message vers le dossier Boîte de réception , lorsque moveToInbox a la valeur true. |
| Déplacer le message | Message | Déplace le message vers un dossier. Cette API crée une copie du message dans le dossier de destination. |
| Répondre à des messages | Aucun | Transférer un message, ajouter un commentaire ou modifier les propriétés modifiables dans un appelrépondre. Le message est ensuite enregistré dans le dossier des éléments envoyés. |
| Répondre à tous les messages | Aucun | Répondre à tous les destinataires d’un message en spécifiant un commentaire et en modifiant les propriétés modifiables de réponse, tout en utilisant la méthodereplyAll. Le message est ensuite enregistré dans le dossier des éléments envoyés. |
| Envoyer un brouillon de message | Aucune | Envoie un brouillon du message précédemment créé. Le message est ensuite enregistré dans le dossier des éléments envoyés. |
| Message de rappel | message | Rappelez-vous un message dans le dossier Éléments envoyés de la boîte aux lettres de l’utilisateur spécifié. |
| Se désabonner | Aucun | Envoyer un message à l’aide les données et l’adresse spécifiée dans la première commande mailto dans l’en-tête Liste Se désabonner. |
| Supprimer définitivement | Aucune | Supprimez définitivement un message et placez-le dans le dossier Purges du dossier Éléments récupérables de la boîte aux lettres de l’utilisateur. |
| Attachments | ||
| Répertorier les pièces jointes | collectionAttachment | Obtient toutes les pièces jointes d’un message. |
| Add attachment | Attachment | Ajoute une nouvelle pièce jointe à un message en publiant dans la collection d’objets « attachment » . |
| Extensions d’ouverture | ||
| Créer une extension d’ouverture | openTypeExtension | Créer une extension d’ouverture et ajouter des propriétés personnalisées dans une ressource nouvelle ou existante. |
| Obtenir une extension d’ouverture | collection openTypeExtension | Obtenir une extension d’ouverture identifiée par le nom de l’extension. |
| Propriétés étendues | ||
| Créer une propriété à valeur unique | message | Crée une ou plusieurs propriétés étendues à valeur unique dans un message nouveau ou existant. |
| Obtenir une propriété à valeur unique | message | Obtient les messages contenant une propriété étendue à valeur unique à l’aide de $expand ou $filter. |
| Créer une propriété à valeurs multiples | message | Crée une ou plusieurs propriétés étendues à valeurs multiples dans un message nouveau ou existant. |
| Obtenir une propriété à valeurs multiples | message | Obtient un message qui contient une propriété étendue à valeurs multiples à l’aide de $expand. |
Propriétés
| Propriété | Type | Description |
|---|---|---|
| bccRecipients | Collection recipient | Destinataires Cci: du message. |
| corps | itemBody | Corps du message. Il peut avoir le format HTML ou texte. En savoir plus sursauvegarder HTML dans le corps d’un message. |
| bodyPreview | String | Les 255 premiers caractères du corps du message. Il a le format texte. Si le message contient des instances de mentionner, cette propriété doit contenir une concaténation de ces mentions ainsi. |
| ccRecipients | Collection recipient | Destinataires Cc: du message. |
| changeKey | String | Version du message. |
| conversationId | String | ID de la conversation à laquelle appartient l’e-mail. |
| conversationIndex | Edm.Binary | Indique la position du message au sein de la conversation. |
| createdDateTime | DateTimeOffset | Date et heure de la création du message. Les informations de date et d’heure suivent le format ISO 8601 et sont toujours au format UTC. Par exemple, le 1er janvier 2014 à minuit UTC se présente comme suit : 2014-01-01T00:00:00Z. |
| flag | followupFlag | La valeur d’indicateur qui indique le statut, la date de début, la date d’échéance ou la date d’achèvement du message. |
| from | recipient | Le propriétaire de la boîte aux lettres à partir de laquelle le message est envoyé. Dans la plupart des cas, cette valeur est identique à la propriété sender, sauf pour les scénarios de partage ou de délégation. La valeur doit correspondre à la boîte aux lettres réelle utilisée. En savoir plus sur définir les propriétés de «from» et «sender»d’un message. |
| hasAttachments | Boolean | Indique si le message contient des pièces jointes. Cette propriété n’inclut pas les pièces jointes inline. Par conséquent, si un message contient uniquement des pièces jointes inline, cette propriété a la valeur false. Pour vérifier l’existence de pièces jointes inline, analysez la propriété body pour rechercher un src attribut, tel que <IMG src="cid:image001.jpg@01D26CD8.6C05F070">. |
| id | Chaîne | Identificateur unique du message.
Par défaut, cette valeur change lorsque l’élément est déplacé d’un conteneur (tel qu’un dossier ou un calendrier) vers un autre. Pour modifier ce comportement, utilisez l’en-tête Prefer: IdType="ImmutableId". Pour plus d’informations, consultez Obtenir des identificateurs immuables pour les ressources Outlook . En lecture seule. |
| importance | importance | L’importance du message. Les valeurs possibles sont : low, normal ethigh. |
| inferenceClassification | inferenceClassificationType | Le classement du message de l’utilisateur, en fonction de l’importance ou de la pertinence déduite, ou d’un remplacement explicite. Les valeurs possibles sont les suivantes : focused, other. |
| internetMessageHeaders | Collection internetMessageHeader | Une collection d’en-têtes de message définie par RFC5322. Le jeu comporte des en-têtes de message indiquant que le chemin d’accès réseau est pris par un message de l’expéditeur au destinataire. Il peut également contenir des en-têtes de message personnalisées qui contiennent des données de l’application du message. Renvoyé uniquement en appliquant une $selectoption requête. En lecture seule. |
| internetMessageId | Chaîne | ID du message au format spécifié parRFC5322. Mise à jour possible uniquement si isDraft = true. |
| isDeliveryReceiptRequested | Boolean | Indique si une confirmation de lecture est demandée pour le message. |
| isDraft | Booléen | Indique si le message est un brouillon. Un message est un brouillon s’il n’a pas encore été envoyé. |
| isRead | Boolean | Indique si le message a été lu. |
| isReadReceiptRequested | Boolean | Indique si une confirmation de lecture est demandée pour le message. |
| lastModifiedDateTime | DateTimeOffset | Date et heure de la dernière modification du message. Les informations de date et d’heure suivent le format ISO 8601 et sont toujours au format UTC. Par exemple, le 1er janvier 2014 à minuit UTC se présente comme suit : 2014-01-01T00:00:00Z. |
| mentionsPreview | mentionsPreview | Obtenir des informations sur les mentions dans un message. Lors du traitement d’une GET /messages demander, le serveur définit cette propriété et inclut la réponse par défaut. Le serveur renvoie la valeur null s’il n’existe aucune mentions dans le message. Facultatif. |
| parentFolderId | String | Identificateur unique de l’objet mailFolder parent du message. |
| receivedDateTime | DateTimeOffset | Date et heure de réception du message. Les informations de date et d’heure suivent le format ISO 8601 et sont toujours au format UTC. Par exemple, le 1er janvier 2014 à minuit UTC se présente comme suit : 2014-01-01T00:00:00Z. |
| replyTo | Collection recipient | Adresses e-mail à utiliser lors de la réponse. |
| sender | recipient | Compte réellement utilisé pour générer le message. Dans la plupart des cas, cette valeur est identique à la propriété de. Vous pouvez définir cette propriété à une valeur différente lorsque vous envoyez un message à partir d’une boîte aux lettres partagéepour un calendrier partagé, ou comme délégué. Dans tous les cas, la valeur doit correspondre à la boîte aux lettres réelle utilisée. En savoir plus sur définir les propriétés de «from» et «sender»d’un message. |
| sentDateTime | DateTimeOffset | Date et heure d’envoi du message. Les informations de date et d’heure suivent le format ISO 8601 et sont toujours au format UTC. Par exemple, le 1er janvier 2014 à minuit UTC se présente comme suit : 2014-01-01T00:00:00Z. |
| sujet | String | Objet du message. |
| toRecipients | Collection recipient | Destinataires À: du message. |
| uniqueBody | itemBody | Partie du corps du message unique au message en cours.
uniqueBody n’est pas retourné par défaut, mais peut être récupéré pour un message donné à l’aide de la ?$select=uniqueBody requête. Il peut avoir le format HTML ou texte. |
| UnsubscribeData | Chaîne | Les entrées valides analysées à partir de l’en-tête Liste Se Désabonner. Il s’agit des données de la commande de courrier dans l’en-tête Liste Se Désabonner si la propriété UnsubscribeEnabled est true. |
| UnsubscribeEnabled | Booléen | Indique si le message est activé pour annuler l’abonnement. Sa valueTrue si l’en-tête Liste Se désabonner est conforme aux rfc 2369. |
| webLink | Chaîne | L’URL permettant d’ouvrir le message dans Outlook sur le web. Vous pouvez ajouter un argument ispopout à la fin de l’URL pour modifier l’affichage du message. Si l’argument ispopout n’existe pas ou s’il est défini sur 1, le message s’affiche dans une fenêtre contextuelle. Si ispopout a la valeur 0, le navigateur affiche le message dans le volet de révision d’Outlook sur le web. Le message s’ouvre dans le navigateur si vous êtes connecté à votre boîte aux lettres via Outlook sur le web. Vous êtes invité à vous connecter si vous n’êtes pas déjà connecté avec le navigateur. Impossible d’accéder à cette URL à partir d’un iFrame. |
Relations
| Relation | Type | Description |
|---|---|---|
| pièces jointes | collection attachment | Pièces jointes fileAttachment et itemAttachment du message. |
| extensions | collection Extension | Collection des extensions d’ouverture définies pour le message. Pouvant accepter la valeur Null. |
| mentions | collectionmention | Un ensemble de mentions dans le message, triées par le createdDateTime à partir du plus récent au plus ancien. Par défaut, un GET /messages ne renvoie pas cette propriété, sauf si vous appliquez $expand sur la propriété. |
| multiValueExtendedProperties | collection multiValueLegacyExtendedProperty | Collection des propriétés étendues à valeurs multiples définies pour le message. Pouvant accepter la valeur Null. |
| singleValueExtendedProperties | collection singleValueLegacyExtendedProperty | Collection des propriétés étendues à valeur unique définies pour le message. Pouvant accepter la valeur Null. |
Représentation JSON
Voici une représentation JSON de la ressource.
{
"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"}]
}
Contenu connexe
- Obtenir des paramètres de boîte aux lettres
- Mettre à jour des paramètres de boîte aux lettres
- Utiliser la requête delta pour suivre les modifications apportées aux données Microsoft Graph
- Obtenir des modifications incrémentielles de messages dans un dossier
- Ajout de données personnalisées à des ressources à l’aide des extensions
- Ajout de données personnalisées à des utilisateurs à l’aide des extensions d’ouverture
- Ajout de données personnalisées à des groupes à l’aide des extensions de schéma