Was this page helpful?
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All



Applies to: Exchange Online

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

The New-Subscription cmdlet allows a user to create Hotmail, POP, or IMAP 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-Subscription -EmailAddress <SmtpAddress> -Name <String> -Password <SecureString> [-Confirm [<SwitchParameter>]] [-DisplayName <String>] [-Force <SwitchParameter>] [-Hotmail <SwitchParameter>] [-Imap <SwitchParameter>] [-Mailbox <MailboxIdParameter>] [-Pop <SwitchParameter>] [-WhatIf [<SwitchParameter>]]

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

  • Email address: brian@contoso.com

  • Password: Pa$$word1

New-Subscription -Name Contoso -EmailAddress brian@contoso.com -Password (ConvertTo-SecureString -String 'Pa$$word1' -AsPlainText -Force)

The New-Subscription cmdlet creates a connection between a user's cloud-based mailbox and a remote Hotmail, POP, or IMAP mailbox. The cloud-based mailbox periodically polls the remote mailbox for new messages. If you don't specify the type of remote mailbox, the cmdlet automatically tries to configure the subscription by using all of the available subscription types.

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




The EmailAddress parameter specifies the email address of the subscription.




The Name parameter specifies the name of the 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.




The Password parameter specifies the password used to sign in to the mailbox.

This parameter uses the syntax (ConvertTo-SecureString -String '<password>' -AsPlainText -Force). Or, to be prompted to enter the password and store it as a variable, run the command $password = Read-Host "Enter password" -AsSecureString, and then use the value $password for this parameter.




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.




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




The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch.




The Hotmail switch specifies the subscription is a Hotmail subscription. You don't need to specify a value with this switch.




The Imap switch specifies the subscription is an IMAP subscription. You don't need to specify a value with this switch.




The Mailbox parameter specifies the cloud-based mailbox that contains the subscription. 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)




The Pop switch specifies the subscription is a POP subscription. You don't need to specify a value with this switch.




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.

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