[Index]

Model: device/exchange/Recipient

Model Details

Title Description Details
WhenMailboxCreated *
  • Field Name: WhenMailboxCreated
  • Type: String
  • Format: date-time
Title *
  • Field Name: Title
  • Type: String
ResourceType *
  • Field Name: ResourceType
  • Type: String
CustomAttribute6 *
  • Field Name: CustomAttribute6
  • Type: String
CustomAttribute9 *
  • Field Name: CustomAttribute9
  • Type: String
IsValidSecurityPrincipal *
  • Field Name: IsValidSecurityPrincipal
  • Type: Boolean
WindowsLiveID *
  • Field Name: WindowsLiveID
  • Type: String
Department *
  • Field Name: Department
  • Type: String
PSShowComputerName
  • Field Name: PSShowComputerName
  • Type: Boolean
StorageGroupName *
  • Field Name: StorageGroupName
  • Type: String
Company *
  • Field Name: Company
  • Type: String
MailboxRelease *
  • Field Name: MailboxRelease
  • Type: String
OriginatingServer *
  • Field Name: OriginatingServer
  • Type: String
HiddenFromAddressListsEnabled *
  • Field Name: HiddenFromAddressListsEnabled
  • Type: Boolean
UMEnabled *
  • Field Name: UMEnabled
  • Type: Boolean
Notes *
  • Field Name: Notes
  • Type: String
RecipientType * The RecipientType parameter specifies the type of recipients to return. You can use one or more of the following values: DynamicDistributionGroup UserMailbox MailUser MailContact MailUniversalDistributionGroup MailUniversalSecurityGroup MailNonUniversalGroup PublicFolder
  • Field Name: RecipientType
  • Type: String
ArchiveRelease *
  • Field Name: ArchiveRelease
  • Type: String
ShouldUseDefaultRetentionPolicy *
  • Field Name: ShouldUseDefaultRetentionPolicy
  • Type: Boolean
ExchangeVersion *
  • Field Name: ExchangeVersion
  • Type: String
ActiveSyncMailboxPolicy *
  • Field Name: ActiveSyncMailboxPolicy
  • Type: String
RunspaceId
  • Field Name: RunspaceId
  • Type: String
Guid *
  • Field Name: Guid
  • Type: String
RecipientTypeDetails * The RecipientTypeDetails parameter specifies the type of recipients returned. Recipient types are divided into recipient types and subtypes. Each recipient type contains all common properties for all subtypes. For example, the type UserMailbox represents a user account in Active Directory that has an associated mailbox. Because there are several mailbox types, each mailbox type is identified by the RecipientTypeDetails parameter. For example, a conference room mailbox has RecipientTypeDetails set to ConferenceRoomMailbox, whereas a user mailbox has RecipientTypeDetails set to UserMailbox. You can select from the following values: ConferenceRoomMailbox Contact DiscoveryMailbox DynamicDistributionGroup EquipmentMailbox ExternalManagedContact ExternalManagedDistributionGroup LegacyMailbox LinkedMailbox MailboxPlan MailContact MailForestContact MailNonUniversalGroup MailUniversalDistributionGroup MailUniversalSecurityGroup MailUser PublicFolder RoleGroup RoomList RoomMailbox SharedMailbox SystemAttendantMailbox SystemMailbox User UserMailbox
  • Field Name: RecipientTypeDetails
  • Type: String
DisplayName *
  • Field Name: DisplayName
  • Type: String
OrganizationId *
  • Field Name: OrganizationId
  • Type: String
ArchiveGuid *
  • Field Name: ArchiveGuid
  • Type: String
DistinguishedName *
  • Field Name: DistinguishedName
  • Type: String
ArchiveState *
  • Field Name: ArchiveState
  • Type: String
ArchiveStatus *
  • Field Name: ArchiveStatus
  • Type: String
PoliciesExcluded
  • Field Name: PoliciesExcluded.[n]
  • Type: Array
MailboxMoveRemoteHostName *
  • Field Name: MailboxMoveRemoteHostName
  • Type: String
LitigationHoldEnabled *
  • Field Name: LitigationHoldEnabled
  • Type: Boolean
SamAccountName *
  • Field Name: SamAccountName
  • Type: String
ObjectCategory *
  • Field Name: ObjectCategory
  • Type: String
IsValid *
  • Field Name: IsValid
  • Type: Boolean
UMRecipientDialPlanId *
  • Field Name: UMRecipientDialPlanId
  • Type: String
WhenChanged *
  • Field Name: WhenChanged
  • Type: String
  • Format: date-time
ObjectState *
  • Field Name: ObjectState
  • Type: String
ExternalEmailAddress *
  • Field Name: ExternalEmailAddress
  • Type: String
DatabaseName *
  • Field Name: DatabaseName
  • Type: String
StateOrProvince *
  • Field Name: StateOrProvince
  • Type: String
EmailAddressPolicyEnabled *
  • Field Name: EmailAddressPolicyEnabled
  • Type: Boolean
FirstName *
  • Field Name: FirstName
  • Type: String
LastName *
  • Field Name: LastName
  • Type: String
MailboxMoveFlags *
  • Field Name: MailboxMoveFlags
  • Type: String
EmailAddresses
  • Field Name: EmailAddresses.[n]
  • Type: Array
SKUAssigned *
  • Field Name: SKUAssigned
  • Type: String
MailboxMoveStatus *
  • Field Name: MailboxMoveStatus
  • Type: String
AuthenticationType * This parameter applies to objects in the cloud-based service. It isn't available for on-premises deployments. The AuthenticationType parameter specifies the recipient by authentication type. Use one of the following values: Federated Managed
  • Field Name: AuthenticationType
  • Type: String
ManagedBy
  • Field Name: ManagedBy.[n]
  • Type: Array
ExpansionServer *
  • Field Name: ExpansionServer
  • Type: String
PSComputerName
  • Field Name: PSComputerName
  • Type: String
Phone *
  • Field Name: Phone
  • Type: String
PrimarySmtpAddress *
  • Field Name: PrimarySmtpAddress
  • Type: String
MailboxMoveTargetMDB *
  • Field Name: MailboxMoveTargetMDB
  • Type: String
UsageLocation *
  • Field Name: UsageLocation
  • Type: String
ArchiveDatabase *
  • Field Name: ArchiveDatabase
  • Type: String
Database * The Database parameter specifies a mailbox database. Use this parameter to return all recipients stored on a specific mailbox database. Use the mailbox database Name property as the value for this parameter.
  • Field Name: Database
  • Type: String
CustomAttribute1 *
  • Field Name: CustomAttribute1
  • Type: String
CustomAttribute3 *
  • Field Name: CustomAttribute3
  • Type: String
CustomAttribute2 *
  • Field Name: CustomAttribute2
  • Type: String
CustomAttribute5 *
  • Field Name: CustomAttribute5
  • Type: String
CustomAttribute4 *
  • Field Name: CustomAttribute4
  • Type: String
CustomAttribute7 *
  • Field Name: CustomAttribute7
  • Type: String
OwaMailboxPolicy *
  • Field Name: OwaMailboxPolicy
  • Type: String
PostalCode *
  • Field Name: PostalCode
  • Type: String
CustomAttribute8 *
  • Field Name: CustomAttribute8
  • Type: String
ExternalDirectoryObjectId *
  • Field Name: ExternalDirectoryObjectId
  • Type: String
Office *
  • Field Name: Office
  • Type: String
PoliciesIncluded
  • Field Name: PoliciesIncluded.[n]
  • Type: Array
WhenChangedUTC *
  • Field Name: WhenChangedUTC
  • Type: String
  • Format: date-time
RetentionPolicy *
  • Field Name: RetentionPolicy
  • Type: String
Identity * The Identity parameterspecifies the recipient. This parameter accepts the following values: Example: JPhillips Example: Atlanta.Corp.Contoso.Com/Users/JPhillips Example: Jeff Phillips Example: CN=JPhillips,CN=Users,DC=Atlanta,DC=Corp,DC=contoso,DC=com Example: Atlanta\JPhillips Example: fb456636-fe7d-4d58-9d15-5af57d0354c2 Example: [email protected] Example: /o=Contoso/ou=AdministrativeGroup/cn=Recipients/cn=JPhillips Example: [email protected] Example: [email protected]
  • Field Name: Identity
  • Type: String
ActiveSyncMailboxPolicyIsDefaulted *
  • Field Name: ActiveSyncMailboxPolicyIsDefaulted
  • Type: Boolean
City *
  • Field Name: City
  • Type: String
WhenCreatedUTC *
  • Field Name: WhenCreatedUTC
  • Type: String
  • Format: date-time
Capabilities This parameter is reserved for internal Microsoft use.
  • Field Name: Capabilities.[n]
  • Type: Array
Alias *
  • Field Name: Alias
  • Type: String
SharingPolicy *
  • Field Name: SharingPolicy
  • Type: String
UMMailboxPolicy *
  • Field Name: UMMailboxPolicy
  • Type: String
MailboxMoveBatchName *
  • Field Name: MailboxMoveBatchName
  • Type: String
AddressListMembership
  • Field Name: AddressListMembership.[n]
  • Type: Array
MailboxMoveSourceMDB *
  • Field Name: MailboxMoveSourceMDB
  • Type: String
ExtensionCustomAttribute3
  • Field Name: ExtensionCustomAttribute3.[n]
  • Type: Array
ExtensionCustomAttribute2
  • Field Name: ExtensionCustomAttribute2.[n]
  • Type: Array
ExtensionCustomAttribute1
  • Field Name: ExtensionCustomAttribute1.[n]
  • Type: Array
ExtensionCustomAttribute5
  • Field Name: ExtensionCustomAttribute5.[n]
  • Type: Array
ExtensionCustomAttribute4
  • Field Name: ExtensionCustomAttribute4.[n]
  • Type: Array
ServerName *
  • Field Name: ServerName
  • Type: String
Name *
  • Field Name: Name
  • Type: String
ExchangeGuid *
  • Field Name: ExchangeGuid
  • Type: String
ManagedFolderMailboxPolicy *
  • Field Name: ManagedFolderMailboxPolicy
  • Type: String
HasActiveSyncDevicePartnership *
  • Field Name: HasActiveSyncDevicePartnership
  • Type: Boolean
ServerLegacyDN *
  • Field Name: ServerLegacyDN
  • Type: String
AddressBookPolicy *
  • Field Name: AddressBookPolicy
  • Type: String
CustomAttribute11 *
  • Field Name: CustomAttribute11
  • Type: String
CustomAttribute10 *
  • Field Name: CustomAttribute10
  • Type: String
CustomAttribute13 *
  • Field Name: CustomAttribute13
  • Type: String
CustomAttribute12 *
  • Field Name: CustomAttribute12
  • Type: String
CustomAttribute15 *
  • Field Name: CustomAttribute15
  • Type: String
CustomAttribute14 *
  • Field Name: CustomAttribute14
  • Type: String
ObjectClass
  • Field Name: ObjectClass.[n]
  • Type: Array
Manager *
  • Field Name: Manager
  • Type: String
WhenCreated *
  • Field Name: WhenCreated
  • Type: String
  • Format: date-time
CountryOrRegion *
  • Field Name: CountryOrRegion
  • Type: String
OrganizationalUnit * The OrganizationalUnit parameter specifies an organizational unit (OU) or domain canonical name, and is used to limit the results. If you use this parameter, you only get recipients in the container that you specify, for example: OU: westcoast.contoso.com/users Domain: westcoast.contoso.com
  • Field Name: OrganizationalUnit
  • Type: String
API reference for device/exchange/Recipient