New-AlternateMailbox

  • Article

[This is pre-release documentation and subject to change in future releases. This topic's current status is: Writing.]

Applies to: Exchange Server 2010 Beta* *Topic Last Modified: 2008-12-11

Use the New-AlternateMailbox cmdlet to create a new alternate mailbox for an existing mailbox user.

Syntax

New-AlternateMailbox -Name <String> -Mailbox <MailboxIdParameter> -Type <Archive | Subscription> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-RetentionPolicyEnabled <$true | $false>] [-UserDisplayName <String>] [-WhatIf [<SwitchParameter>]]

Parameters

Parameter Required Type Description

Name

Required

System.String

The Name parameter specifies a name for the alternate mailbox.

Mailbox

Required

Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter

The Mailbox parameter identifies the primary mailbox. You can use one of the following values:

  • GUID
  • Distinguished Name (DN)
  • Domain\Account
  • User principal name (UPN)
  • SmtpAddress
  • Alias

Type

Required

Microsoft.Exchange.Management.RecipientTasks.AlternateMailboxType

The Type parameter specifies the type of alternate mailbox to be created. Valid values include:

  • Archive
  • Subscription

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.

UserDisplayName

Optional

System.String

A description is not available for this parameter.

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.

RetentionPolicyEnabled

Optional

System.Boolean

The RetentionEnabled parameter specifies whether the alternate mailbox is MRM-enabled. By default, alternate mailboxes are not MRM-enabled. Set the value to $true to MRM-enable the mailbox.

To run this cmdlet, you must be assigned, either directly or using a universal security group, one of the following management roles:

  • Organization Management
  • Recipient Management
  • Organization Management - Tenant
  • Recipient Management - Tenant

While all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they are not included in the management roles assigned to you. For more information, see Permissions Information for Cmdlet Help and Procedural Topics.

Input Types

Return Types

Errors

Error Description

Examples

EXAMPLE 1

This example creates a new alternate mailbox of type Archive for the user John.

New-AlternateMailbox -Name Archive -Mailbox "john@contoso.com" -Type Archive