Operación GetFolderGetFolder operation

La operación GetFolder obtiene carpetas del almacén de Exchange.The GetFolder operation gets folders from the Exchange store.

Ejemplo de solicitud GetFolderGetFolder request example

DescriptionDescription

El siguiente ejemplo de una solicitud GetFolder muestra cómo obtener un identificador de carpeta, un nombre para mostrar, el número de elementos de esa carpeta, el número de carpetas secundarias y el número de elementos no leídos de la carpeta.The following example of a GetFolder request shows how to obtain a folder identifier, display name, the count of items in that folder, the count of child folders, and the number of unread items in the folder.

CódigoCode

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

Elementos de solicitudRequest elements

Esta solicitud GetFolder incluye los siguientes elementos:This GetFolder request includes the following elements:

Vea el esquema para ver los elementos adicionales que puede usar para formar una solicitud GetFolder .See the schema for additional elements that you can use to form a GetFolder request.

Nota

El esquema que describe este elemento se encuentra en el directorio virtual IIS que hospeda los servicios Web Exchange.The schema that describes this element is located in the IIS virtual directory that hosts Exchange Web Services.

Ejemplo de respuesta GetFolderGetFolder response example

DescriptionDescription

El siguiente ejemplo del cuerpo del Protocolo simple de acceso a objetos (SOAP) muestra una respuesta correcta a la solicitud GetFolder .The following Simple Object Access Protocol (SOAP) body example shows a successful response to the GetFolder request.

Nota

El identificador de la carpeta y la clave de cambio se han abreviado para preservar la legibilidad.The folder ID and the change key have been shortened to preserve readability.

CódigoCode

<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="628" MinorBuildNumber="0" 
                         xmlns:t="https://schemas.microsoft.com/exchange/services/2006/types" />
  </soap:Header>
  <soap:Body>
    <GetFolderResponse xmlns:m="https://schemas.microsoft.com/exchange/services/2006/messages" 
                       xmlns:t="https://schemas.microsoft.com/exchange/services/2006/types" 
                       xmlns="https://schemas.microsoft.com/exchange/services/2006/messages">
      <m:ResponseMessages>
        <m:GetFolderResponseMessage ResponseClass="Success">
          <m:ResponseCode>NoError</m:ResponseCode>
          <m:Folders>
            <t:Folder>
              <t:FolderId Id="AQApA=" ChangeKey="AQAAAB" />
              <t:DisplayName>Inbox</t:DisplayName>
              <t:TotalCount>2</t:TotalCount>
              <t:ChildFolderCount>0</t:ChildFolderCount>
              <t:UnreadCount>2</t:UnreadCount>
            </t:Folder>
          </m:Folders>
        </m:GetFolderResponseMessage>
      </m:ResponseMessages>
    </GetFolderResponse>
  </soap:Body>
</soap:Envelope>

Elementos de respuestaResponse elements

Esta respuesta GetFolder incluye los siguientes elementos:This GetFolder response includes the following elements:

Ejemplo de respuesta de error de GetFolderGetFolder Error response example

DescriptionDescription

El siguiente ejemplo de cuerpo de SOAP muestra una respuesta de error causada por un FolderId incorrecto en la solicitud.The following SOAP body example shows an error response that is caused by an incorrect FolderId in the request.

CódigoCode

<?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="628" MinorBuildNumber="0" 
                         xmlns:t="https://schemas.microsoft.com/exchange/services/2006/types" />
  </soap:Header>
  <soap:Body>
    <GetFolderResponse xmlns:m="https://schemas.microsoft.com/exchange/services/2006/messages" 
                       xmlns:t="https://schemas.microsoft.com/exchange/services/2006/types" 
                       xmlns="https://schemas.microsoft.com/exchange/services/2006/messages">
      <m:ResponseMessages>
        <m:GetFolderResponseMessage ResponseClass="Error">
          <m:MessageText>Id is malformed.</m:MessageText>
          <m:ResponseCode>ErrorInvalidIdMalformed</m:ResponseCode>
          <m:DescriptiveLinkKey>0</m:DescriptiveLinkKey>
          <m:Folders />
        </m:GetFolderResponseMessage>
      </m:ResponseMessages>
    </GetFolderResponse>
  </soap:Body>
</soap:Envelope>

Elementos de respuestaResponse elements

La respuesta de error GetFolder incluye los siguientes elementos:This GetFolder error response includes the following elements:

Diferencias de versiónVersion differences

Para las aplicaciones dirigidas a Exchange Online, Exchange online como parte de Office 365 o a una versión local de Exchange a partir de Exchange 2013, no se devuelven permisos de carpeta cuando el elemento BaseShape tiene un valor de AllProperties en la solicitud de operación GetFolder .For applications that target Exchange Online, Exchange Online as part of Office 365, or an on-premises version of Exchange starting with Exchange 2013, folder permissions are not returned when the BaseShape element has a value of AllProperties in the GetFolder operation request. Para recuperar los permisos de carpeta, agregue el elemento PermissionSet (PermissionSetType) al elemento AdditionalProperties en la solicitud GetFolder .To retrieve folder permissions, add the PermissionSet (PermissionSetType) element to the AdditionalProperties element in the GetFolder request.

Vea tambiénSee also