TechNet
Export (0) Print
Expand All
Collapse the table of content
Expand the table of content
Expand Minimize

Import-RecipientDataProperty

 

Applies to: Exchange Server 2016

This cmdlet is available only in on-premises Exchange Server 2016.

Use the Import-RecipientDataProperty cmdlet to add a picture or an audio file of a spoken name to a mailbox or contact. The picture and audio files display on the Global Address List property dialog box, contact card, reading pane, and meeting requests in Microsoft Outlook and Outlook on the web.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Import-RecipientDataProperty [-Picture <SwitchParameter>] <COMMON PARAMETERS>
Import-RecipientDataProperty [-SpokenName <SwitchParameter>] <COMMON PARAMETERS>
COMMON PARAMETERS: -FileData <Byte[]> -Identity <MailboxUserContactIdParameter> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-WhatIf [<SwitchParameter>]]

This example imports the audio file for Tony Smith's spoken name.

Import-RecipientDataProperty -Identity "Tony Smith" -SpokenName -FileData ([Byte[]]$(Get-Content -Path "M:\AudioFiles\TonySmith.wma" -Encoding Byte -ReadCount 0))

This example imports the picture file for Ayla Kol.

Import-RecipientDataProperty -Identity Ayla -Picture -FileData ([Byte[]]$(Get-Content -Path "M:\Employee Photos\AylaKol.jpg" -Encoding Byte -ReadCount 0))

Importing and exporting files require a specific syntax because importing and exporting use Remote PowerShell.

You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "Recipient data properties" entry in the Recipients Permissions topic.

 

Parameter Required Type Description

FileData

Required

System.Byte[]

The FileData parameter specifies the location and file name of the picture or audio file.

A valid value for this parameter requires you to read the file to a byte-encoded object using the Get-Content cmdlet. For example, ([Byte[]](Get-Content -Encoding Byte -Path "C:\My Documents\<filename>" -ReadCount 0)).

Identity

Required

Microsoft.Exchange.Configuration.Tasks.MailboxUserContactIdParameter

The Identity parameter specifies the mailbox or contact that you're adding the picture or spoken name file to. You can use any value that uniquely identifies the user.

For example:

  • Name

  • Display name

  • Distinguished name (DN)

  • Canonical DN

  • GUID

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding.

  • Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false.

  • Most other cmdlets (for example, New-* and Set-* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com.

Picture

Optional

System.Management.Automation.SwitchParameter

The Picture switch specifies that the file you're importing is a picture file. You don't need to specify a value with this switch.

The picture must be a JPEG file and shouldn't be larger than 10 kilobytes (KB). You can't use this switch with the SpokenName switch. You can only import one file type at a time.

SpokenName

Optional

System.Management.Automation.SwitchParameter

The SpokenName switch specifies that the file you're importing is an audio file. You don't need to specify a value with this switch.

The maximum file size should be less than 32 KB. You can use one of the following formats:

  • WMA 9-voice

  • PCM 8-KHz, 16-bits, mono format

You can't use this switch with the Picture switch. You can only import one file type at a time.

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch.

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.

 
Show:
© 2016 Microsoft