Notificaciones de transmisión de eventos de buzón usando EWS en Exchange
Obtenga información sobre cómo usar la API administrada de EWS o EWS para suscribirse a notificaciones de streaming y obtener eventos.
EWS en Exchange usa notificaciones de streaming para recibir notificaciones enviadas por el servidor a través de una conexión que permanece abierta durante un período de tiempo especificado.
Si se suscribe a las notificaciones de streaming mediante la API administrada de EWS, puede suscribirse y obtener notificaciones de streaming mediante el método SubscribeToStreamingNotifications . A continuación, cree una conexión a la suscripción mediante el objeto StreamingSubscriptionConnection .
Para suscribirse a notificaciones de streaming mediante EWS, cree una suscripción mediante la operación Suscribirse, analice la respuesta y, a continuación, obtenga las notificaciones de streaming mediante la solicitud de operación GetStreamingEvents .
Una vez que el cliente recibe notificaciones de elementos cambiados o creados en el servidor, el siguiente paso es sincronizar los cambios.
Suscribirse a y obtener notificaciones de streaming mediante la API administrada de EWS
En el ejemplo de código siguiente se muestra cómo usar el método SubscribeToStreamingNotifications para suscribirse a notificaciones de streaming para todos los eventos de la carpeta Bandeja de entrada. A continuación, crea una conexión para la suscripción mediante la creación de un objeto StreamingSubscriptionConnection . En este ejemplo, se supone que el servicio es un enlace ExchangeService válido.
// 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();
Una vez que haya recibido eventos del servidor, el siguiente paso es sincronizar esos cambios con el servidor. Use uno de los métodos de cancelación de suscripción enumerados en la tabla 4 para finalizar la suscripción con el servidor cuando la suscripción ya no sea necesaria.
Suscribirse a notificaciones de streaming mediante EWS
En el ejemplo siguiente se muestra una solicitud XML enviada por el cliente al servidor cuando el cliente llama a la operación Subscribe para suscribirse a todos los EventTypes de la carpeta Bandeja de entrada. Esta es también la solicitud XML que la API administrada de EWS envía cuando se usa el método SubscribeToStreamingNotifications para suscribirse a las notificaciones 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>
En el ejemplo XML siguiente se muestra el mensaje SubscribeResponse que se envía desde el servidor al cliente en respuesta a la solicitud de operación Subscribe . La inclusión del valor NoError para el elemento ResponseCode significa que la suscripción se creó correctamente. El elemento SubscriptionId identifica de forma única la suscripción de notificación de streaming en el servidor.
<?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>
Después de crear la suscripción, ahora puede obtener los eventos transmitidos mediante el valor de SubscriptionId devuelto en el mensaje SubscribeResponse .
Obtención de eventos de streaming mediante EWS
En el ejemplo XML siguiente se muestra el mensaje de solicitud de operación GetStreamingEvents que el cliente envía al servidor para obtener notificaciones para el SubscriptionId devuelto en el mensaje SubscribeResponse . La solicitud de operación GetStreamingEvents indica que la longitud de la conexión es de 30 minutos.
<?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>
En el ejemplo XML siguiente se muestra el mensaje GetStreamingEventsResponse que se envía desde el servidor al cliente en respuesta a la solicitud de operación GetStreamingEvents . Contiene un CreatedEvent y un NewMailEvent para el elemento, y un ModifiedEvent para la carpeta, todos los cuales se producen cuando se recibe un mensaje nuevo.
<?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>
Una vez que haya recibido eventos del servidor, el siguiente paso es sincronizar esos cambios con el servidor. Use la operación Cancelar suscripción para finalizar la suscripción con el servidor cuando la suscripción ya no sea necesaria.
Pasos siguientes
Después de recibir notificaciones, puede sincronizar la jerarquía de carpetas o sincronizar el contenido de la carpeta que cambió.
Vea también
Suscripciones de notificación, eventos de buzón, y EWS en Exchange
Notificaciones de extracción de eventos de buzón utilizando EWS en Exchange
Mantener la afinidad entre un grupo de suscripciones y el servidor del buzón de Exchange
Manejo de errores relacionados con la notificación en EWS in Exchange
Comentarios
Próximamente: A lo largo de 2024 iremos eliminando gradualmente GitHub Issues como mecanismo de comentarios sobre el contenido y lo sustituiremos por un nuevo sistema de comentarios. Para más información, vea: https://aka.ms/ContentUserFeedback.
Enviar y ver comentarios de