Get-Recipient

  • 项目

 

适用于： Exchange Server 2007 SP3, Exchange Server 2007 SP2, Exchange Server 2007 SP1

上一次修改主题： 2010-04-27

使用 Get-Recipient cmdlet 可以从 Active Directory 目录服务返回收件人对象列表。

语法

get-Recipient [-Identity <RecipientIdParameter>] [-Credential <PSCredential>] [-DomainController <Fqdn>] [-IgnoreDefaultScope <SwitchParameter>] [-OrganizationalUnit <OrganizationalUnitIdParameter>] [-ReadFromDomainController <SwitchParameter>] [-RecipientType <RecipientType[]>] [-RecipientTypeDetails <RecipientTypeDetails[]>] [-ResultSize <Unlimited>] [-SortBy <String>]

get-Recipient [-Credential <PSCredential>] [-DomainController <Fqdn>] [-IgnoreDefaultScope <SwitchParameter>] [-OrganizationalUnit <OrganizationalUnitIdParameter>] [-ReadFromDomainController <SwitchParameter>] [-RecipientPreviewFilter <String>] [-RecipientType <RecipientType[]>] [-RecipientTypeDetails <RecipientTypeDetails[]>] [-ResultSize <Unlimited>] [-SortBy <String>]

get-Recipient [-Credential <PSCredential>] [-DomainController <Fqdn>] [-Filter <String>] [-IgnoreDefaultScope <SwitchParameter>] [-OrganizationalUnit <OrganizationalUnitIdParameter>] [-ReadFromDomainController <SwitchParameter>] [-RecipientType <RecipientType[]>] [-RecipientTypeDetails <RecipientTypeDetails[]>] [-ResultSize <Unlimited>] [-SortBy <String>]

get-Recipient [-Anr <String>] [-Credential <PSCredential>] [-DomainController <Fqdn>] [-IgnoreDefaultScope <SwitchParameter>] [-OrganizationalUnit <OrganizationalUnitIdParameter>] [-ReadFromDomainController <SwitchParameter>] [-RecipientType <RecipientType[]>] [-RecipientTypeDetails <RecipientTypeDetails[]>] [-ResultSize <Unlimited>] [-SortBy <String>]

详细说明

Get-Recipient cmdlet 检索指定收件人的属性。没有必需参数。如果在没有参数的情况下运行 cmdlet，将返回组织的完整收件人列表。

若要运行 Get-Recipient cmdlet，必须为您使用的帐户委派以下角色：

  • Exchange 仅查看管理员角色

有关权限、角色委派以及管理 Exchange Server 2007 所需权限的详细信息，请参阅权限注意事项。

参数

参数 必需 类型 说明

Anr

可选

System.String

Anr 参数指定一个字符串，用于执行模糊名称解析 (ANR) 搜索。可以指定部分字符串，并搜索其属性与该字符串相匹配的对象。所搜索的默认属性是：

  • CommonName (CN)

  • DisplayName (displayName)

  • FirstName (givenName)

  • LastName (sn)

  • Alias (mailNickname)

Credential

可选

System.Management.Automation.PSCredential

Credential 参数指定要用于访问 Active Directory 的用户名和密码。

如果使用 Credential 参数，则命令将在继续执行之前提示输入帐户的密码。

DomainController

可选

Microsoft.Exchange.Data.Fqdn

若要指定用于将此配置更改写入 Active Directory 的域控制器的完全限定的域名 (FQDN)，请在命令中使用 DomainController 参数。

Filter

可选

System.String

使用 Filter 参数可以指定一个或多个用于限制查询返回的收件人的属性。此参数无法与 Identity 参数或 Anr 参数一起使用。

有关可筛选属性的详细信息，请参阅 -Filter 参数的可筛选属性。

Identity

可选

Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter

Identity 参数用于标识收件人。可以使用下列值之一：

  • GUID

  • 域\帐户

  • 用户主体名称 (UPN)

  • 旧版 Exchange DN

  • 简单邮件传输协议 (SMTP) 地址

  • 名称

  • 别名

IgnoreDefaultScope

可选

System.Management.Automation.SwitchParameter

IgnoreDefaultScope 参数指示命令忽略 Exchange 命令行管理程序的默认收件人作用域设置，并使用整个林作为作用域。这样，该命令可以访问当前不在默认作用域中的 Active Directory 对象。使用 IgnoreDefaultScope 参数时将受到下列限制：

  • 不能使用 DomainController 参数。该命令将自动使用适合的全局编录服务器。

  • Identity 参数只能使用 DN。不接受其他形式的标识（例如别名和 GUID）。

  • 不能同时使用 OrganizationalUnit 和 Identity 参数。

  • 不能使用 Credential 参数。

OrganizationalUnit

可选

Microsoft.Exchange.Configuration.Tasks.OrganizationalUnitIdParameter

OrganizationalUnit 参数指定组织单位 (OU) 或域规范名称，并用于限制结果。如果使用此参数，将只获得指定容器内的收件人。例如：

  • OU:westcoast.contoso.com/users

  • 域:westcoast.contoso.com

ReadFromDomainController

可选

System.Management.Automation.SwitchParameter

ReadFromDomainController 参数指定从用户域中的域控制器读取的用户信息。如果将收件人作用域设置为包括林中的所有收件人，且不使用此参数，则有可能从包含过期信息的全局编录中读取用户信息。如果使用此参数，则可能需要多次读取才能获取该信息。

note注意：
默认情况下，收件人作用域被设置为驻留 Exchange 服务器的域。

RecipientPreviewFilter

可选

System.String

使用 RecipientPreviewFilter 参数指定用于定义此命令返回的收件人的收件人筛选器。可以为动态通讯组、地址列表或电子邮件地址策略创建自定义收件人筛选器。若要验证指定的收件人筛选器是否将返回所需的收件人，可以将该动态通讯组、地址列表或电子邮件地址策略的 RecipientFilter 属性中指定的 OPATH 筛选器传递给 RecipientPreviewFilter 参数，并查看收件人列表。

RecipientType

可选

Microsoft.Exchange.Data.Directory.Recipient.RecipientType[]

RecipientType 参数指定返回的收件人的类型。可以使用一个或多个下列类型：

  • UserMailbox

  • MailUser

  • MailContact

  • MailUniversalDistributionGroup

  • MailUniversalSecurityGroup

  • MailNonUniversalGroup

  • DynamicDistributionGroup

  • PublicFolder

RecipientTypeDetails

可选

Microsoft.Exchange.Data.Directory.Recipient.RecipientTypeDetails[]

RecipientTypeDetails 参数指定返回的收件人的类型。Microsoft Exchange Server 2007 的收件人类型分为收件人类型和子类型。每个收件人类型包含所有子类型的所有常见属性。例如，类型 UserMailbox 代表 Active Directory 中具有关联邮箱的用户帐户。因为存在多种邮箱类型，所以每个邮箱类型都由 RecipientTypeDetails 参数标识。例如，会议室邮箱将 RecipientTypeDetails 设置为 ConferenceRoomMailbox，而用户邮箱将 RecipientTypeDetails 设置为 UserMailbox。

对于该命令，可用的收件人类型详细信息包括：

  • ConferenceRoomMailbox

  • EquipmentMailbox

  • LegacyMailbox

  • LinkedMailbox

  • UserMailbox

  • MailContact

  • DynamicDistributionGroup

  • MailForestContact

  • MailNonUniversalGroup

  • MailUniversalDistributionGroup

  • MailUniversalSecurityGroup

  • MailUser

  • PublicFolder

  • SharedMailbox

ResultSize

可选

Microsoft.Exchange.Data.Unlimited

ResultSize 参数指定要返回的最大结果数。如果希望返回与筛选条件相匹配的所有收件人，请使用“unlimited”作为此参数的值。默认值为 1000。

SortBy

可选

System.String

SortBy 参数指定用来对结果排序的属性。一次只能按一个属性进行排序。可以按下列属性排序：

  • Alias

  • DisplayName

  • Name

结果将按升序进行排序。

输入类型

返回类型

错误

错误 说明

   

 

异常

异常 说明

  

 

示例

第一个示例显示如何获得组织内所有收件人的相关信息。

第二个示例显示如何获得组织内所有已启用邮件的联系人的相关信息，并按姓名对他们进行排序。

Get-Recipient -ResultSize unlimited
Get-Recipient -RecipientType MailContact -SortBy Name