Share via

Set-MailPublicFolder

  • Article

 

Applies to: Exchange Server 2007 SP1, Exchange Server 2007 SP2, Exchange Server 2007 SP3

Use the Set-MailPublicFolder cmdlet to configure the mail-related settings of mail-enabled public folders. If you want to configure basic settings that are not mail related, use the Set-PublicFolder cmdlet.

Syntax

Set-MailPublicFolder -Identity <MailPublicFolderIdParameter> [-AcceptMessagesOnlyFrom <RecipientIdParameter[]>] [-AcceptMessagesOnlyFromDLMembers <RecipientIdParameter[]>] [-Alias <String>] [-Confirm [<SwitchParameter>]] [-Contacts <RecipientIdParameter[]>] [-CreateDTMFMap <$true | $false>] [-CustomAttribute1 <String>] [-CustomAttribute10 <String>] [-CustomAttribute11 <String>] [-CustomAttribute12 <String>] [-CustomAttribute13 <String>] [-CustomAttribute14 <String>] [-CustomAttribute15 <String>] [-CustomAttribute2 <String>] [-CustomAttribute3 <String>] [-CustomAttribute4 <String>] [-CustomAttribute5 <String>] [-CustomAttribute6 <String>] [-CustomAttribute7 <String>] [-CustomAttribute8 <String>] [-CustomAttribute9 <String>] [-DeliverToMailboxAndForward <$true | $false>] [-DisplayName <String>] [-DomainController <Fqdn>] [-EmailAddresses <ProxyAddressCollection>] [-EmailAddressPolicyEnabled <$true | $false>] [-ForwardingAddress <RecipientIdParameter>] [-GrantSendOnBehalfTo <MailboxOrMailUserIdParameter[]>] [-HiddenFromAddressListsEnabled <$true | $false>] [-IgnoreDefaultScope <SwitchParameter>] [-MaxReceiveSize <Unlimited>] [-MaxSendSize <Unlimited>] [-Name <String>] [-PhoneticDisplayName <String>] [-PrimarySmtpAddress <SmtpAddress>] [-PublicFolderType <GeneralPurpose | Mapi | Nntp | NotSpecified>] [-RejectMessagesFrom <RecipientIdParameter[]>] [-RejectMessagesFromDLMembers <RecipientIdParameter[]>] [-RequireSenderAuthenticationEnabled <$true | $false>] [-Server <ServerIdParameter>] [-SimpleDisplayName <String>] [-UMDtmfMap <MultiValuedProperty>] [-UseRusServer <String>] [-WhatIf [<SwitchParameter>]] [-WindowsEmailAddress <SmtpAddress>]

Set-MailPublicFolder [-AcceptMessagesOnlyFrom <RecipientIdParameter[]>] [-AcceptMessagesOnlyFromDLMembers <RecipientIdParameter[]>] [-Alias <String>] [-Confirm [<SwitchParameter>]] [-Contacts <RecipientIdParameter[]>] [-CreateDTMFMap <$true | $false>] [-CustomAttribute1 <String>] [-CustomAttribute10 <String>] [-CustomAttribute11 <String>] [-CustomAttribute12 <String>] [-CustomAttribute13 <String>] [-CustomAttribute14 <String>] [-CustomAttribute15 <String>] [-CustomAttribute2 <String>] [-CustomAttribute3 <String>] [-CustomAttribute4 <String>] [-CustomAttribute5 <String>] [-CustomAttribute6 <String>] [-CustomAttribute7 <String>] [-CustomAttribute8 <String>] [-CustomAttribute9 <String>] [-DeliverToMailboxAndForward <$true | $false>] [-DisplayName <String>] [-DomainController <Fqdn>] [-EmailAddresses <ProxyAddressCollection>] [-EmailAddressPolicyEnabled <$true | $false>] [-ForwardingAddress <RecipientIdParameter>] [-GrantSendOnBehalfTo <MailboxOrMailUserIdParameter[]>] [-HiddenFromAddressListsEnabled <$true | $false>] [-IgnoreDefaultScope <SwitchParameter>] [-Instance <MailPublicFolder>] [-MaxReceiveSize <Unlimited>] [-MaxSendSize <Unlimited>] [-Name <String>] [-PhoneticDisplayName <String>] [-PrimarySmtpAddress <SmtpAddress>] [-PublicFolderType <GeneralPurpose | Mapi | Nntp | NotSpecified>] [-RejectMessagesFrom <RecipientIdParameter[]>] [-RejectMessagesFromDLMembers <RecipientIdParameter[]>] [-RequireSenderAuthenticationEnabled <$true | $false>] [-Server <ServerIdParameter>] [-SimpleDisplayName <String>] [-UMDtmfMap <MultiValuedProperty>] [-UseRusServer <String>] [-WhatIf [<SwitchParameter>]] [-WindowsEmailAddress <SmtpAddress>]

Detailed Description

To run the Set-MailPublicFolder cmdlet, the account you use must be delegated the following:

  •  Exchange Public Folder Administrator role and local Administrators group for the target server

For more information about permissions, delegating roles, and the rights that are required to administer Microsoft Exchange Server 2007, see Permission Considerations.

Parameters

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.MailPublicFolderIdParameter

Use the Identity parameter to specify the GUID or public folder name that represents a specific public folder. You can also include the path using the format \TopLevelPublicFolder\PublicFolder.

You can omit the parameter label Identity so that only the public folder name or GUID is supplied.

AcceptMessagesOnlyFrom

Optional

Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter[]

Use the AcceptMessagesOnlyFrom parameter to specify a limited list of senders from which to accept messages.

AcceptMessagesOnlyFromDLMembers

Optional

Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter[]

Use the AcceptMessagesOnlyFromDLMembers parameter to specify distribution list members who can send messages to the mail-enabled public folder.

Alias

Optional

System.String

Use the Alias parameter to specify the alias (mail nickname) of the public folder. If not specified, the Alias parameter value is stamped with the name of the public folder.

The string must comply with RFC 2821 requirements for valid "local part" SMTP addresses.

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm parameter 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 parameter.

Contacts

Optional

Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter[]

The Contacts parameter specifies the contacts for the public folder. Contacts are persons about whom you can save several types of information, such as addresses, telephone numbers, and Web page URLs.

CreateDTMFMap

Optional

System.Boolean

This parameter specifies that a dual tone multi-frequency (DTMF) map be created for the user.

CustomAttribute1

Optional

System.String

The CustomAttribute1 parameter can be any string value.

CustomAttribute10

Optional

System.String

The CustomAttribute10 parameter can be any string value.

CustomAttribute11

Optional

System.String

The CustomAttribute11 parameter can be any string value.

CustomAttribute12

Optional

System.String

The CustomAttribute12 parameter can be any string value.

CustomAttribute13

Optional

System.String

The CustomAttribute13 parameter can be any string value.

CustomAttribute14

Optional

System.String

The CustomAttribute14 parameter can be any string value.

CustomAttribute15

Optional

System.String

The CustomAttribute15 parameter can be any string value.

CustomAttribute2

Optional

System.String

The CustomAttribute2 parameter can be any string value.

CustomAttribute3

Optional

System.String

The CustomAttribute3 parameter can be any string value.

CustomAttribute4

Optional

System.String

The CustomAttribute4 parameter can be any string value.

CustomAttribute5

Optional

System.String

The CustomAttribute5 parameter can be any string value.

CustomAttribute6

Optional

System.String

The CustomAttribute6 parameter can be any string value.

CustomAttribute7

Optional

System.String

The CustomAttribute7 parameter can be any string value.

CustomAttribute8

Optional

System.String

The CustomAttribute8 parameter can be any string value.

CustomAttribute9

Optional

System.String

The CustomAttribute9 parameter can be any string value.

DeliverToMailboxAndForward

Optional

System.Boolean

The DeliverToMailboxAndForward parameter specifies whether e-mail messages will be sent to a forwarding address.

DisplayName

Optional

System.String

The DisplayName parameter specifies the display name of the Public Folder Proxy object.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

To specify the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory directory service, include the DomainController parameter in the command.

EmailAddresses

Optional

Microsoft.Exchange.Data.ProxyAddressCollection

Use the EmailAddresses parameter to specify proxy addresses (for example, user@contoso.com).

EmailAddressPolicyEnabled

Optional

System.Boolean

Use the EmailAddressPolicyEnabled parameter to enable or disable an e-mail address policy applied to the folder.

ForwardingAddress

Optional

Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter

Use the ForwardingAddress parameter to set the forwarding address of the folder.

GrantSendOnBehalfTo

Optional

Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter

The GrantSendOnBehalfTo parameter specifies the distinguished name of other mailboxes that can send on behalf of this folder.

HiddenFromAddressListsEnabled

Optional

System.Boolean

The HiddenFromAddressListsEnabled parameter specifies whether the mailbox is viewable from address lists.

IgnoreDefaultScope

Optional

System.Management.Automation.SwitchParameter

The IgnoreDefaultScope parameter instructs the command to ignore the default recipient scope setting for the Exchange Management Shell and use the entire forest as the scope. This allows the command to access Active Directory objects that are not currently in the default scope. Using the IgnoreDefaultScope parameter introduces the following restrictions:

  • You cannot use the DomainController parameter. The command will use an appropriate global catalog server automatically.

  • You can only use the distinguished name for the Identity parameter. Other forms of identification, such as alias or GUID, are not accepted.

Instance

Optional

Microsoft.Exchange.Data.Directory.Management.MailPublicFolder

The Instance parameter specifies an instance of an Active Directory object that is piped to and consumed by this command.

MaxReceiveSize

Optional

Microsoft.Exchange.Data.Unlimited

The MaxReceiveSize parameter specifies the maximum size of e-mail messages that can be received by the folder. Valid values are from 1 kilobyte (KB) to 2,097,151 KB. If a value is not specified for this parameter, no size limit is imposed.

MaxSendSize

Optional

Microsoft.Exchange.Data.Unlimited

The MaxSendSize parameter specifies the maximum size of e-mail messages that can be sent. Valid values are from 1 KB to 2,097,151 KB. If a value is not specified for this parameter, no size limit is imposed.

Name

Optional

System.String

The Name parameter specifies the name of the public folder.

PhoneticDisplayName

Optional

System.String

The PhoneticDisplayName parameter specifies a phonetic pronunciation of the DisplayName parameter.

The maximum length of this parameter value is 255 characters. For more information about the PhoneticDisplayName parameter and speech recognition, see Understanding Automatic Speech Recognition Directory Lookups.

PrimarySmtpAddress

Optional

Microsoft.Exchange.Data.SmtpAddress

Use the PrimarySmtpAddress parameter to specify the primary SMTP address for the folder.

PublicFolderType

Optional

Microsoft.Exchange.Data.Directory.Recipient.PublicFolderType

The PublicFolderType parameter specifies which of the following four types is assigned to the public folder:

  • GeneralPurpose

  • MAPI

  • NNTP

  • NotSpecified

RejectMessagesFrom

Optional

Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter[]

The RejectMessagesFrom parameter specifies the recipients from which to reject messages.

RejectMessagesFromDLMembers

Optional

Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter[]

The RejectMessagesFromDLMembers parameter specifies the distribution list members from which to reject messages.

RequireSenderAuthenticationEnabled

Optional

System.Boolean

The RequireSenderAuthenticationEnabled parameter specifies whether senders must be authenticated.

Server

Optional

Microsoft.Exchange.Configuration.Tasks.ServerIdParameter

The Server parameter specifies the identity of the server to perform the operation from. If a server is not specified, the command checks if the local server is a Mailbox server that is running Exchange 2007 with a public folder database. If it is, the folder will be created locally. If it is not, the command finds the closest (by site cost) Exchange 2007 Mailbox server that has a mounted public folder database.

SimpleDisplayName

Optional

System.String

The SimpleDisplayName parameter is used to display an alternative description of the object when only a limited set of characters is permitted. This limited set of characters consists of ASCII characters 26 through 126, inclusively.

UMDtmfMap

Optional

Microsoft.Exchange.Data.MultiValuedProperty

Use the UMDtmfMap parameter specifies if you want to create a user-defined DTMF map for the UM-enabled user. 

UseRusServer

Optional

System.String

Note   This parameter is available only in Exchange Server 2007 SP2.

The UseRusServer parameter instructs the command to use the specified Mailbox server on which the Address List service is running to obtain and then set mailbox and Active Directory user attributes.

The Address List service is a component in the Exchange System Attendant service. The Address List service creates and maintains Exchange-specific attribute values in Active Directory. You can use the Address List service to update recipient objects in a domain by using specific information, such as address list membership and e-mail addresses.

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf parameter instructs the command to simulate the actions that it would take on the object. By using the WhatIf parameter, 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 parameter.

WindowsEmailAddress

Optional

Microsoft.Exchange.Data.SmtpAddress

The WindowsEmailAddress parameter specifies an e-mail address in the format E-mailAddress@contoso.com.

Input Types

Return Types

Errors

Error Description

 

Exceptions

Exceptions Description

 

Example

This example sets the primary SMTP address of the mail-enabled public folder MyPublicFolder@contoso.com to MyPublicFolder@fabrikam.com.

Set-MailPublicFolder -Identity MyPublicFolder@contoso.com -PrimarySmtpAddress MyPublicFolder@fabrikam.com