Notifications de flux concernant les événements de boîte aux lettres à l'aide de EWS dans Exchange
Découvrez comment utiliser l’API managée EWS ou EWS pour vous abonner aux notifications de streaming et obtenir des événements.
EWS dans Exchange utilise des notifications de streaming pour recevoir des notifications envoyées par le serveur via une connexion qui reste ouverte pendant une période spécifiée.
Si vous vous abonnez aux notifications de streaming à l’aide de l’API managée EWS, vous vous abonnez et recevez des notifications de streaming à l’aide de la méthode SubscribeToStreamingNotifications . Vous créez ensuite une connexion à l’abonnement à l’aide de l’objet StreamingSubscriptionConnection .
Pour vous abonner aux notifications de streaming à l’aide d’EWS, vous créez un abonnement à l’aide de l’opération S’abonner, analysez la réponse, puis obtenez les notifications de streaming à l’aide de la demande d’opération GetStreamingEvents .
Une fois que le client a reçu des notifications d’éléments modifiés ou créés sur le serveur, l’étape suivante consiste à synchroniser les modifications.
S’abonner aux notifications de streaming et les obtenir à l’aide de l’API managée EWS
L’exemple de code suivant montre comment utiliser la méthode SubscribeToStreamingNotifications pour s’abonner aux notifications de streaming pour tous les événements dans le dossier Boîte de réception. Il crée ensuite une connexion pour l’abonnement en créant un objet StreamingSubscriptionConnection . Dans cet exemple, nous supposons que le service est une liaison ExchangeService valide.
// Subscribe to streaming notifications in the Inbox.
StreamingSubscription = service.SubscribeToStreamingNotifications(
new FolderId[] { WellKnownFolderName.Inbox },
EventType.NewMail,
EventType.Created,
EventType.Deleted,
EventType.Modified,
EventType.Moved,
EventType.Copied,
EventType.FreeBusyChanged);
// Create a streaming connection to the service object, over which events are returned to the client.
// Keep the streaming connection open for 30 minutes.
StreamingSubscriptionConnection connection = new StreamingSubscriptionConnection(service, 30);
connection.AddSubscription(StreamingSubscription);
connection.OnNotificationEvent += OnNotificationEvent;
connection.OnDisconnect += OnDisconnect;
connection.Open();
Une fois que vous avez reçu des événements du serveur, l’étape suivante consiste à synchroniser ces modifications avec le serveur. Utilisez l’une des méthodes de désabonnement répertoriées dans le tableau 4 pour mettre fin à l’abonnement avec le serveur lorsque l’abonnement n’est plus nécessaire.
S’abonner aux notifications de streaming à l’aide d’EWS
L’exemple suivant montre une requête XML envoyée par le client au serveur lorsque le client appelle l’opération Subscribe pour s’abonner à tous les EventTypes dans le dossier Boîte de réception. Il s’agit également de la requête XML que l’API managée EWS envoie lorsque vous utilisez la méthode SubscribeToStreamingNotifications pour vous abonner aux notifications de streaming.
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:m="https://schemas.microsoft.com/exchange/services/2006/messages"
xmlns:t="https://schemas.microsoft.com/exchange/services/2006/types"
xmlns:soap="https://schemas.xmlsoap.org/soap/envelope/">
<soap:Header>
<t:RequestServerVersion Version="Exchange2013" />
</soap:Header>
<soap:Body>
<m:Subscribe>
<m:StreamingSubscriptionRequest>
<t:FolderIds>
<t:DistinguishedFolderId Id="inbox" />
</t:FolderIds>
<t:EventTypes>
<t:EventType>NewMailEvent</t:EventType>
<t:EventType>CreatedEvent</t:EventType>
<t:EventType>DeletedEvent</t:EventType>
<t:EventType>ModifiedEvent</t:EventType>
<t:EventType>MovedEvent</t:EventType>
<t:EventType>CopiedEvent</t:EventType>
<t:EventType>FreeBusyChangedEvent</t:EventType>
</t:EventTypes>
</m:StreamingSubscriptionRequest>
</m:Subscribe>
</soap:Body>
</soap:Envelope>
L’exemple XML suivant montre le message SubscribeResponse envoyé du serveur au client en réponse à la demande d’opération Subscribe . L’inclusion de la valeur NoError pour l’élément ResponseCode signifie que l’abonnement a été créé avec succès. L’élément SubscriptionId identifie de façon unique l’abonnement aux notifications de streaming sur le serveur.
<?xml version="1.0" encoding="utf-8"?>
<s:Envelope xmlns:s="https://schemas.xmlsoap.org/soap/envelope/">
<s:Header>
<h:ServerVersionInfo MajorVersion="15"
MinorVersion="0"
MajorBuildNumber="785"
MinorBuildNumber="6"
Version="V2_6"
xmlns:h="https://schemas.microsoft.com/exchange/services/2006/types"
xmlns="https://schemas.microsoft.com/exchange/services/2006/types"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
</s:Header>
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<m:SubscribeResponse xmlns:m="https://schemas.microsoft.com/exchange/services/2006/messages"
xmlns:t="https://schemas.microsoft.com/exchange/services/2006/types">
<m:ResponseMessages>
<m:SubscribeResponseMessage ResponseClass="Success">
<m:ResponseCode>NoError</m:ResponseCode>
<m:SubscriptionId>JgBibjFwcjAzbWIyMDIubmFtcHJkMDMucHJvZC5vdXRsb29rLmNvbRAAAADwXxVesOnHS5BxUHKwAW88SHjwd1iB0Ag=</m:SubscriptionId>
</m:SubscribeResponseMessage>
</m:ResponseMessages>
</m:SubscribeResponse>
</s:Body>
</s:Envelope>
Après avoir créé l’abonnement, vous pouvez maintenant obtenir les événements diffusés en continu à l’aide de l’Id d’abonnement retourné dans le message SubscribeResponse .
Obtenir des événements de streaming à l’aide d’EWS
L’exemple XML suivant montre le message de demande d’opération GetStreamingEvents que le client envoie au serveur pour obtenir des notifications pour l’SubscriptionId retourné dans le message SubscribeResponse . La demande d’opération GetStreamingEvents indique que la durée de la connexion est de 30 minutes.
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:m="https://schemas.microsoft.com/exchange/services/2006/messages"
xmlns:t="https://schemas.microsoft.com/exchange/services/2006/types"
xmlns:soap="https://schemas.xmlsoap.org/soap/envelope/">
<soap:Header>
<t:RequestServerVersion Version="Exchange2013" />
</soap:Header>
<soap:Body>
<m:GetStreamingEvents>
<m:SubscriptionIds>
<t:SubscriptionId>JgBibjFwcjAzbWIyMDIubmFtcHJkMDMucHJvZC5vdXRsb29rLmNvbRAAAADwXxVesOnHS5BxUHKwAW88SHjwd1iB0Ag=</t:SubscriptionId>
</m:SubscriptionIds>
<m:ConnectionTimeout>30</m:ConnectionTimeout>
</m:GetStreamingEvents>
</soap:Body>
</soap:Envelope>
L’exemple XML suivant montre le message GetStreamingEventsResponse envoyé du serveur au client en réponse à la demande d’opération GetStreamingEvents . Il contient un CreatedEvent et un NewMailEvent pour l’élément, et un ModifiedEvent pour le dossier, qui se produisent tous lors de la réception d’un nouveau message.
<?xml version="1.0" encoding="utf-8"?>
<s:Envelope xmlns:s="https://schemas.xmlsoap.org/soap/envelope/">
<s:Header>
<h:ServerVersionInfo MajorVersion="15"
MinorVersion="0"
MajorBuildNumber="785"
MinorBuildNumber="6"
Version="V2_6"
xmlns:h="https://schemas.microsoft.com/exchange/services/2006/types"
xmlns="https://schemas.microsoft.com/exchange/services/2006/types"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
</s:Header>
<soap:Body xmlns:soap="https://schemas.xmlsoap.org/soap/envelope/">
<m:GetStreamingEventsResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:t="https://schemas.microsoft.com/exchange/services/2006/types"
xmlns:m="https://schemas.microsoft.com/exchange/services/2006/messages">
<m:ResponseMessages>
<m:GetStreamingEventsResponseMessage ResponseClass="Success">
<m:ResponseCode>NoError</m:ResponseCode>
<m:Notifications>
<m:Notification>
<t:SubscriptionId>JgBibjFwcjAzbWIyMDIubmFtcHJkMDMucHJvZC5vdXRsb29rLmNvbRAAAADwXxVesOnHS5BxUHKwAW88SHjwd1iB0Ag=</t:SubscriptionId>
<t:CreatedEvent>
<t:TimeStamp>2013-09-16T04:31:29Z</t:TimeStamp>
<t:ItemId Id="AAMkADkzNjJjODUzLWZhMDMtNDVkMS05ZDdjLWVmMDlkYjQ1Zjc4MwBGAAAAAABSSWVKrmGUTJE+MVIvofglBwDZGACZQpSgSpyNkexYe2b7AAAAAAENAADZGACZQpSgSpyNkexYe2b7AAANGFYwAAA=" ChangeKey="CQAAAA==" />
<t:ParentFolderId Id="AQMkADkzNjJjODUzLWZhMDMtNDVkMS05ZDdjLWVmMDlkYjQ1Zjc4MwAuAAADUkllSq5hlEyRPjFSL6H4JQEA2RgAmUKUoEqcjZHsWHtm+wAAAgENAAAA" ChangeKey="AQAAAA==" />
</t:CreatedEvent>
<t:NewMailEvent>
<t:TimeStamp>2013-09-16T04:31:29Z</t:TimeStamp>
<t:ItemId Id="AAMkADkzNjJjODUzLWZhMDMtNDVkMS05ZDdjLWVmMDlkYjQ1Zjc4MwBGAAAAAABSSWVKrmGUTJE+MVIvofglBwDZGACZQpSgSpyNkexYe2b7AAAAAAENAADZGACZQpSgSpyNkexYe2b7AAANGFYwAAA=" ChangeKey="CQAAAA==" />
<t:ParentFolderId Id="AQMkADkzNjJjODUzLWZhMDMtNDVkMS05ZDdjLWVmMDlkYjQ1Zjc4MwAuAAADUkllSq5hlEyRPjFSL6H4JQEA2RgAmUKUoEqcjZHsWHtm+wAAAgENAAAA" ChangeKey="AQAAAA==" />
</t:NewMailEvent>
<t:ModifiedEvent>
<t:TimeStamp>2013-09-16T04:31:29Z</t:TimeStamp>
<t:FolderId Id="AQMkADkzNjJjODUzLWZhMDMtNDVkMS05ZDdjLWVmMDlkYjQ1Zjc4MwAuAAADUkllSq5hlEyRPjFSL6H4JQEA2RgAmUKUoEqcjZHsWHtm+wAAAgENAAAA" ChangeKey="AQAAAA==" />
<t:ParentFolderId Id="AQMkADkzNjJjODUzLWZhMDMtNDVkMS05ZDdjLWVmMDlkYjQ1Zjc4MwAuAAADUkllSq5hlEyRPjFSL6H4JQEA2RgAmUKUoEqcjZHsWHtm+wAAAgEJAAAA" ChangeKey="AQAAAA==" />
<t:UnreadCount>1</t:UnreadCount>
</t:ModifiedEvent>
</m:Notification>
</m:Notifications>
</m:GetStreamingEventsResponseMessage>
</m:ResponseMessages>
</m:GetStreamingEventsResponse>
</soap:Body>
Une fois que vous avez reçu des événements du serveur, l’étape suivante consiste à synchroniser ces modifications avec le serveur. Utilisez l’opération De désabonnement pour mettre fin à l’abonnement auprès du serveur lorsque l’abonnement n’est plus nécessaire.
Étapes suivantes
Une fois que vous avez reçu des notifications, vous pouvez synchroniser la hiérarchie des dossiers ou synchroniser le contenu du dossier qui a changé.
Voir aussi
Abonnements à des notifications, événements de boîte aux lettres et EWS dans Exchange
Conserver l’affinité entre un groupe d'abonnements et le serveur de boîtes aux lettres dans Exchange
Gestion des erreurs liées à la notification dans EWS dans Exchange
Synchronisation de la boîte aux lettres et les services EWS d'Exchange
Commentaires
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultez https://aka.ms/ContentUserFeedback.
Envoyer et afficher des commentaires pour