Operación FindFolder

Artículo
03/29/2023

La operación FindFolder usa servicios web de Exchange para buscar subcarpetas de una carpeta identificada y devuelve un conjunto de propiedades que describen el conjunto de subcarpetas.

FindFolder devuelve solo los primeros 512 bytes de cualquier propiedad que se pueda transmitir. Para Unicode, devuelve los primeros 255 caracteres mediante una cadena Unicode terminada en NULL.

Las consultas de recorrido profundo no se pueden realizar en carpetas públicas.

Las restricciones se permiten y solo deben usar las propiedades de carpeta, no las propiedades del elemento. La funcionalidad de ordenación no está disponible para las respuestas FindFolder . Las consultas agrupadas no están disponibles para las consultas FindFolder .

[! NOTA} La operación FindFolder también se usa para buscar carpetas administradas.

Encabezados SOAP

La operación FindFolder puede usar los encabezados SOAP que se enumeran y describen en la tabla siguiente.

Header	Elemento	Descripción
Suplantación	ExchangeImpersonation	Identifica al usuario al que suplanta la aplicación cliente.
MailboxCulture	MailboxCulture	Identifica la referencia cultural RFC3066 que se va a usar para acceder al buzón.
RequestVersion	RequestServerVersion	Identifica la versión del esquema de la solicitud de operación.
ServerVersion	ServerVersionInfo	Identifica la versión del servidor que respondió a la solicitud.
TimeZoneContext	TimeZoneContext	Identifica la zona horaria que se va a usar para todas las respuestas del servidor.

Ejemplo de solicitud FindFolder

En el ejemplo siguiente de una solicitud FindFolder se muestra cómo formar una solicitud para buscar todas las carpetas ubicadas en una bandeja de entrada.

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:t="http://schemas.microsoft.com/exchange/services/2006/types">
  <soap:Body>
    <FindFolder Traversal="Shallow" xmlns="http://schemas.microsoft.com/exchange/services/2006/messages">
      <FolderShape>
        <t:BaseShape>Default</t:BaseShape>
      </FolderShape>
      <ParentFolderIds>
        <t:DistinguishedFolderId Id="inbox"/>
      </ParentFolderIds>
    </FindFolder>
  </soap:Body>
</soap:Envelope>

Con el valor Predeterminado de BaseShape, la respuesta devuelve el nombre de la carpeta, el identificador de carpeta, el número de subcarpetas, el número de carpetas secundarias que se encuentran en la carpeta y el número de elementos no leídos.

Elementos de solicitud FindFolder

Esta solicitud FindFolder incluye los siguientes elementos:

Para obtener más elementos de solicitud FindFolder , vea el esquema.

Ejemplo de respuesta FindFolder

En el siguiente ejemplo de cuerpo de Simple Object Access Protocol (SOAP) se muestra una respuesta correcta a la solicitud FindFolder . La respuesta contiene los elementos que se devuelven cuando se usa el valor Predeterminado de BaseShape .

Nota:

El identificador de carpeta y la clave de cambio se han acortado para conservar la legibilidad.

<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" 
               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
               xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Header>
    <t:ServerVersionInfo MajorVersion="8" MinorVersion="0" MajorBuildNumber="652" MinorBuildNumber="0" 
                         xmlns:t="http://schemas.microsoft.com/exchange/services/2006/types" />
  </soap:Header>
  <soap:Body>
    <FindFolderResponse xmlns:m="http://schemas.microsoft.com/exchange/services/2006/messages" 
                        xmlns:t="http://schemas.microsoft.com/exchange/services/2006/types" 
                        xmlns="http://schemas.microsoft.com/exchange/services/2006/messages">
      <m:ResponseMessages>
        <m:FindFolderResponseMessage ResponseClass="Success">
          <m:ResponseCode>NoError</m:ResponseCode>
          <m:RootFolder TotalItemsInView="1" IncludesLastItemInRange="true">
            <t:Folders>
              <t:Folder>
                <t:FolderId Id="AQAnAH" ChangeKey="AQAAABY" />
                <t:DisplayName>TestFolder</t:DisplayName>
                <t:TotalCount>0</t:TotalCount>
                <t:ChildFolderCount>0</t:ChildFolderCount>
                <t:UnreadCount>0</t:UnreadCount>
              </t:Folder>
            </t:Folders>
          </m:RootFolder>
        </m:FindFolderResponseMessage>
      </m:ResponseMessages>
    </FindFolderResponse>
  </soap:Body>
</soap:Envelope>

Elementos de respuesta FindFolder

Las propiedades que se devuelven en la respuesta vienen determinadas por BaseShape y AdditionalProperties si se usan. Una respuesta FindFolder correcta incluye los siguientes elementos:

Las respuestas FindFolder a una solicitud con la forma de respuesta AllProperties no devolverán los elementos TotalCount y UnreadCount para las búsquedas en carpetas públicas.

Ejemplo de respuesta de error FindFolder

En el siguiente ejemplo de cuerpo SOAP se muestra una respuesta de error que se produce al buscar una carpeta identificada por un identificador de carpeta con formato incorrecto.

<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" 
                 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
                 xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Header>
    <t:ServerVersionInfo MajorVersion="8" MinorVersion="0" MajorBuildNumber="652" MinorBuildNumber="0" 
                         xmlns:t="http://schemas.microsoft.com/exchange/services/2006/types" />
  </soap:Header>
  <soap:Body>
    <FindFolderResponse xmlns:m="http://schemas.microsoft.com/exchange/services/2006/messages" 
                          xmlns:t="http://schemas.microsoft.com/exchange/services/2006/types" 
                          xmlns="http://schemas.microsoft.com/exchange/services/2006/messages">
      <m:ResponseMessages>
        <m:FindFolderResponseMessage ResponseClass="Error">
          <m:MessageText>Id is malformed.</m:MessageText>
          <m:ResponseCode>ErrorInvalidIdMalformed</m:ResponseCode>
          <m:DescriptiveLinkKey>0</m:DescriptiveLinkKey>
        </m:FindFolderResponseMessage>
      </m:ResponseMessages>
    </FindFolderResponse>
  </soap:Body>
</soap:Envelope>

Elementos de respuesta de error FindFolder

La respuesta de error FindFolder incluye los siguientes elementos:

Información adicional

El elemento DisplayName (cadena) de la carpeta siempre se incluye en la forma predeterminada.
El elemento UnreadCount se incluye en las carpetas Tasks y Notes.
Use el valor PropertyTag de 0x672D con un tipo de propiedad integer para identificar una carpeta administrada mediante el elemento ExtendedFieldURI .

Vea también

Buscar carpetas

Compartir a través de