Applies to: Exchange Server 2013
Topic Last Modified: 2012-10-16
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 Microsoft Office Outlook Web App.
For information about the parameter sets in the Syntax section below, see Syntax.
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>]]
|
Examples
EXAMPLE 1
This example imports the audio file for Tony Smith's spoken name.
 Copy Code |
|
|---|---|
Import-RecipientDataProperty -Identity "Tony Smith" -SpokenName -FileData ([Byte[]]$(Get-Content -Path "M:\AudioFiles\TonySmith.wma" -Encoding Byte -ReadCount 0)) |
|
EXAMPLE 2
This example imports the picture file for Ayla Kol.
| Copy Code |
|
|---|---|
Import-RecipientDataProperty -Identity Ayla -Picture -FileData ([Byte[]]$(Get-Content -Path "M:\Employee Photos\AylaKol.jpg" -Encoding Byte -ReadCount 0)) |
|
Detailed Description
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.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
FileData |
Required |
System.Byte[] |
The FileData parameter specifies the location and file name of the picture or audio file. |
|
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 one of the following values:
|
|
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
The Confirm switch causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You don't have to specify a value with the Confirm switch. |
|
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory. |
|
Picture |
Optional |
System.Management.Automation.SwitchParameter |
The Picture switch specifies that the file you're importing is a picture file. The picture must be a JPEG file and shouldn't be larger than 10 kilobytes (KB). You can't use this parameter in conjunction 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. The maximum file size should be less than 32 KB. You can use one of the following formats:
You can't use this switch in conjunction with the Picture switch. You can only import one file type at a time. |
|
WhatIf |
Optional |
System.Management.Automation.SwitchParameter |
The WhatIf switch instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, you can view what changes would occur without having to apply any of those changes. You don't have to specify a value with the WhatIf switch. |
Input Types
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.
Return Types
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.