Export (0) Print
Expand All

New-PopSubscription

Exchange Online
 

Applies to: Exchange Online

Topic Last Modified: 2013-09-23

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

The New-PopSubscription cmdlet allows a user to create POP subscriptions in their own cloud-based mailbox. An administrator can't use this cmdlet to create subscriptions in another user's mailbox.

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

New-PopSubscription -EmailAddress <SmtpAddress> -IncomingPassword <SecureString> -IncomingServer <Fqdn> -IncomingUserName <String> -Name <String> [-Confirm [<SwitchParameter>]] [-DisplayName <String>] [-DomainController <Fqdn>] [-Force <SwitchParameter>] [-IncomingAuth <Basic | Spa>] [-IncomingPort <Int32>] [-IncomingSecurity <None | Ssl | Tls>] [-LeaveOnServer <$true | $false>] [-Mailbox <MailboxIdParameter>] [-WhatIf [<SwitchParameter>]]

This example creates the POP subscription Contoso POP in the mailbox of the user Brian Johnson. The remote POP mailbox has the following details:

  • Email address: bjohnson@contoso.com

  • User name: bjohnson

  • Password: Pa$$word1

  • POP server: pop.contoso.com

  • Authentication method: SSL

  • TCP port: 995

New-PopSubscription -Name "Contoso POP" -EmailAddress bjohnson@contoso.com -IncomingUserName bjohnson -IncomingPassword (ConvertTo-SecureString -String 'Pa$$word1' -AsPlainText -Force) -IncomingServer pop.contoso.com  -IncomingSecurity Ssl -IncomingPort 995

The New-PopSubscription cmdlet creates a connection between a user's cloud-based mailbox and a remote POP mailbox. The cloud-based mailbox periodically polls the POP mailbox for new messages.

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

EmailAddress

Required

Microsoft.Exchange.Data.SmtpAddress

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

IncomingPassword

Required

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).

IncomingServer

Required

Microsoft.Exchange.Data.Fqdn

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

IncomingUserName

Required

System.String

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

Name

Required

System.String

The Name parameter specifies the name of the POP subscription. The name of the subscription doesn't have to be globally unique. The name must be unique compared to other subscriptions that exist in the same 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.

DisplayName

Optional

System.String

The DisplayName parameter specifies the friendly name of the POP subscription. If you don't specify a value for the DisplayName parameter, the value of the EmailAddress parameter is used.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

This parameter is reserved for internal Microsoft use.

Force

Optional

System.Management.Automation.SwitchParameter

The Force parameter instructs the command to create the subscription 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.

IncomingPort

Optional

System.Int32

The IncomingPort 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.

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

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.

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft