Operação GetHoldOnMailboxes
Importante
A partir de 1º de abril de 2020, a operação GetHoldOnMailboxes não estará mais disponível no Exchange Online. Essa operação não será afetada em versões locais do Exchange Server. Para obter mais informações, consulte Aposentadoria de ferramentas de descoberta eletrônica herdadas no Exchange Online.
Encontre informações sobre a operação GetHoldOnMailboxes EWS.
A operação GetHoldOnMailboxes obtém as caixas de correio que estão em um porão específico e a consulta de retenção associada.
This operation was introduced in Exchange Server 2013.
Usando a operação GetHoldOnMailboxes
A operação GetHoldOnMailboxes fornece ao cliente informações sobre quais caixas de correio são colocadas em um porão específico, informações sobre a consulta de retenção associada a cada porão, se aplicável, e informações sobre o status de retenção para cada caixa de correio. Para obter mais informações sobre os porões de caixa de correio, incluindo os porões baseados em consulta, consulte Segurar in-Place no TechNet.
Cabeçalhos SOAP da operação GetHoldOnMailboxes
A operação GetHoldOnMailboxes pode usar os cabeçalhos SOAP listados na tabela a seguir.
| Nome de cabeçalho | Elemento | Descrição |
|---|---|---|
| Managementrole |
Managementrole |
Identifica as funções de servidor necessárias para que o chamador faça a solicitação. Esse cabeçalho é aplicável a uma solicitação. |
| RequestVersion |
RequestServerVersion |
Identifica a versão do esquema para a solicitação de operação. Esse cabeçalho é aplicável a uma solicitação. |
| Serverversion |
ServerVersionInfo |
Identifica a versão do servidor que respondeu à solicitação. Esse cabeçalho é aplicável a uma resposta. |
Exemplo de solicitação de operação GetHoldOnMailboxes: obter informações de retenção de caixa de correio
O exemplo a seguir de uma solicitação de operação GetHoldOnMailboxes mostra como obter as informações de retenção da caixa de correio para o hold da caixa de correio HoldId2.
<?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"
xmlns:m="http://schemas.microsoft.com/exchange/services/2006/messages">
<soap:Header>
<t:RequestServerVersion Version="Exchange2013" />
</soap:Header>
<soap:Body >
<m:GetHoldOnMailboxes>
<m:HoldId>HoldId2</m:HoldId>
</m:GetHoldOnMailboxes>
</soap:Body>
</soap:Envelope>
O corpo SOAP de solicitação contém os seguintes elementos:
Resposta bem-sucedida da operação GetHoldOnMailboxes
O exemplo a seguir mostra uma resposta bem-sucedida a uma solicitação de operação GetHoldOnMailboxes para obter as informações de retenção de caixa de correio para a caixa de correio HoldId2.
<?xml version="1.0" encoding="utf-8"?>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header>
<h:ServerVersionInfo MajorVersion="15"
MinorVersion="0"
MajorBuildNumber="526"
MinorBuildNumber="0"
Version="Exchange2013"
xmlns:h="http://schemas.microsoft.com/exchange/services/2006/types"
xmlns="http://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">
<GetHoldOnMailboxesResponse ResponseClass="Success"
xmlns="http://schemas.microsoft.com/exchange/services/2006/messages">
<ResponseCode>NoError</ResponseCode>
<MailboxHoldResult>
<HoldId xmlns="http://schemas.microsoft.com/exchange/services/2006/types">HoldId2</HoldId>
<Query xmlns="http://schemas.microsoft.com/exchange/services/2006/types">test</Query>
<MailboxHoldStatuses xmlns="http://schemas.microsoft.com/exchange/services/2006/types">
<MailboxHoldStatus>
<Mailbox>/o=First Organization/ou=Exchange Administrative Group (FYDIBPDLT)/cn=Recipients/cn=ecc0fd98c2cadf-Willi</Mailbox>
<Status>OnHold</Status>
<AdditionalInfo/>
</MailboxHoldStatus>
<MailboxHoldStatus>
<Mailbox>/o=First Organization/ou=Exchange Administrative Group (FYDIBPDLT)/cn=Recipients/cn=dasdat341q8de95-Micha</Mailbox>
<Status>OnHold</Status>
<AdditionalInfo/>
</MailboxHoldStatus>
</MailboxHoldStatuses>
</MailboxHoldResult>
</GetHoldOnMailboxesResponse>
</s:Body>
</s:Envelope>
O corpo SOAP de resposta contém os seguintes elementos:
Resposta de erro da operação GetHoldOnMailboxes
O exemplo a seguir mostra uma resposta de erro a uma solicitação de operação GetHoldOnMailboxes . Essa é uma resposta a uma solicitação para obter uma retenção que foi excluída.
<?xml version="1.0" encoding="utf-8"?>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header>
<h:ServerVersionInfo MajorVersion="15"
MinorVersion="0"
MajorBuildNumber="526"
MinorBuildNumber="0"
Version="Exchange2013"
xmlns:h="http://schemas.microsoft.com/exchange/services/2006/types"
xmlns="http://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">
<GetHoldOnMailboxesResponse ResponseClass="Error"
xmlns="http://schemas.microsoft.com/exchange/services/2006/messages">
<MessageText>The specific query-based hold is not found.</MessageText>
<ResponseCode>ErrorMailboxHoldNotFound</ResponseCode>
<DescriptiveLinkKey>0</DescriptiveLinkKey>
</GetHoldOnMailboxesResponse>
</s:Body>
</s:Envelope>
O corpo SOAP de resposta de erro contém os seguintes elementos:
Para obter códigos de erro adicionais que são genéricos para o EWS e específicos para essa operação, consulte ResponseCode.