Export (0) Print
Expand All

Set-SiteMailbox

Exchange Online
 

Applies to: Exchange Server 2013, Exchange Online

Topic Last Modified: 2014-03-14

This cmdlet is available in on-premises Exchange Server 2013 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Set-SiteMailbox cmdlet to change a site mailbox's settings, such as the Microsoft SharePoint URL. This cmdlet is primarily used by the SharePoint and Microsoft Exchange user interfaces, such as the SharePoint URL. This cmdlet should only be used for diagnostic and troubleshooting purposes.

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

Set-SiteMailbox <COMMON PARAMETERS>
Set-SiteMailbox [-ShowInMyClient <$true | $false>] <COMMON PARAMETERS>
COMMON PARAMETERS: -Identity <RecipientIdParameter> [-Active <$true | $false>] [-Confirm [<SwitchParameter>]] [-DisplayName <String>] [-DomainController <Fqdn>] [-Force <SwitchParameter>] [-Members <RecipientIdParameter[]>] [-Owners <RecipientIdParameter[]>] [-RemoveDuplicateMessages <$true | $false>] [-SharePointUrl <Uri>] [-WhatIf [<SwitchParameter>]]

This example changes the SharePoint URL for the MarketingEvents 2013 site mailbox.

Set-SiteMailbox -Identity "MarketingEvents 2013" -SharePointUrl "https://myserver/teams/marketing"

This example disables the duplication of email messages in the site mailbox SMO_ContosoSales.

Set-SiteMailbox -Identity SMO_ContosoSales -RemoveDuplicateMessages $true

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 "Site mailboxes" entry in the Sharing and collaboration permissions topic.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter

The Identity parameter specifies the identity of the site mailbox. You can use any of the following values:

  • Distinguished name (DN)

  • GUID

  • Name

  • Display name

  • Alias

  • Primary SMTP address

Active

Optional

System.Boolean

The Active parameter specifies whether to change the site mailbox's lifecycle status. This parameter accepts $true or $false. This parameter is intended for use only by the user interface. We recommend that you don't use this parameter in the Exchange Management Shell.

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.

DisplayName

Optional

System.String

The DisplayName parameter specifies the display name of the site mailbox.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

This parameter is available only in on-premises Exchange 2013.

The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory.

Force

Optional

System.Management.Automation.SwitchParameter

The Force parameter specifies that the command should run immediately and bypass confirmation prompts.

Members

Optional

Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter[]

The Members parameter specifies the members of the site mailbox. You can add or remove members using this parameter. This is a multivalued parameter and multiple recipients should be separated by a comma. This parameter is intended for use only by the user interface. We recommend that you don't use this parameter in the Shell.

Owners

Optional

Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter[]

The Owners parameter specifies the site mailbox's owners. This is a multivalued field and multiple recipients should be separated by commas. This parameter is intended for use only by the user interface. We recommend that you don't use this parameter in the Shell.

RemoveDuplicateMessages

Optional

System.Boolean

The RemoveDuplicateMessages parameter specifies that when users post messages to a site mailbox, duplicate messages will be deleted. This parameter accepts the values of $true or $false. The default value is $false.

SharePointUrl

Optional

System.Uri

The SharePointUrl parameter specifies the URL of the SharePoint site, for example, "https://myserver/teams/edu".

ShowInMyClient

Optional

System.Boolean

The ShowInMyClient parameter specifies that the site mailbox folder will show in your email client. This parameter is intended for use only by the user interface. We recommend that you don't use this parameter in the Shell.

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.

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.

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft