TechNet
Export (0) Print
Expand All

Set-MailboxAutoReplyConfiguration

 

Applies to: Exchange Online, Exchange Server 2016

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

Use the Set-MailboxAutoReplyConfiguration cmdlet to configure Automatic Replies settings for a specific mailbox.

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

Set-MailboxAutoReplyConfiguration -Identity <MailboxIdParameter> [-AutoDeclineFutureRequestsWhenOOF <$true | $false>] [-AutoReplyState <Disabled | Enabled | Scheduled>] [-Confirm [<SwitchParameter>]] [-CreateOOFEvent <$true | $false>] [-DeclineAllEventsForScheduledOOF <$true | $false>] [-DeclineEventsForScheduledOOF <$true | $false>] [-DeclineMeetingMessage <String>] [-DomainController <Fqdn>] [-EndTime <DateTime>] [-EventsToDeleteIDs <String[]>] [-ExternalAudience <None | Known | All>] [-ExternalMessage <String>] [-IgnoreDefaultScope <SwitchParameter>] [-InternalMessage <String>] [-OOFEventSubject <String>] [-StartTime <DateTime>] [-WhatIf [<SwitchParameter>]]

This example configures Automatic Replies for Tony's mailbox to be sent between the specified start and end dates and includes an internal message.

Set-MailboxAutoReplyConfiguration -Identity tony -AutoReplyState Scheduled -StartTime "7/10/2015 08:00:00" -EndTime "7/15/2015 17:00:00" -InternalMessage "Internal auto-reply message"

This example configures Automatic Replies for Tony's mailbox to be sent and includes an internal and an external message.

Set-MailboxAutoReplyConfiguration -Identity tony -AutoReplyState Enabled -InternalMessage "Internal auto-reply message." -ExternalMessage "External auto-reply message."

You can disable Automatic Replies for a specified mailbox or organization.

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 "Automatic replies" entry in the Recipients Permissions topic.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter

The Identity parameter specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox.

For example:

  • Name

  • Display name

  • Alias

  • Distinguished name (DN)

  • Canonical DN

  • <domain name>\<account name>

  • Email address

  • GUID

  • LegacyExchangeDN

  • SamAccountName

  • User ID or user principal name (UPN)

AutoDeclineFutureRequestsWhenOOF

Optional

System.Boolean

PARAMVALUE: $true | $false

AutoReplyState

Optional

Microsoft.Exchange.InfoWorker.Common.OOF.OofState

The AutoReplyState parameter specifies whether the mailbox is enabled for Automatic Replies. Valid values are:

  • Enabled  Automatic Replies are sent for the mailbox.

  • Disabled   Automatic Replies aren't sent for the mailbox. This is the default value.

  • Scheduled   Automatic Replies are sent for the mailbox during the time period that's specified by the StartTime and EndTime parameters.

The Enabled and Scheduled values require these additional settings:

  • A value for the InternalMessageValue parameter.

  • A value for the ExternalMessageValue parameter if the ExternalAudience parameter is set to Known or All.

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding.

  • Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false.

  • Most other cmdlets (for example, New-* and Set-* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding.

CreateOOFEvent

Optional

System.Boolean

PARAMVALUE: $true | $false

DeclineAllEventsForScheduledOOF

Optional

System.Boolean

PARAMVALUE: $true | $false

DeclineEventsForScheduledOOF

Optional

System.Boolean

PARAMVALUE: $true | $false

DeclineMeetingMessage

Optional

System.String

PARAMVALUE: String

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

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

The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com.

EndTime

Optional

System.DateTime

The EndTime parameter specifies the end date and time that Automatic Replies are sent for the mailbox. You use this parameter only when the AutoReplyState parameter is set to Scheduled, and the value of this parameter is meaningful only when AutoReplyState is Scheduled.

Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2015 to specify September 1, 2015. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2015 5:00 PM".

EventsToDeleteIDs

Optional

System.String[]

PARAMVALUE: String[]

ExternalAudience

Optional

Microsoft.Exchange.InfoWorker.Common.OOF.ExternalAudience

The ExternalAudience parameter specifies whether Automatic Replies are sent to external senders. Valid values are:

  • None   Automatic Replies aren't sent to any external senders.

  • Known   Automatic Replies are sent only to external senders that are specified in the Contact list of the mailbox.

  • All   Automatic Replies are sent to all external senders. This is the default value.

The value of this parameter is meaningful only when the AutoReplyState parameter is set to Enabled or Scheduled.

ExternalMessage

Optional

System.String

The ExternalMessage parameter specifies the Automatic Replies message that's sent to external senders or senders outside the organization. If the value contains spaces, enclose the value in quotation marks (").

HTML tags are automatically added to the text. For example, if you enter the text, "I'm on vacation", the value automatically becomes: <html><body>I'm on vacation</body></html>. Additional HTML tags are supported if you enclose the value in quotation marks. For example, "<html><body>I'm on vacation.<br>I'll respond when I return.</body></html>".

The value of this parameter is meaningful only when both of the following conditions are true:

  • The AutoReplyState parameter is set to Enabled or Scheduled.

  • The ExternalAudience parameter is set to Known or All.

To clear the value of this parameter when it's no longer required (for example, if you change the ExternalAudience parameter to None), use the value $null.

IgnoreDefaultScope

Optional

System.Management.Automation.SwitchParameter

The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope.

Using the IgnoreDefaultScope switch introduces the following restrictions:

  • You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically.

  • You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted.

InternalMessage

Optional

System.String

The InternalMessage parameter specifies the Automatic Replies message that's sent to internal senders or senders within the organization. If the value contains spaces, enclose the value in quotation marks (").

HTML tags are automatically added to the text. For example, if you enter the text: "I'm on vacation", the value automatically becomes: <html><body>I'm on vacation</body></html>. Additional HTML tags are supported if you enclose the value in quotation marks. For example, "<html><body>I'm on vacation.<br>Please contact my manager.</body></html>".

The value of this parameter is meaningful only when the AutoReplyState parameter is set to Enabled or Scheduled.

To clear the value of this parameter when it's no longer required (for example, if you change the AutoReplyState parameter to Disabled), use the value $null.

OOFEventSubject

Optional

System.String

PARAMVALUE: String

StartTime

Optional

System.DateTime

The StartTime parameter specifies the start date and time that Automatic Replies are sent for the specified mailbox. You use this parameter only when the AutoReplyState parameter is set to Scheduled, and the value of this parameter is meaningful only when AutoReplyState is Scheduled.

Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2015 to specify September 1, 2015. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2015 5:00 PM".

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this 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.

 
Show:
© 2016 Microsoft