Getsearchablemailemail箱操作GetSearchableMailboxes operation

重要

2020年4月1日以降、GetSearchableMailboxes 操作は、Exchange Online では使用できなくなります。Starting on April 1, 2020, the GetSearchableMailboxes operation will no longer be available in Exchange Online. この操作は、Exchange Server のオンプレミスバージョンでは影響を受けません。This operation won't be affected in on-premises versions of Exchange Server. 詳細については、「 Exchange Online の従来の電子情報開示ツールの廃止」を参照してください。For more information, see Retirement of legacy eDiscovery tools in Exchange Online.

Getsearchablemailemailbyews操作についての情報を検索します。Find information about the GetSearchableMailboxes EWS operation.

Getsearchablemailbyoperationは、検索検索用の検索可能な検索可能なメールボックスのスコープセットを取得します。The GetSearchableMailboxes operation gets a scoped set of searchable mailboxes for discovery searches. 応答で返される検索可能なメールボックスの範囲は、検索フィルターと、配布グループのメンバーシップが展開されているかどうかによって決まります。The scope of searchable mailboxes returned in the response is determined by the search filter and whether distribution group membership is expanded.

注意

この操作は、検索フィルターで使用され、最初の数千のみを取得することを目的としています。これは、網羅的な取得を目的としたものではありません。This operation is intended to be used with the search filter and to retrieve only the first few thousands; it's not intended for exhaustive retrieval.

この操作は Exchange Server 2013 で導入されました。This operation was introduced in Exchange Server 2013.

Getsearchablemailemailthe 操作の使用Using the GetSearchableMailboxes operation

Getsearchablemailemail箱操作は、検索可能なメールボックスに関する情報を取得します。The GetSearchableMailboxes operation gets information about searchable mailboxes. 要求では、次の引数を渡すことができます。The following arguments can be passed in the request:

  • Searchfilter -単一の電子メールエイリアスを引数として受け入れます。SearchFilter - Accepts a single email alias as an argument.

  • Expandgroupmembership -応答で返された結果で配布グループのメンバーシップが展開されているかどうかを示します。ExpandGroupMembership - Indicates whether the distribution group membership is expanded in the results returned in the response.

検索フィルターに設定されている電子メールエイリアスが配布グループであり、配布グループのメンバーシップが展開されていない場合、応答には配布グループのメールボックス情報が含まれます。If the email alias set in the search filter is a distribution group and the distribution group membership is not expanded, the response will contain the mailbox information for the distribution group. 検索フィルターに設定されている電子メールエイリアスが配布グループであり、配布グループのメンバーシップが展開されている場合、応答には、配布グループのメンバーである各メールボックスのメールボックス情報が含まれます。If the email alias set in the search filter is a distribution group and the distribution group membership is expanded, the response will contain the mailbox information for each mailbox that is a member of the distribution group. 検索フィルターに1人のユーザーのエイリアスが含まれている場合、応答には1人のユーザーのメールボックス情報が含まれます。If the search filter contains a single user's alias, the response will contain the mailbox information for the single user. Getsearchablemailboxes要素が空の場合、応答には検索可能なすべてのメールボックスが含まれます。The response will contain all searchable mailboxes if the GetSearchableMailboxes element is empty. これは、空のSearchfilter要素を持ち、 expandgroupmembership要素がfalseに設定されているのと同じです。This is the same as having an empty SearchFilter element and the ExpandGroupMembership element set to false.

GetSearchableMailboxes ボックス操作 SOAP ヘッダーGetSearchableMailboxes operation SOAP headers

Getsearchablemailemail箱操作では、次の表に示す SOAP ヘッダーを使用できます。The GetSearchableMailboxes operation can use the SOAP headers that are listed in the following table.

ヘッダー名Header name 要素Element 説明Description
Get-managementroleManagementRole
Get-managementroleManagementRole
発信者が要求を行うために必要なサーバーの役割を指定します。Identifies the server roles that are necessary in order for the caller to make the request. このヘッダーは、要求に適用されます。This header is applicable to a request.
RequestVersionRequestVersion
RequestServerVersionRequestServerVersion
操作要求のスキーマバージョンを識別します。Identifies the schema version for the operation request. このヘッダーは、要求に適用されます。This header is applicable to a request.
ServerVersionServerVersion
ServerVersionInfoServerVersionInfo
要求に応答したサーバーのバージョンを識別します。Identifies the version of the server that responded to the request. このヘッダーは応答に適用されます。This header is applicable to a response.

Getsearchablemailemailoperation 要求の例: 配布グループに関する情報を要求します。GetSearchableMailboxes operation request example: Request information about a distribution group

次のGetsearchablemailboxes操作要求の例は、lolgroup 配布グループのメールボックス情報を取得する方法を示しています。The following example of a GetSearchableMailboxes operation request shows how to get the mailbox information for the lolgroup distribution group.

<?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"
               xmlns:m="https://schemas.microsoft.com/exchange/services/2006/messages">
   <soap:Header>
      <t:RequestServerVersion Version="Exchange2013" />
   </soap:Header>
   <soap:Body >
      <m:GetSearchableMailboxes>
         <m:SearchFilter>lolgroup</m:SearchFilter>
         <m:ExpandGroupMembership>false</m:ExpandGroupMembership>
      </m:GetSearchableMailboxes>
   </soap:Body>
</soap:Envelope>

要求 SOAP 本文には、次の要素が含まれています。The request SOAP body contains the following elements:

Successful Getsearchablemailbyoperation response: 配布グループに関する情報を取得するSuccessful GetSearchableMailboxes operation response: Get information about a distribution group

次の例は、lolgroup 配布グループの検出情報を取得するためのGetsearchablemailboxes操作要求に対する正常な応答を示しています。The following example shows a successful response to a GetSearchableMailboxes operation request to get the discovery information for the lolgroup distribution group.

<?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="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">
      <GetSearchableMailboxesResponse ResponseClass="Success" 
                                      xmlns="https://schemas.microsoft.com/exchange/services/2006/messages">
         <ResponseCode>NoError</ResponseCode>
         <SearchableMailboxes>
            <SearchableMailbox xmlns="https://schemas.microsoft.com/exchange/services/2006/types">
               <Guid>33a408fe-2574-4e3b-49f5-5e1e000a3035</Guid>
               <PrimarySmtpAddress>LOLgroup@contoso.com</PrimarySmtpAddress>
               <IsExternalMailbox>false</IsExternalMailbox>
               <ExternalEmailAddress/>
               <DisplayName>LOLgroup</DisplayName>
               <IsMembershipGroup>true</IsMembershipGroup>
               <ReferenceId>/o=First/ou=Exchange(FYLT)/cn=Recipients/cn=81213b958a0b5295b13b3f02b812bf1bc-LOLgroup</ReferenceId>
            </SearchableMailbox>
         </SearchableMailboxes>
      </GetSearchableMailboxesResponse>
   </s:Body>
</s:Envelope>

応答 SOAP 本文には、次の要素が含まれています。The response SOAP body contains the following elements:

Successful Getsearchablemailaddressoperation response: 展開された配布グループに関する情報を取得するSuccessful GetSearchableMailboxes operation response: Get information about an expanded distribution group

次の例は、拡張された lolgroup 配布グループのメンバーに関する検出情報を取得するために、 Getsearchablemailboxes操作要求に対する正常な応答を示しています。The following example shows a successful response to a GetSearchableMailboxes operation request to get the discovery information about members of the expanded lolgroup distribution group.

<?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="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">
    <GetSearchableMailboxesResponse ResponseClass="Success" xmlns="https://schemas.microsoft.com/exchange/services/2006/messages">
      <ResponseCode>NoError</ResponseCode>
      <SearchableMailboxes>
        <SearchableMailbox xmlns="https://schemas.microsoft.com/exchange/services/2006/types">
          <Guid>e2d42cdf-a227-1ec3-486b-6fa0ebaadb9f5</Guid>
          <PrimarySmtpAddress>JSmith@contoso.com</PrimarySmtpAddress>
          <IsExternalMailbox>false</IsExternalMailbox>
          <ExternalEmailAddress/>
          <DisplayName>Julia Smith</DisplayName>
          <IsMembershipGroup>false</IsMembershipGroup>
          <ReferenceId>/o=First Organization/ou=Exchange Administrative Group (FYDLT)/cn=Recipients/cn=0a1fc86f883846152405d60956dd02e7-Julia</ReferenceId>
        </SearchableMailbox>
        <SearchableMailbox xmlns="https://schemas.microsoft.com/exchange/services/2006/types">
          <Guid>45d0fff1-6541-459a-a343-52453b30e12ca</Guid>
          <PrimarySmtpAddress>LMoore@contoso.com</PrimarySmtpAddress>
          <IsExternalMailbox>false</IsExternalMailbox>
          <ExternalEmailAddress/>
          <DisplayName>Laura Moore</DisplayName>
          <IsMembershipGroup>false</IsMembershipGroup>
          <ReferenceId>/o=First Organization/ou=Exchange Administrative Group (FYDLT)/cn=Recipients/cn=2910d8f8316f4378bbf9338d8f9d714b-Laura</ReferenceId>
        </SearchableMailbox>
        <SearchableMailbox xmlns="https://schemas.microsoft.com/exchange/services/2006/types">
          <Guid>3c620d04-8b33-435a-95be-5b939375576</Guid>
          <PrimarySmtpAddress>SBrown@contoso.com</PrimarySmtpAddress>
          <IsExternalMailbox>false</IsExternalMailbox>
          <ExternalEmailAddress/>
          <DisplayName>Steven Brown</DisplayName>
          <IsMembershipGroup>false</IsMembershipGroup>
          <ReferenceId>/o=First Organization/ou=Exchange Administrative Group (FYDLT)/cn=Recipients/cn=90312341a742f0e47e392c80a60d13ecf-Steve</ReferenceId>
        </SearchableMailbox>
      </SearchableMailboxes>
    </GetSearchableMailboxesResponse>
  </s:Body>
</s:Envelope>

応答 SOAP 本文には、次の要素が含まれています。The response SOAP body contains the following elements:

GetSearchableMailboxes ボックス操作エラー応答GetSearchableMailboxes operation error response

次の例は、 Getsearchablemailaddressoperation操作要求へのエラー応答を示しています。The following example shows an error response to a GetSearchableMailboxes operation request. これは、 Expandgroupmembership引数がtrueに設定されている場合に、検索可能なメールボックスをすべて取得する要求に対する応答です。This is a response to a request to get all searchable mailboxes when the ExpandGroupMembership argument is set to true.

<?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="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">
      <GetSearchableMailboxesResponse ResponseClass="Error" 
                                      xmlns="https://schemas.microsoft.com/exchange/services/2006/messages">
         <MessageText>Cannot use wildcard or empty query when auto group expansion is enabled.</MessageText>
         <ResponseCode>ErrorInvalidArgument</ResponseCode>
         <DescriptiveLinkKey>0</DescriptiveLinkKey>
         <SearchableMailboxes/>
      </GetSearchableMailboxesResponse>
   </s:Body>
</s:Envelope>

エラー応答 SOAP 本文には、次の要素が含まれています。The error response SOAP body contains the following elements:

EWS で汎用的でこの操作に固有の追加のエラーコードについては、「応答」を参照してください。For additional error codes that are generic to EWS and specific to this operation, see ResponseCode.

関連項目See also