3.2. Out-Of-Office
3.3.4. Script Action: Edit mailbox (Exchange2007)
Function
Edit the attributes of an existing mailbox.
Deployment
This action is typically used for editing the settings of mailboxes. Previous values of the properties listed below will be overwritten. Use $null to clear properties.
Properties
Property Name Description Typical setting Remarks
Identity The Identity parameter
identifies the mailbox. (CN=jsmith,OU=sales,DC=tools4ever,DC=com), tools4ever.com\Jsmith, JSmith, [email protected] or the GUID.
Accept messages
only from Optional value. The 'Accept messages only from' parameter specifies the mailbox users, mail users and mail contacts that can send e-mail messages to this mailbox. Use commas to specify multiple values.
(CN=jsmith,OU=sales,DC=tools4ever,DC=com), tools4ever.com\Jsmith, JohnSmith, JSmith, John Smith, [email protected] or the GUID.
Alias Optional value. The Alias parameter specifies the alias (mail nickname) of the user. The alias can be a combination of characters separated by a period with no intervening spaces. Do not use special characters in the alias.
JSmith
Anti spam bypass
enabled Optional value. The 'Anti spam bypass enabled' parameter specifies whether to skip anti-spam processing on this mailbox.
'Yes', 'No'
Custom attribute
1 Optional value. The 'Custom attribute 1' parameter specifies the value for the mailbox attribute CustomAttribute1.
113
Custom attribute
2 Optional value. The 'Custom attribute 2' parameter specifies the value for the mailbox attribute CustomAttribute2. Custom attribute
3 Optional value. The 'Custom attribute 3' parameter specifies the value for the mailbox attribute CustomAttribute2. Custom attribute
4 Optional value. The 'Custom attribute 4' parameter specifies the value for the mailbox attribute CustomAttribute2. Custom attribute
5 Optional value. The 'Custom attribute 5' parameter specifies the value for the mailbox attribute CustomAttribute2. Deliver to mailbox
and forward Optional value. The 'Deliver to mailbox and forward' parameter specifies
whether messages are sent to both this mailbox and the forwarding address. Display name The 'Display name'
parameter specifies the display name for the user account associated with this mailbox. The display name is used by Microsoft Outlook.
John Smith
Domain controller Optional value. The name of the domain controller used to write this configuration change to Active Directory. Use the fully qualified domain name (FQDN) of the domain controller.
114
Email addresses The 'Email addresses' parameter specifies all the proxy addresses of the mailbox. It includes the primary Simple Mail Transfer Protocol (SMTP) address as one of the proxy addresses. Use commas to specify multiple values.
SMTP:[email protected], smtp:[email protected]
Emailaddress
policy enabled The 'Emailaddress policy enabled' parameter specifies whether the e- mail address policy for this mailbox is enabled.
'Yes' or 'No'
External Out of
Office options The 'External Out of Office options' parameter specifies the option for sending an Out of Office message to external senders. Use one of the following values: 'External' and
'InternalOnly'.
External
Forwarding
address The 'Forwarding address' parameter specifies a forwarding address. If 'Deliver to mailbox and forward' is set to 'Yes', messages that are sent to this mailbox will be forwarded to the address specified.
domain.com/Sales/JSmith
Hidden from address lists enabled
The 'Hidden from address lists enabled' parameter specifies whether this mailbox is hidden from other address lists.
'Yes' or 'No'
Issue warning
quota The 'Issue warning quota' parameter specifies the mailbox size at which a warning message is sent to the user. Qualify the value with one of the following: B (bytes), KB (kilobytes), MB (megabytes), GB
(gigabytes) or "unlimited". If this attribute is set on a mailbox, it overrides the default value that is set for this attribute on the mailbox database.
115
Maximum blocked
senders The 'Maximum blocked senders' parameter specifies the maximum number of senders that can be included in the blocked senders list. Blocked senders are senders that are considered junk senders by the mailbox user and are used in junk e-mail rules. This
parameter is only validated when the junk e-mail rules are updated using Outlook Web Access or Web services.
5
Maximum receive
size The 'Maximum receive size' parameter specifies the maximum size of messages that this mailbox can receive. Qualify the value with one of the following: B (bytes), KB (kilobytes), MB (megabytes), GB
(gigabytes) or "unlimited".
50MB
Maximum safe
senders The 'Maximum safe senders' parameter specifies the maximum number of senders that can be included in the safe senders list. Safe senders are senders that are trusted by the mailbox user and are used in junk e-mail rules. This parameter is only validated when the junk e-mail rules are updated using Outlook Web Access or Web services.
15
Maximum send
size The 'Maximum send size' parameter specifies the maximum size of messages that this mailbox can send. Qualify the value with one of the following: B (bytes), KB (kilobytes), MB
(megabytes), GB
(gigabytes) or "unlimited".
116
Name The 'Name' parameter
specifies the Name attribute for this mailbox. The Name attribute is used for the common name (CN) in Active Directory.
John Smith
Office The 'Office' parameter specifies the Microsoft Office attribute for this mailbox.
Primary SMTP
address The 'Primary SMTP address' parameter specifies the address that external users will see when they receive a message from this mailbox. When this parameter is used the 'Email addresses' parameter cannot be specified because 'Email addresses' includes the primary SMTP address.
SMTP:[email protected]
Prohibit send
quota The 'Prohibit send quota' parameter parameter specifies the mailbox size at which the user associated with this mailbox can no longer send messages. Qualify the value with one of the following: B (bytes), KB (kilobytes), MB
(megabytes), GB
(gigabytes) or "unlimited". If this attribute is set on a mailbox, it overrides the default value that is set for this attribute on the mailbox database.
117
Prohibit send
receive quota The 'Prohibit send receive quota' parameter specifies the mailbox size at which the user associated with this mailbox can no longer send or receive messages. Qualify the value with one of the following: B (bytes), KB (kilobytes), MB
(megabytes), GB
(gigabytes) or "unlimited". If this attribute is set on a mailbox, it overrides the default value that is set for this attribute on the mailbox database.
50MB
Recipient limits The 'Recipient limits' parameter specifies the maximum number of recipients per message to which this mailbox can send. Specify either an integer or "unlimited". If this attribute is set on a mailbox, it overrides the default value that is set for this attribute on the hub transport server.
unlimited
Reject messages
from The 'Reject messages from' parameter specifies the recipients from whom messages will be rejected. Use commas to specify multiple values.
domain.com/Sales/JSmith
Require sender authentication enabled
The 'Require sender authentication enabled' parameter specifies whether senders must be authenticated.
'Yes' or 'No'
Retain deleted
items for The 'Retain deleted items for' parameter specifies the length of time to keep deleted items. To specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.
118
Retain deleted items until backup
The 'Retain deleted items until backup' parameter specifies whether to retain deleted items until the next backup.
'Yes' or 'No'
Retention hold
enabled The 'Retention hold enabled' parameter specifies whether retention hold is enabled for MRM. To set the start date for retention hold, use the 'Start date for retention hold' parameter.
'Yes' or 'No'
Rules quota The 'Rules quota' parameter specifies the limit for the size of rules for this mailbox. Qualify the value with one of the following: B (bytes), KB (kilobytes), MB
(megabytes), GB
(gigabytes), TB (terabytes). Unqualified values are treated as bytes. The default value for this parameter is 64 KB. The maximum value for this parameter is 256 KB.
128KB
SamAccountName The 'SamAccountName' parameter specifies the user name for earlier operating systems such as Windows NT 4.0, Windows 98, Windows 95, and LAN Manager. The parameter is used to support clients and servers running older versions of the operating system. This attribute must be less than 20 characters in length.
119
Simple display
name The 'Simple display name' parameter is used on objects where the name of the object may be
displayed in an
environment that does not support Unicode
characters. The only supported characters for the SimpleDisplayName parameter are ASCII characters 26 through 126, inclusively. These
characters are the ones that are typically found on most U.S. English
keyboards.
John Smith
Start date for
retention hold The 'Start date for retention hold' parameter specifies the start date for retention hold for MRM. To use this parameter, the 'Retention hold enabled' parameter must be set to 'Yes'.
'Yes' or 'No'
Use database
quota defaults The 'Use database quota defaults' parameter specifies that this mailbox uses the quota attributes specified for the mailbox database where this mailbox resides. The quota attributes are: 'ProhibitSendQuota', 'ProhibitSendReceiveQuota', 'IssueWarningQuota' and 'RulesQuota'. 'Yes' or 'No' Use database
retention defaults The 'Use database retention defaults' parameter specifies that this mailbox uses the MailboxRetention attribute specified for the mailbox database where this mailbox resides.
120
User principal
name The 'User principal name' parameter specifies the user principal name (UPN) for this mailbox. This is the logon name for the user. The UPN consists of a user name and a suffix.
Typically, the suffix is the domain name where the user account resides.
Windows
emailaddress The 'Windows emailaddress' parameter specifies the Windows e- mail address for this mailbox. This address is not used by Exchange.
121