19.4 Set-DRAOnlineMailbox

Synopsis

Updates a online shared mailbox in Exchange Online.

Syntax

Set-DRAOnlineMailbox -Tenant <String> [-
AcceptMessagesOnlyFromSendersOrMembers <String[]>][-
RejectMessagesFromSendersOrMembers <String[]> [-Alias <String>] [-
DisplayName <String>] [-CustomAttribute1 <String>] [-CustomAttribute2
<String>] [-CustomAttribute3 <String>] [-CustomAttribute4 <String>] [-
CustomAttribute5 <String> [-CustomAttribute6 <String>] [-CustomAttribute7
<String>] [-CustomAttribute8 <String>] [-CustomAttribute9 <String>] [-
CustomAttribute10 <String>] [-CustomAttribute11 <String>] [-
CustomAttribute12 <String>] [-CustomAttribute13 <String>] [-
CustomAttribute14 <String>] [-CustomAttribute15 <String>] [-EmailAddresses
<String>] [-ForwardingSmtpAddress <String[]>][-GrantSendOnBehalfTo
<String[]>] [-DeliverToMailboxAndForward <Boolean>][-
LitigationHoldDuration <String[]>] [-LitigationHoldEnabled
<String[]>] [-HiddenFromAddressListsEnabled <Boolean>] [-MailTip
<String>][-MaxReceiveSize <String[]> [-MaxSendSize <String[]> [-Name
<String>] [-RecipientLimits <Int32> [-UserPrincipalName <String>] [-
Properties <Hashtable>] [-Replace <Hashtable>] [-Add <Hashtable>] [-Remove
<Hashtable>] [-Clear <String[]>] -Identifier <String>

Description

The Set-DRAOnlineMailbox cmdlet updates a shared mailbox in Exchange Online.

Parameters

Attribute / Description

Parameters / Values

Required

Position

Default Value

Accept Pipeline input?

Accept wildcard characters?

AcceptMessagesOnlyFromSende rsOrMembers[<String>]

The AcceptMessagesOnlyFromSende rsOrMembers parameter specifies who is allowed to send messages to this recipient.Messages from other senders are rejected.

false

named

 

true (ByPropertyName)

false

RejectMessagesFromSendersOr Members [<String>]

The RejectMessagesFromSendersOr Members parameter specifies who isn't allowed to send messages to this recipient. Messages from these senders are rejected.

false

named

 

true (ByPropertyName)

false

Alias [<String>]

The Exchange alias (also known as the mail nickname) for the onpremises user account.

false

named

 

true (ByPropertyName)

false

DisplayName [<String>]

The display name of the user and the associated mailbox in the cloud-based service.

false

named

 

true (ByPropertyName)

false

CustomAttribute1 [<String>]

CustomAttribute1 property with custom information about the remote mailbox.

false

named

true (ByPropertyName)

false

CustomAttribute2 [<String>]

CustomAttribute2 property with custom information about the remote mailbox.

false

named

true (ByPropertyName)

false

CustomAttribute3 [<String>]

CustomAttribute3 property with custom information about the remote mailbox.

false

named

true (ByPropertyName)

false

CustomAttribute4 [<String>]

CustomAttribute4 property with custom information about the remote mailbox.

false

named

true (ByPropertyName)

false

CustomAttribute5 [<String>]

CustomAttribute5 property with custom information about the remote mailbox.

false

named

true (ByPropertyName)

false

CustomAttribute6 [<String>]

CustomAttribute6 property with custom information about the remote mailbox.

false

named

true (ByPropertyName)

false

CustomAttribute7 [<String>]

CustomAttribute7 property with custom information about the remote mailbox.

false

named

true (ByPropertyName)

false

CustomAttribute8 [<String>]

CustomAttribute8 property with custom information about the remote mailbox.

false

named

true (ByPropertyName)

false

CustomAttribute9 [<String>]

CustomAttribute9 property with custom information about the remote mailbox.

false

named

true (ByPropertyName)

false

CustomAttribute10 [<String>]

CustomAttribute10 property with custom information about the remote mailbox.

false

named

true (ByPropertyName)

false

CustomAttribute11 [<String>]

CustomAttribute11 property with custom information about the remote mailbox.

false

named

true (ByPropertyName)

false

CustomAttribute12 [<String>]

CustomAttribute12 property with custom information about the remote mailbox.

false

named

true (ByPropertyName)

false

CustomAttribute13 [<String>]

CustomAttribute13 property with custom information about the remote mailbox.

false

named

true (ByPropertyName)

false

CustomAttribute14 [<String>]

CustomAttribute14 property with custom information about the remote mailbox.

false

named

true (ByPropertyName)

false

CustomAttribute15 [<String>]

CustomAttribute15 property with custom information about the remote mailbox.

false

named

true (ByPropertyName)

false

EmailAddresses [<String>]

Proxy email addresses for the remote mailbox.

false

named

true (ByPropertyName)

false

HiddenFromAddressListsEnabled[<Nullable`1>]

Indicates whether the remote mailbox is visible from other address lists.

false

named

true (ByPropertyName)

false

MailTip [<String>]

Custom MailTip text for the remote mailbox.

false

named

true (ByPropertyName)

false

DeliverToMailboxAndForward [<Nullable`1>]

The DeliverToMailboxAndForward parameter specifies the message delivery behavior when a forwarding address is specified by the ForwardingAddress or ForwardingSmtpAddress parameters.

false

named

true (ByPropertyName)

false

ForwardingSmtpAddress [<String>]

The ForwardingSmtpAddress parameter specifies a forwarding SMTP address for messages that are sent to this mailbox.

false

position

true (ByPropertyName)

false

LitigationHoldDuration [<String>]

The LitigationHoldDuration parameter specifies how long mailbox items are held if the mailbox is placed on litigation hold.

false

named

true (ByPropertyName)

false

MaxReceiveSize [<String>]

The MaxReceiveSize parameter specifies the maximum size of a message that can be sent to the mailbox. Messages larger than the maximum size are rejected.

false

named

true (ByPropertyName)

false

MaxSendSize [<String>]

The MaxSendSize parameter specifies the maximum size of a message that can be sent by the mailbox.

false

named

true (ByPropertyName)

false

RecipientLimits [<Int32>]

The RecipientLimits parameter specifies the maximum number of recipients allowed in messages sent by the mailbox.

false

named

true (ByPropertyName)

false

Name [<String>]

The unique name of the onpremises user and the associated mailbox in the cloud-based service.

false

named

true (ByPropertyName)

false

UserPrincipalName [<String>]

Indicates whether the user must change their password the next time they log on.

false

named

true (ByPropertyName)

false

Properties <Hashtable>

A hashtable of property values. The key is the name of a defined attribute in the REST interface. For example: -Properties @{Attribute1DRADisplayN ame="my value"; Attribute2DRADisplayName=value} Multiple values are specified as a comma-separated list.

For example: -Properties @{Attribute1DRADisplayN ame=value1, value2}

If the property name contains non-alphanumeric characters it needs to be quoted.

For example: -Properties @{"Attribute1-DRADisplayName"=value}

If the property value contains a quote it needs to be escaped with a backtick (`).

For example: -Properties @{Attribute1DRADisplayN ame="`"sample`" value"}

false

named

true (ByPropertyName)

false

Replace [<Hashtable>]

A Hashtable of property values to replace the current set of values for the specified property. The key is the name of a defined property in the REST interface. For example: -Replace @{Attribute1DRADisplayName="my value"; Attribute2DRADisplayName=value}Multiple values are specified as a comma-separated list and will replace currently set values.

For example: -Replace @{Attribute1DRADisplayN ame=value1, value2}

If the property name contains non-alphanumeric characters it needs to be quoted.

For example: -Replace @{"Attribute1-DRADisplayName"=value}

If the property value contains a quote it needs to be escaped with a backtick (`).

For example: -Replace@{Attribute1DRADisplayName="`"sample`" value"}

false

named

true (ByPropertyName)

false

Add [<Hashtable>]

A Hashtable of property values to add to the current set of values for the specified multi-valued property. The key is the name of a defined property in the REST interface.

For example: -Add @{Attribute1DRADisplayName=value; Attribute2DRADisplayName=value1, value2; ...; AttributeNDRADisplayName=value1, value2}

Multiple values are specified as a comma-separated list.

For example: -Add @{Attribute1DRADisplayN ame=value1, value2}}

If the property name contains non-alphanumeric characters it needs to be quoted.

For example: -Add @{"Attribute1-DRADisplayName"=value}

If the property value contains a quote it needs to be escaped with a backtick (`).

For example: -Add @{Attribute1DRADisplayName="`"sample`" value"}

false

named

true (ByPropertyName)

false

Remove [<Hashtable>]

A Hashtable of property values to remove from the current set of values for the specified multivalued property.

The key is the name of a defined property in the REST interface.

For example: -Remove @{Attribute1DRADisplayName=value; Attribute2DRADisplayName=value1, value2; ...; AttributeNDRADisplayName=value1, value2}

Multiple values are specified as a comma-separated list and will be removed from currently set values.

For example: -Remove @{Attribute1DRADisplayName=value1,value2}

If the property name contains non-alphanumeric characters it needs to be quoted.

For example: -Remove @{"Attribute1-DRADisplayName"=value}

If the property value contains a quote it needs to be escaped with a backtick (`).

For example: -Remove @{Attribute1DRADisplayN ame="`"sample`" value"

false

named

true (ByPropertyName)

false

Clear [<String>]

An array of property names whose values will be cleared. Each name is the name of a defined property in the REST interface.

For example: -Clear "Attribute1-DRADisplayName"

Multiple values need to be separated by a comma.

For example: -Clear Attribute1DRADisplayName, Attribute2DRADisplayName

false

named

true (ByPropertyName)

false

Tenant [<String>]

The Tenant ID of the object in GUID or displayname format.

true

named

true (ByPropertyName)

false

Identifier [<String>]

The name or distinguished name of an existing Active Directory object.

true

named

true (ByPropertyName)

false

NOTE:For more information, type "Get-Help Set-DRAOnlineMailbox -detailed". For technical information, type "Get-Help Set-DRAOnlineMailbox -full".

Example 19-7 1

PS C:\\>Set-DRAOnlineMailbox -Tenant b201dhg8-087e-5n9d-9986-c4d987bfa0b1
-Identifier 23225bb1-5ac0-4b4c-a23c-beb7fad44b65-Properties
@{JobTitle="Manager";city="Houston"}

This example updates the specified properties of the online shared mailbox with the GUID 23225bb1-5ac0-4b4c-a23c-beb7fad44b65 in the tenant with the ID b201dhg8-087e-5n9d-9986- c4d987bfa0b1. The properties updated are JobTitle and City.

Example 19-8 2

PS C:\\>Set-DRAOnlineMailbox -Tenant b201dhg8-087e-5n9d-9986-c4d987bfa0b1
-Identifier 23225bb1-5ac0-4b4c-a23c-beb7fad44b65-Properties
@{AddToGroups="CN=a89cc7f6-1e9f-41fc-9715-f3e27fb1f4cb,AZ=b201dhg8-087e-
5n9d-9986-c4d987bfa0b1"}

This example updates the specified property of the online shared mailbox 23225bb1-5ac0-4b4ca23c-beb7fad44b65 in tenant b201dhg8-087e-5n9d-9986-c4d987bfa0b1. The identifier contains the GUID for the online shared mailbox. The property AddToGroups will add the user to the specified group.