Set-ExchangeMailbox cmdlet sets the properties of the mailbox.

This cmdlet supports risk-mitigation parameters.  

Input parameters

 ParameterTypeMandatory (R/O)DescriptionRestrictions/Valid Values
1 Authentication Information (all parameters)  
2

Identity

(aliases: GUID, DistinguishedName)

ADObjectIDParameter R

A property that is used for managing the Exchange mailbox

Value of one of these parameters  can be used as Identity:

#ParameterDescription
1 GUID Globally Unique Identifier (ObjectGuid)
2 DistinguishedName Unique name of the object in Active Directory
3 DeliverAndForwardMail bool O The parameter specifies the message delivery behavior when a ForwardingAddress is specified
  • True - messages are delivered to the current mailbox and forwarded to the specified recipient.

  • False - messages are forwarded and delivered only to the specified recipient. This is the default value.

The value of this parameter is meaningful only if ForwardingAddress is configured.

4 DisplayName string O Name of the mailbox in the list of Control Panel Max length is 256 symbols
5 ForwardingAddress string O A forwarding address for messages that are sent to this mailbox A valid value for this parameter is a recipient of the company.

Recipients: Exchange, POP/IMAP, OWA mailbox, Distribution List, Contact

The default value is null - no forwarding recipient is configured.

6 HideFromAddressBook bool O This  parameter specifies whether this mailbox is visible in the address book
  • True - the mailbox is not visible in the address book.

  • False - the mailbox is visible in the address book. This is the default value.

7 ImapEnabled bool  O This parameter defines whether IMAP protocol is enabled for the mailbox or not
  • True - IMAP is enabled. This is the default value.
  • False - IMAP is not enabled. 

8 OriginatingServer string O

Address of the server (domain name), where the object physically exists

Note: it is recommended to use this parameter as input to guarantee execution of operation with actual data. To get this parameter use Get-ExchangeMailbox cmdlet.

Max length is 255 symbols
9 OwaEnabled bool O

This parameter defines whether OWA protocol is enabled for the mailbox or not

  • True - OWA is enabled. This is the default value.
  • False - OWA is not enabled.

10  PopEnabled bool  O

This parameter defines whether POP protocol is enabled for the mailbox or not

  • True - POP is enabled. This is the default value.
  • False - POP is not enabled.

Output parameters

No parameters

Examples of using Set-ExchangeMailbox cmdlet

Updating DisplayName:

Set-ExchangeMailbox -Identity "0CC18AE9-2BAB-435B-B0BF-719372A4D0F2" -DisplayName "Bobby"

Setting the mailbox as hidden from address lists:

Get-ExchangeMailbox mbx@accountname.hostpilot.com | Set-ExchangeMailbox -HideFromAddressBook $true