Export (0) Print
Expand All

Update-SiteMailbox

Exchange Online
 

Applies to: Exchange Server 2013, Exchange Online

Topic Last Modified: 2014-03-31

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 Update-SiteMailbox cmdlet to trigger a Microsoft SharePoint synchronization. This command synchronizes document content membership and permissions into Microsoft Exchange. You may need to perform this action when troubleshooting document or membership synchronization issues.

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

Update-SiteMailbox -Identity <RecipientIdParameter> [-BypassOwnerCheck <SwitchParameter>] [-FullSync <SwitchParameter>] [-Organization <OrganizationIdParameter>] [-Server <String>] [-Confirm [<SwitchParameter>]] [-Target <All | Document | Membership | Maintenance>] [-WhatIf [<SwitchParameter>]]

This example updates the site mailbox MarketingEvents 2013. If you don't specify the target, this triggers both document and membership synchronization. Because the BypassOwnerCheck parameter is used, it isn't necessary to be an owner or member of the site mailbox to run this cmdlet.

Update-SiteMailbox -BypassOwnerCheck -Identity "MarketingEvents 2013"

This example updates the site mailbox WinterHoliday@tailspintoys.com and performs a full synchronization. By default, the update only occurs for synchronization from the last synchronization. This is only applicable to document synchronization

Update-SiteMailbox -BypassOwnerCheck -Identity WinterHoliday@tailspintoys.com -FullSync

If you are running this command against a site mailbox in which you aren’t the owner, you need to use the BypassOwnerCheck parameter to run this cmdlet.

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. This parameter accepts the following values:

  • DisplayName

  • SMTP address

  • Name

  • GUID

BypassOwnerCheck

Optional

System.Management.Automation.SwitchParameter

The BypassOwnerCheck parameter specifies that the user running the command in the Exchange Management Shell isn't a site mailbox owner or member. If you run the command without this parameter and you aren't the site mailbox owner or member, the command doesn't run or return any information.

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.

FullSync

Optional

System.Management.Automation.SwitchParameter

The FullSync parameter specifies full sync is expensive and will have a performance impact on the Exchange system.

Organization

Optional

Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter

The Organization parameter is reserved for internal Microsoft use.

Server

Optional

System.String

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

The Server parameter specifies the fully qualified domain name (FQDN) or the Microsoft SharePoint server on which the site mailbox is located.

Target

Optional

Microsoft.Exchange.Management.RecipientTasks.TeamMailboxDiagnosticsBase+TargetType

The Target parameter specifies whether to update the SharePoint documents, the site mailbox's membership list or both. This parameter accepts the following values:

  • All

  • Document

  • Membership

If you don't specify this parameter when you run the cmdlet, this parameter value defaults to ALL.

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