Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

Set-PopSubscription

 

Applies to: Exchange Online

Topic Last Modified: 2012-09-17

This cmdlet is available only in the cloud-based service.

Use the Set-PopSubscription cmdlet to modify the properties of an existing POP subscription that's configured in a user's cloud-based mailbox.

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

Set-PopSubscription -Identity <AggregationSubscriptionIdParameter> [-DisplayName <String>] [-EmailAddress <SmtpAddress>] [-Enabled <$true | $false>] [-EnablePoisonSubscription <SwitchParameter>] [-Force <SwitchParameter>] [-IncomingAuth <Basic | Spa>] [-IncomingPassword <SecureString>] [-IncomingPort <Int32>] [-IncomingSecurity <None | Ssl | Tls>] [-IncomingServer <Fqdn>] [-IncomingUserName <String>] [-LeaveOnServer <$true | $false>] [-Mailbox <MailboxIdParameter>] <COMMON PARAMETERS>
Set-PopSubscription -Identity <AggregationSubscriptionIdParameter> [-DisableAsPoison <SwitchParameter>] [-Mailbox <MailboxIdParameter>] <COMMON PARAMETERS>
Set-PopSubscription -Identity <AggregationSubscriptionIdParameter> [-Mailbox <MailboxIdParameter>] <COMMON PARAMETERS>
Set-PopSubscription -Identity <AggregationSubscriptionIdParameter> [-Mailbox <MailboxIdParameter>] [-ValidateSecret <String>] <COMMON PARAMETERS>
Set-PopSubscription -Identity <AggregationSubscriptionIdParameter> [-Mailbox <MailboxIdParameter>] [-ResendVerification <SwitchParameter>] <COMMON PARAMETERS>
COMMON PARAMETERS: [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-WhatIf [<SwitchParameter>]]

This example modifies the value of the LeaveOnServer parameter for the POP subscription Ayla Contoso that's configured in the cloud-based mailbox of the user Ayla Kol.

Set-PopSubscription "Ayla Contoso" -Mailbox "Ayla Kol" -LeaveOnServer $false

You can set properties for the POP subscription, such as the POP server, TCP port number, encryption method, and authentication method.

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 "Subscriptions" entry in the Feature Permissions in Exchange Online topic.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.AggregationSubscriptionIdParameter

The Identity parameter specifies the POP subscription. You can identify the subscription by using one of the following methods:

  • Specify the globally unique identifier of the subscription, which is its canonical name (CN).

  • Use the Mailbox parameter to specify the mailbox that contains the subscription, and then specify the name of the subscription.

You can find the identifying values for a POP subscription, such as Identity and Name, by running this command: Get-PopSubscription -Mailbox <mailbox>.

Confirm

Optional

System.Management.Automation.SwitchParameter

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

DisableAsPoison

Optional

System.Management.Automation.SwitchParameter

This parameter is reserved for internal Microsoft use.

DisplayName

Optional

System.String

The DisplayName parameter specifies the friendly name of the subscription.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

This parameter is reserved for internal Microsoft use.

EmailAddress

Optional

Microsoft.Exchange.Data.SmtpAddress

The EmailAddress parameter specifies the email address of the POP mailbox.

Enabled

Optional

System.Boolean

The Enabled parameter specifies whether the POP subscription is enabled. This parameter accepts $true or $false values. The default value is $true.

EnablePoisonSubscription

Optional

System.Management.Automation.SwitchParameter

This parameter is reserved for internal Microsoft use.

Force

Optional

System.Management.Automation.SwitchParameter

The Force parameter instructs the command to modify the specified subscription settings even if those settings can't be verified by the remote POP server.

IncomingAuth

Optional

Microsoft.Exchange.Transport.Sync.Common.Subscription.Pop.AuthenticationMechanism

The IncomingAuth parameter sets the authentication method used by POP clients to access the POP server. Valid values are Basic or Spa, which is secure password authentication. If you don't specify a value for the IncomingAuth parameter, the value Basic is used.

IncomingPassword

Optional

System.Security.SecureString

The IncomingPassword parameter specifies the password used to sign in to the POP mailbox. You must specify the value for this parameter in a secure format, for example, (ConvertTo-SecureString -String '<password>' -AsPlainText -Force).

IncomingPort

Optional

System.Int32

The Incoming Port parameter specifies the TCP port number used by POP clients to connect to the POP server. Typical values are 110 for unencrypted connections and 995 for encrypted connections. By default, the value of the IncomingPort parameter is set to 110 if you don't set the IncomingSecurity parameter to Ssl or Tls. If you set the IncomingSecurity parameter to Ssl or Tls, the value of the IncomingPort parameter is set to 995. You can override the default values by specifying an integer for the IncomingPort parameter.

IncomingSecurity

Optional

Microsoft.Exchange.Transport.Sync.Common.Subscription.Pop.SecurityMechanism

The IncomingSecurity parameter specifies the encryption method used by POP clients to connect to the POP server. Valid values are None, Ssl, or Tls. If you don't specify a value for the IncomingSecurity parameter, the value None is used.

IncomingServer

Optional

Microsoft.Exchange.Data.Fqdn

The IncomingServer parameter specifies the fully qualified domain name (FQDN) of the POP server, for example, incoming.contoso.com.

IncomingUserName

Optional

System.String

The IncomingUserName parameter specifies the user name used to sign in to the POP mailbox.

LeaveOnServer

Optional

System.Boolean

The LeaveOnServer parameter configures the behavior of retrieved messages in the POP mailbox. When the LeaveOnServer parameter is set to the value $true, the retrieved messages are left in the POP mailbox. When it's set to the value $false, retrieved messages are removed from the POP mailbox. The default value is $true.

Mailbox

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter

The Mailbox parameter specifies the cloud-based mailbox that contains the POP subscription. You can use any value that uniquely identifies the mailbox.

For example:

  • Alias

  • Distinguished name (DN)

  • GUID

  • Name

  • Display name

  • LegacyExchangeDN

  • Email address

ResendVerification

Optional

System.Management.Automation.SwitchParameter

The ResendVerification parameter generates verification data for the POP subscription. This is part of the verification process that allows the user to send messages from their cloud-based mailbox using the From address of the subscribed POP mailbox.

The ResendVerification parameter can't be specified with any other parameters that modify the settings of the subscription. Also, the ResendVerification and ValidateSecret parameters are mutually exclusive.

ValidateSecret

Optional

System.String

The ValidateSecret parameter validates verification data for the POP subscription. This is part of the verification process that allows the user to send messages from their cloud-based mailbox using the From address of the subscribed POP mailbox.

The ValidateSecret parameter can't be specified with any other parameters that modify the settings of the subscription. Also, the ResendVerification and ValidateSecret parameters are mutually exclusive.

WhatIf

Optional

System.Management.Automation.SwitchParameter

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

 
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.