Operación FindItemFindItem operation

Busca información sobre la operación de EWS de FindItem .Find information about the FindItem EWS operation.

La operación FindItem busca elementos que se encuentran en el buzón de un usuario.The FindItem operation searches for items that are located in a user's mailbox. Esta operación proporciona muchas maneras de filtrar y dar formato a cómo se devuelven los resultados de la búsqueda al autor de la llamada.This operation provides many ways to filter and format how search results are returned to the caller.

Uso de la operación FindItemUsing the FindItem operation

La solicitud de operación FindItem proporciona muchas formas de buscar en un buzón de correo y dar formato a cómo se devuelven los datos en una respuesta.The FindItem operation request provides many ways for you to search a mailbox and format how the data is returned in a response. Puede especificar lo siguiente en una solicitud FindItem :You can specify the following in a FindItem request:

  • Si la búsqueda es un recorrido superficial o eliminado temporalmente.Whether the search is a shallow or soft-deleted traversal. Es necesario especificar esto.Specifying this is required. Tenga en cuenta que un recorrido de eliminación temporal combinado con una restricción de búsqueda dará como resultado la devolución de elementos cero, incluso si hay elementos que coinciden con los criterios de búsqueda.Note that a soft-deleted traversal combined with a search restriction will result in zero items returned, even if there are items that match the search criteria.

  • Forma de respuesta de los elementos.The response shape of items. Identifica las propiedades que se devuelven en la respuesta.This identifies the properties that are returned in the response. Es necesario especificar esto.Specifying this is required.

  • Las carpetas desde las que se va a realizar la búsqueda.The folders from which to perform the search. Es necesario especificar esto.Specifying this is required.

  • El mecanismo de paginación y los tipos de vista para devolver los datos de la vista en las páginas.The paging mechanism and view types for returning view data in pages. Especificar esto es opcional.Specifying this is optional.

  • Opciones para agrupar y ordenar los elementos que se devuelven.Options for grouping and sorting the items that are returned. Especificar esto es opcional.Specifying this is optional.

  • Restricciones de búsqueda o cadenas de sintaxis de consulta avanzada (AQS) para filtrar los elementos que se devuelven.Search restrictions or Advanced Query Syntax (AQS) strings for filtering the items that are returned. Para obtener más información sobre el uso de AQS para búsquedas de índice de contenido, consulte QueryString (cadena).For more information about using AQS for content index searches, see QueryString (String). Especificar esto es opcional.Specifying this is optional.

  • Criterio de ordenación de los elementos devueltos en la respuesta.The sort order for items returned in the response. Especificar esto es opcional.Specifying this is optional.

La operación FindItem devuelve sólo los primeros 512 bytes de cualquier propiedad streamable.The FindItem operation returns only the first 512 bytes of any streamable property. Para Unicode, devuelve los primeros 255 caracteres mediante una cadena Unicode terminada en NULL.For Unicode, it returns the first 255 characters by using a null-terminated Unicode string. No devuelve ninguno de los formatos del cuerpo del mensaje o las listas de destinatarios.It does not return any of the message body formats or the recipient lists. FindItem devolverá un resumen de destinatarios.FindItem will return a recipient summary. Puede usar la operación GetItem para obtener los detalles de un elemento.You can use the GetItem operation to get the details of an item.

FindItem solo devuelve el elemento Name (EmailAddressType) y no devuelve el elemento EmailAddress (NonEmptyStringType) en el elemento Mailbox para los siguientes campos:FindItem returns only the Name (EmailAddressType) element and does not return the EmailAddress (NonEmptyStringType) element in the Mailbox element for the following fields:

  • El campo de para los mensajesThe From field for messages

  • El campo Sender para los mensajesThe Sender field for messages

  • El campo Organizer para los elementos de calendarioThe Organizer field for calendar items

Nota

La operación FindItem puede devolver resultados en un elemento CalendarView .The FindItem operation can return results in a CalendarView element. El elemento CalendarView devuelve elementos de calendario únicos y todas las repeticiones de reuniones periódicas.The CalendarView element returns single calendar items and all occurrences of recurring meetings. Si no se usa un elemento CalendarView , se devuelven los elementos de calendario únicos y los elementos de calendario principal periódicos.If a CalendarView element is not used, single calendar items and recurring master calendar items are returned. Las repeticiones deben expandirse desde el maestro periódico si no se usa un elemento CalendarView .The occurrences must be expanded from the recurring master if a CalendarView element is not used.

La operación FindItem puede usar los encabezados SOAP que se enumeran en la tabla siguiente.The FindItem operation can use the SOAP headers that are listed in the following table.

Tabla 1. Encabezados SOAP de la operación FindItemTable 1. FindItem operation SOAP headers

HeaderHeader ElementoElement DescripciónDescription
DateTimePrecisionDateTimePrecision
DateTimePrecisionDateTimePrecision
Especifica la resolución de los valores de datos/tiempo en respuestas del servidor, en segundos o en milisegundos.Specifies the resolution of data/time values in responses from the server, either in seconds or in milliseconds. Esto es aplicable a una solicitud.This is applicable to a request.
SuplantaciónImpersonation
ExchangeImpersonationExchangeImpersonation
Identifica al usuario que está suplantando la aplicación cliente.Identifies the user whom the client application is impersonating. Esto es aplicable a una solicitud.This is applicable to a request.
MailboxCultureMailboxCulture
MailboxCultureMailboxCulture
Identifica la referencia cultural RFC3066 que se va a usar para obtener acceso al buzón.Identifies the RFC3066 culture to be used to access the mailbox. Esto es aplicable a una solicitud.This is applicable to a request.
RequestVersionRequestVersion
RequestServerVersionRequestServerVersion
Identifica la versión del esquema para la solicitud de operación.Identifies the schema version for the operation request. Esto es aplicable a una solicitud.This is applicable to a request.
ServerVersionServerVersion
ServerVersionInfoServerVersionInfo
Identifica la versión del servidor que respondió a la solicitud.Identifies the version of the server that responded to the request. Esto es aplicable a una respuesta.This is applicable to a response.
TimeZoneContextTimeZoneContext
TimeZoneContextTimeZoneContext
Identifica la zona horaria que se va a usar para todas las respuestas del servidor.Identifies the time zone to be used for all responses from the server. Esto es aplicable a una solicitud.This is applicable to a request.

Ejemplo de solicitud de operación de FindItemFindItem operation request example

El siguiente ejemplo de una solicitud FindItem muestra cómo obtener el identificador de elemento definido por la enumeración IdOnly del elemento BaseShape para los elementos que se encuentran en la carpeta elementos eliminados.The following example of a FindItem request shows how to obtain the item identifier that is defined by the IdOnly enumeration of the BaseShape element for items that are found in the Deleted Items folder.

<?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>
    <FindItem xmlns="https://schemas.microsoft.com/exchange/services/2006/messages"
               xmlns:t="https://schemas.microsoft.com/exchange/services/2006/types"
              Traversal="Shallow">
      <ItemShape>
        <t:BaseShape>IdOnly</t:BaseShape>
      </ItemShape>
      <ParentFolderIds>
        <t:DistinguishedFolderId Id="deleteditems"/>
      </ParentFolderIds>
    </FindItem>
  </soap:Body>
</soap:Envelope>

Los siguientes elementos se usan en la solicitud:The following elements are used in the request:

Para obtener más opciones para un mensaje de solicitud FindItem , explore la jerarquía del esquema.For more options for a FindItem request message, explore the schema hierarchy. Comienza en el elemento FindItem .Start at the FindItem element.

Respuesta correcta a la operación FindItemSuccessful FindItem operation response

En el ejemplo siguiente se muestra una respuesta correcta a la solicitud FindItem .The following example shows a successful response to the FindItem request.

Los elementos de mensaje representan mensajes de correo electrónico y todos los demás elementos que no tienen establecimiento inflexible de tipos en el esquema EWS.Message elements represent email messages and all other items that are not strongly typed by the EWS schema. Elementos como IPM. Uso compartido e IPM. InfoPath se devuelven como elementos del mensaje .Items such as IPM.Sharing and IPM.InfoPath are returned as Message elements. Exchange no devuelve el elemento de elemento base en las respuestas.Exchange does not return the base Item element in responses.

<?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="595" MinorBuildNumber="0" 
                         xmlns:t="https://schemas.microsoft.com/exchange/services/2006/types" />
  </soap:Header>
  <soap:Body>
    <FindItemResponse 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:FindItemResponseMessage ResponseClass="Success">
          <m:ResponseCode>NoError</m:ResponseCode>
          <m:RootFolder TotalItemsInView="10" IncludesLastItemInRange="true">
            <t:Items>
              <t:Message>
                <t:ItemId Id="AS4AUn=" ChangeKey="fsVU4==" />
              </t:Message>
              <t:Message>
                <t:ItemId Id="AS4AUM=" ChangeKey="fsVUA==" />
              </t:Message>
            </t:Items>
          </m:RootFolder>
        </m:FindItemResponseMessage>
      </m:ResponseMessages>
    </FindItemResponse>
  </soap:Body>
</soap:Envelope>

En la respuesta se usan los siguientes elementos:The following elements are used in the response:

Para obtener más opciones para un mensaje de respuesta FindItem , explore la jerarquía del esquema.For more options for a FindItem response message, explore the schema hierarchy. Empiece en el elemento FindItemResponse .Start at the FindItemResponse element.

Respuesta de error de la operación FindItemFindItem operation error response

En el ejemplo siguiente se muestra una respuesta de error a una solicitud FindItem .The following example shows an error response to a FindItem request.

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

Los siguientes elementos se usan en la respuesta de error:The following elements are used in the error response:

Para obtener más opciones para un mensaje de respuesta de error de FindItem , explore la jerarquía del esquema.For more options for a FindItem error response message, explore the schema hierarchy. Empiece en el elemento FindItemResponse .Start at the FindItemResponse element.

Diferencias de versiónVersion differences

Las versiones de Exchange que comienzan con la versión principal 15 y terminan con la compilación 15.0.898.11 devuelven un valor de ErrorInvalidOperation en el elemento ResponseCode cuando se usa la operación FindItem para buscar en varias carpetas de un buzón de archivo.Versions of Exchange starting with major version 15 and ending with build 15.0.898.11 return an ErrorInvalidOperation value in the ResponseCode element when the FindItem operation is used to search multiple folders in an archive mailbox.

Vea tambiénSee also