共用方式為


Get-Recipient

內部部署 Exchange 和雲端式服務有提供此 Cmdlet。 有些參數和設定可能只限於某一環境。

使用 Get-Recipient 指令程式來檢視您組織中現有的收件者物件。 此指令程式會傳回所有擁有郵件功能的物件 (例如信箱、郵件使用者、郵件連絡人和通訊群組)。

注意:在 PowerShell Exchange Online,我們建議你使用 Get-EXORecipient cmdlet 而非這個 cmdlet。 如需詳細資訊,請參閱<連線至 Exchange Online PowerShell>。

在雲端環境中,若要返回 Microsoft 365 群組,您需要使用 RecipientTypeDetails 參數,並以 GroupMailbox 為值。

如需下方<語法>一節中參數集的詳細資訊,請參閱 Exchange Cmdlet 語法

語法

AnrSet

Get-Recipient
    [-Anr <String>]
    [-AuthenticationType <AuthenticationType>]
    [-Credential <PSCredential>]
    [-DomainController <Fqdn>]
    [-Filter <String>]
    [-IgnoreDefaultScope]
    [-OrganizationalUnit <OrganizationalUnitIdParameter>]
    [-PropertySet <PropertySet>]
    [-ReadFromDomainController]
    [-RecipientType <RecipientType[]>]
    [-RecipientTypeDetails <RecipientTypeDetails[]>]
    [-ResultSize <Unlimited>]
    [-SortBy <String>]
    [-Capabilities <MultiValuedProperty>]
    [-Database <DatabaseIdParameter>]
    [-Properties <String[]>]
    [-IncludeManagerWithDisplayName]
    [-IncludeSoftDeletedRecipients]
    [<CommonParameters>]

Identity

Get-Recipient
    [[-Identity] <RecipientIdParameter>]
    [-AuthenticationType <AuthenticationType>]
    [-BookmarkDisplayName <String>]
    [-Credential <PSCredential>]
    [-DomainController <Fqdn>]
    [-Filter <String>]
    [-IgnoreDefaultScope]
    [-IncludeBookmarkObject <Boolean>]
    [-OrganizationalUnit <OrganizationalUnitIdParameter>]
    [-PropertySet <PropertySet>]
    [-ReadFromDomainController]
    [-RecipientType <RecipientType[]>]
    [-RecipientTypeDetails <RecipientTypeDetails[]>]
    [-ResultSize <Unlimited>]
    [-SortBy <String>]
    [-Capabilities <MultiValuedProperty>]
    [-Properties <String[]>]
    [-IncludeManagerWithDisplayName]
    [-IncludeSoftDeletedRecipients]
    [<CommonParameters>]

DatabaseSet

Get-Recipient
    [-Database <DatabaseIdParameter>]
    [-Credential <PSCredential>]
    [-DomainController <Fqdn>]
    [-Filter <String>]
    [-IgnoreDefaultScope]
    [-OrganizationalUnit <OrganizationalUnitIdParameter>]
    [-Properties <String[]>]
    [-PropertySet <PropertySet>]
    [-ReadFromDomainController]
    [-RecipientType <RecipientType[]>]
    [-RecipientTypeDetails <RecipientTypeDetails[]>]
    [-ResultSize <Unlimited>]
    [-SortBy <String>]
    [-IncludeSoftDeletedRecipients]
    [<CommonParameters>]

RecipientPreviewFilterSet

Get-Recipient
    [-RecipientPreviewFilter <String>]
    [-AuthenticationType <AuthenticationType>]
    [-Capabilities <MultiValuedProperty>]
    [-Credential <PSCredential>]
    [-DomainController <Fqdn>]
    [-Filter <String>]
    [-IgnoreDefaultScope]
    [-IncludeManagerWithDisplayName]
    [-IncludeSoftDeletedRecipients]
    [-OrganizationalUnit <OrganizationalUnitIdParameter>]
    [-Properties <String[]>]
    [-PropertySet <PropertySet>]
    [-ReadFromDomainController]
    [-RecipientType <RecipientType[]>]
    [-RecipientTypeDetails <RecipientTypeDetails[]>]
    [-ResultSize <Unlimited>]
    [-SortBy <String>]
    [<CommonParameters>]

Description

Get-Recipient 指令本可能不會回傳所有接收者的特定物件屬性。 若要檢視收件者的物件特定內容,您需要使用以物件類型 (例如 Get-Mailbox、Get-MailUser 或 Get-DistributionGroup) 為基礎的對應指令程式。

您必須已獲指派權限,才能執行此指令程式。 雖然這篇文章列出了 cmdlet 的所有參數,但如果某些參數未包含在你分配的權限中,你可能無法存取這些參數。 若要尋找在組織中執行任何 Cmdlet 或參數所需的權限,請參閱 Find the permissions required to run any Exchange cmdlet

範例

範例 1

Get-Recipient -ResultSize unlimited

此範例會擷取您組織中所有收件者的摘要清單。

範例 2

Get-Recipient -Identity "Marketing Department" | Format-List

此範例回傳收件人名為行銷部門的詳細資訊。

範例 3

Get-Recipient -RecipientType MailContact -SortBy Office | Format-Table -Auto Office,Name

此範例會擷取您組織中所有郵件連絡人的相關資訊,並依辦公室加以排序。

參數

-Anr

適用:2010 Exchange Server、2013 Exchange Server、2016 Exchange Server、2019 Exchange Server、Exchange Server SE、Exchange Online、安全 & 合規,Exchange Online Protection

Anr 參數會指定用來執行模糊名稱解析 (ANR) 搜尋的字串。 您可以指定部分字串,然後搜尋屬性符合該字串的物件。 搜尋的預設屬性如下:

  • CommonName (CN)
  • DisplayName
  • FirstName
  • LastName
  • 別名

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

AnrSet
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-AuthenticationType

適用:Exchange Online、安全 & 合規、Exchange Online Protection

此參數只能在雲端式服務中使用。

AuthenticationType 參數會依驗證類型指定收件者。 請使用下列其中一個值:

  • 聯邦
  • 受管理

參數屬性

類型:AuthenticationType
預設值:None
支援萬用字元:False
不要顯示:False

參數集

AnrSet
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False
Identity
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False
RecipientPreviewFilterSet
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-BookmarkDisplayName

適用:2010 Exchange Server、2013 Exchange Server、2016 Exchange Server、2019 Exchange Server、Exchange Server SE、Exchange Online、安全 & 合規,Exchange Online Protection

將保留此參數供 Microsoft 內部使用。

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

Identity
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Capabilities

適用:Exchange Online、安全 & 合規、Exchange Online Protection

此參數只能在雲端式服務中使用。

將保留此參數供 Microsoft 內部使用。

參數屬性

類型:MultiValuedProperty
預設值:None
支援萬用字元:False
不要顯示:False

參數集

AnrSet
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False
Identity
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False
RecipientPreviewFilterSet
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Credential

適用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

此參數僅適用於內部部署 Exchange。

Credential 參數指定執行此指令所使用的使用者名稱和密碼。 通常您會在指令碼中使用此參數,或在您必須提供具有必要權限的其他認證時使用此參數。

此參數的值需要使用 Get-Credential Cmdlet。 若要暫停此命令並收到輸入認證的提示,請使用值 (Get-Credential)。 或者,在您執行此命令之前,將認證儲存在變數中 (例如,$cred = Get-Credential),然後將變數名稱 ($cred) 用於此參數。 如需詳細資訊,請參閱 Get-Credential

參數屬性

類型:PSCredential
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Database

適用:Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

此參數僅適用於內部部署 Exchange。

資料庫參數會回傳所有儲存在指定信箱資料庫中的收件人。 您可以使用唯一識別資料庫的任何值。 例如:

  • 名稱
  • 辨別名稱 (DN)
  • GUID

參數屬性

類型:DatabaseIdParameter
預設值:None
支援萬用字元:False
不要顯示:False

參數集

DatabaseSet
Position:Named
必要:False
來自管線的值:True
來自管線按屬性名稱的值:True
來自剩餘引數的值:False

-DomainController

適用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

此參數僅適用於內部部署 Exchange。

DomainController 參數會指定此 Cmdlet 用來向 Active Directory 讀取或寫入資料的網域控制站。 您可以透過網域控制站的完整網域名稱 (FQDN) 來識別網域控制站。 例如,dc01.contoso.com。

參數屬性

類型:Fqdn
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Filter

適用:2010 Exchange Server、2013 Exchange Server、2016 Exchange Server、2019 Exchange Server、Exchange Server SE、Exchange Online、安全 & 合規,Exchange Online Protection

Filter 參數使用 OPATH 語法,依照指定的屬性與值來篩選結果。 搜尋準則使用語法 "Property -ComparisonOperator 'Value'"

  • 將整個 OPATH 濾波器包在雙引號中 “”。 如果篩選條件包含系統值 (例如 $true$false$null),請改為使用單引號 ' '。 雖然此參數是字串 (不是系統區塊),您也可以使用大括弧 { },但只有在篩選條件不包含變數時。
  • Property 是可篩選的屬性。 欲了解更多關於 Exchange Server 與 Exchange Online 中可篩選屬性的資訊,請參閱 Filterable 屬性中的篩選參數。
  • ComparisonOperator 是一種 OPATH 比較運算子,例如用於等值和-like字串比較) (-eq。 如需比較運算子的詳細資訊,請參閱 about_Comparison_Operators
  • Value 是要搜尋的屬性值。 以單引號括住文字值和變數 ('Value''$Variable')。 如果變數值包含單引號,您必須識別 (逸出) 單引號,以正確展開變數。 例如,使用 '$($User -Replace "'","''")',而不是 '$User'。 不要用引號包住整數或系統值, (例如,使用500、、$true$false,或 $null) 。

您可以使用邏輯運算子 -and-or 將多個搜尋準則鏈結在一起。 例如,"Criteria1 -and Criteria2""(Criteria1 -and Criteria2) -or Criteria3"

欲了解 Exchange 中 OPATH 過濾器的詳細資訊,請參見 「額外 OPATH 語法資訊」。

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Identity

適用:2010 Exchange Server、2013 Exchange Server、2016 Exchange Server、2019 Exchange Server、Exchange Server SE、Exchange Online、安全 & 合規,Exchange Online Protection

Identity 參數會指定您要檢視的收件者物件。 您可以使用唯一識別收件者的任何值。 例如:

  • 名稱
  • 別名
  • 辨別名稱 (DN)
  • 辨別名稱 (DN)
  • 標準 DN
  • GUID

注意:Identity 參數的值$null或不存在的值,會回傳 所有 物件,就像你執行 Get- 指令時沒有 Identity 參數一樣。 請確認 Identity 參數的值清單是否準確,且不包含不存在的 $null 值。

參數屬性

類型:RecipientIdParameter
預設值:None
支援萬用字元:False
不要顯示:False

參數集

Identity
Position:1
必要:False
來自管線的值:True
來自管線按屬性名稱的值:True
來自剩餘引數的值:False

-IgnoreDefaultScope

適用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

此參數僅適用於內部部署 Exchange。

IgnoreDefaultScope 交換器告訴指令忽略 Exchange PowerShell 會話的預設接收者範圍設定,並使用整個森林作為範圍。 您不需要使用此參數指定值。

此切換使指令能存取目前未在預設範圍內可用的 Active Directory 物件,但同時引入以下限制:

  • 您不能使用 DomainController 參數。 此命令會自動使用適當的通用類別目錄伺服器。
  • 您不能使用 DomainController 參數。 此命令會自動使用適當的通用類別目錄伺服器。

參數屬性

類型:SwitchParameter
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-IncludeBookmarkObject

適用:2010 Exchange Server、2013 Exchange Server、2016 Exchange Server、2019 Exchange Server、Exchange Server SE、Exchange Online、安全 & 合規,Exchange Online Protection

將保留此參數供 Microsoft 內部使用。

參數屬性

類型:Boolean
預設值:None
支援萬用字元:False
不要顯示:False

參數集

Identity
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-IncludeManagerWithDisplayName

適用:Exchange Online、Exchange Online Protection

此參數只能在雲端式服務中使用。

{{ 填入 IncludeManagerWithDisplayName 描述 }}

參數屬性

類型:SwitchParameter
預設值:None
支援萬用字元:False
不要顯示:False

參數集

Identity
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False
AnrSet
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False
RecipientPreviewFilterSet
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-IncludeSoftDeletedRecipients

適用:Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online、Exchange Online Protection

IncludeSoftDeletedRecipients 開關會指定是否將軟刪除的收件人納入結果。 您不需要使用此參數指定值。

軟刪除的接收者是指仍可恢復的已刪除收件人。

注意:使用此交換器搭配 Identity 或 RecipientTypeDetails 參數來取得 SoftDeletedRecipients。

參數屬性

類型:SwitchParameter
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-OrganizationalUnit

適用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online,Exchange Online Protection

OrganizationalUnit 參數會根據物件在 Active Directory 中的位置來過濾結果。 系統只會傳回存在於指定位置的物件。 此參數的有效輸入是由 Get-OrganizationalUnit 指令碼返回 (OU) 或領域中的組織單位。 您可以使用唯一識別 OU 或網域的任何值。 例如:

  • 名稱
  • 名稱
  • 辨別名稱 (DN)
  • GUID

參數屬性

類型:OrganizationalUnitIdParameter
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Properties

適用:Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online、安全 & 合規,Exchange Online Protection

將保留此參數供 Microsoft 內部使用。

參數屬性

類型:

String[]

預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-PropertySet

適用:2010 Exchange Server、2013 Exchange Server、2016 Exchange Server、2019 Exchange Server、Exchange Server SE、Exchange Online、安全 & 合規,Exchange Online Protection

將保留此參數供 Microsoft 內部使用。

參數屬性

類型:PropertySet
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-ReadFromDomainController

適用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

此參數僅適用於內部部署 Exchange。

ReadFromDomainController 參數會指定應從使用者網域的網域控制站讀取的資訊。 您不需要使用此參數指定值。

指令: Set-AdServerSettings -ViewEntireForest $true 要包含森林中的所有物件需要 ReadFromDomainController 交換器。 否則,指令可能會使用包含過時資訊的全域目錄。 另外,你可能需要用 ReadFromDomainController 交換器執行多次指令來取得資訊。

預設情況下,接收範圍設定為承載你 Exchange 伺服器的網域。

參數屬性

類型:SwitchParameter
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-RecipientPreviewFilter

適用:2010 Exchange Server、2013 Exchange Server、2016 Exchange Server、2019 Exchange Server、Exchange Server SE、Exchange Online、安全 & 合規,Exchange Online Protection

RecipientPreviewFilter 參數測試你會在動態分發群組、地址列表或電子郵件地址政策中使用的接收者過濾器。 此參數使用 LDAP 濾波器語法。

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

RecipientPreviewFilterSet
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-RecipientType

適用:2010 Exchange Server、2013 Exchange Server、2016 Exchange Server、2019 Exchange Server、Exchange Server SE、Exchange Online、安全 & 合規,Exchange Online Protection

RecipientType 參數會依照指定的接收者類型過濾結果。 有效值為:

  • 動態分布組
  • 郵件聯絡
  • MailNonUniversalGroup
  • 郵件通用分發群組
  • 郵件通用安全集團
  • MailUser
  • PublicFolder
  • UserMailbox

您可以指定多個以逗號分隔的值。

參數屬性

類型:

RecipientType[]

預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-RecipientTypeDetails

適用:2010 Exchange Server、2013 Exchange Server、2016 Exchange Server、2019 Exchange Server、Exchange Server SE、Exchange Online、安全 & 合規,Exchange Online Protection

RecipientTypeDetails 參數會依指定的接收者子類型過濾結果。 有效值為:

  • 發現信箱
  • 動態分布組
  • 設備郵箱
  • GroupMailbox (Exchange 2013 或更新版本及雲端)
  • GuestMailUser (Exchange 2016 或更新版本及雲端)
  • 傳承郵箱
  • LinkedMailbox
  • LinkedRoomMailbox (Exchange 2013 或更新版本及雲端)
  • 郵件聯絡
  • MailForest聯絡
  • MailNonUniversalGroup
  • 郵件通用分發群組
  • 郵件通用安全集團
  • MailUser
  • PublicFolder
  • PublicFolderMailbox (Exchange 2013 或更新版本及雲端)
  • 遠端設備信箱
  • 遠端房間郵箱
  • 遠端共享郵箱
  • RemoteTeamMailbox (Exchange 2013 或更新版本及雲端)
  • 遠端使用者郵箱
  • 房間列表
  • 房間信箱
  • 排程郵件箱 (Exchange 2016或更新版本及雲端)
  • SharedMailbox
  • SharedWithMailUser (僅限雲端)
  • TeamMailbox (Exchange 2013 或更新版本及雲端)
  • UserMailbox

您可以指定多個以逗號分隔的值。

RecipientType 參數的值會影響你可以用來設定這個參數的值。 例如,如果你使用 RecipientType 值 MailContact,你不能用 UserMailbox 來設定這個參數。 你會收到錯誤訊息:任何指定的 RecipientTypeDetails 都不包含在任何指定的收件人類型中。

參數屬性

類型:

RecipientTypeDetails[]

預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-ResultSize

適用:2010 Exchange Server、2013 Exchange Server、2016 Exchange Server、2019 Exchange Server、Exchange Server SE、Exchange Online、安全 & 合規,Exchange Online Protection

ResultSize 參數會指定傳回的結果筆數上限。 若要傳回符合查詢的所有要求,請使用 unlimited 作為此參數的值。 預設值為 1000。

參數屬性

類型:Unlimited
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-SortBy

適用:2010 Exchange Server、2013 Exchange Server、2016 Exchange Server、2019 Exchange Server、Exchange Server SE、Exchange Online、安全 & 合規,Exchange Online Protection

SortBy 參數會指定排序結果依據的屬性。 您一次只能依據一個屬性進行排序。 結果會以遞增順序排序。

如果預設視圖沒有包含你排序的屬性,你可以在指令 | Format-Table -Auto Property1,Property2,...PropertyX上加上 。 建立一個包含你想看到的所有屬性的新檢視。 支援在屬性名稱中使用萬用字元 (*)。

您可以依下列內容排序:

  • 名稱
  • DisplayName
  • 別名
  • 鄉/鎮/市/區
  • FirstName
  • LastName
  • Office
  • ServerLegacyDN

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

CommonParameters

此 cmdlet 支援常見參數:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 如需詳細資訊,請參閱 about_CommonParameters

輸入

Input types

若要查看此指令程式可接受的輸入類型,請參閱指令程式輸入和輸出類型。 如果指令程式的 [輸入類型] 欄位是空的,表示指令程式不接受輸入資料。

輸出

Output types

若要查看此指令程式可接受的傳回類型 (也就是所謂的輸出類型),請參閱指令程式輸入和輸出類型。 如果 [輸出類型] 欄位是空的,表示指令程式不會傳回資料。