GetSearchableMailboxes 操作

重要

2020 年 4 月 1 日から、GetSearchableMailboxes 操作はExchange Onlineで使用できなくなります。 この操作は、オンプレミスバージョンのExchange Serverでは影響を受けることはありません。 詳細については、「Exchange Onlineの従来の電子情報開示ツールの廃止」を参照してください。

GetSearchableMailboxes EWS 操作に関する情報を検索します。

GetSearchableMailboxes 操作は、探索検索用の検索可能なメールボックスのスコープ付きセットを取得します。 応答で返される検索可能なメールボックスのスコープは、検索フィルターと配布グループメンバーシップが展開されているかどうかによって決まります。

注:

この操作は、検索フィルターと共に使用し、最初の数千人のみを取得することを目的としています。完全な取得を目的としたものではありません。

この操作は Exchange Server 2013 で導入されました。

GetSearchableMailboxes 操作の使用

GetSearchableMailboxes 操作は、検索可能なメールボックスに関する情報を取得します。 要求では、次の引数を渡すことができます。

• SearchFilter - 1 つの電子メール エイリアスを引数として受け入れます。

• ExpandGroupMembership - 応答で返された結果で配布グループのメンバーシップが展開されているかどうかを示します。

検索フィルターで設定された電子メール エイリアスが配布グループであり、配布グループのメンバーシップが展開されていない場合、応答には配布グループのメールボックス情報が含まれます。 検索フィルターで設定されたメール エイリアスが配布グループであり、配布グループのメンバーシップが展開されている場合、応答には、配布グループのメンバーである各メールボックスのメールボックス情報が含まれます。 検索フィルターに 1 人のユーザーのエイリアスが含まれている場合、応答には 1 人のユーザーのメールボックス情報が含まれます。 GetSearchableMailboxes 要素が空の場合、応答には検索可能なすべてのメールボックスが含まれます。 これは、空の SearchFilter 要素と ExpandGroupMembership 要素を false に設定した場合と同じです。

GetSearchableMailboxes 操作 SOAP ヘッダー

GetSearchableMailboxes 操作では、次の表に示す SOAP ヘッダーを使用できます。

ヘッダー名	要素	説明
ManagementRole	ManagementRole	呼び出し元が要求を行うために必要なサーバー ロールを識別します。 このヘッダーは要求に適用されます。
RequestVersion	RequestServerVersion	操作要求のスキーマ バージョンを識別します。 このヘッダーは要求に適用されます。
ServerVersion	ServerVersionInfo	要求に応答したサーバーのバージョンを識別します。 このヘッダーは、応答に適用できます。

GetSearchableMailboxes 操作要求の例: 配布グループに関する要求情報

GetSearchableMailboxes 操作要求の次の例は、lolgroup 配布グループのメールボックス情報を取得する方法を示しています。

<?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 本文には、次の要素が含まれています。

• GetSearchableMailboxes
• SearchFilter
• ExpandGroupMembership

GetSearchableMailboxes 操作応答の成功: 配布グループに関する情報を取得する

次の例は、lolgroup 配布グループの検出情報を取得するための GetSearchableMailboxes 操作要求に対する正常な応答を示しています。

<?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 本文には、次の要素が含まれています。

• GetSearchableMailboxesResponse
• ResponseCode
• SearchableMailboxes
• SearchableMailbox
• Guid
• PrimarySmtpAddress
• IsExternalMailbox
• ExternalEmailAddress
• DisplayName (string)
• IsMembershipGroup
• ReferenceId

GetSearchableMailboxes 操作応答の成功: 展開された配布グループに関する情報を取得する

次の例は、展開された lolgroup 配布グループのメンバーに関する検出情報を取得するための GetSearchableMailboxes 操作要求に対する正常な応答を示しています。

<?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 本文には、次の要素が含まれています。

• GetSearchableMailboxesResponse
• ResponseCode
• SearchableMailboxes
• SearchableMailbox
• Guid
• PrimarySmtpAddress
• IsExternalMailbox
• ExternalEmailAddress
• DisplayName (string)
• IsMembershipGroup
• ReferenceId

GetSearchableMailboxes 操作エラー応答

次の例は、 GetSearchableMailboxes 操作要求に対するエラー応答を示しています。 これは、ExpandGroupMembership 引数が 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 本文には、次の要素が含まれています。

• GetSearchableMailboxesResponse
• MessageText
• ResponseCode
• DescriptiveLinkKey
• SearchableMailboxes

EWS に汎用であり、この操作に固有のその他のエラー コードについては、「 ResponseCode」を参照してください。

関連項目

• Exchange での EWS 操作
• SetHoldOnMailboxes 操作
• SearchMailboxes 操作
• GetHoldOnMailboxes 操作
• GetDiscoverySearchConfiguration 操作
• GetNonIndexableItemDetails 操作
• GetNonIndexableItemStatistics 操作