.png)
New-Subscription
Applies to: Exchange Online
Topic Last Modified: 2012-09-17
This cmdlet is available only in the cloud-based service.
Use the New-Subscription cmdlet to add a Hotmail, POP, or IMAP subscription to a user's cloud-based 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>] [-DomainController <Fqdn>] [-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 -Mailbox "Brian Johnson" -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 |
|---|---|---|---|
| EmailAddress | Required | Microsoft.Exchange.Data.SmtpAddress | The EmailAddress parameter specifies the email address of the IMAP mailbox. |
| Name | Required | System.String | 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. |
| Password | Required | System.Security.SecureString | The Password parameter specifies the password used to sign in to the mailbox. You must specify the value for this parameter in a secure format, for example, |
| 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 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 server. |
| Hotmail | Optional | System.Management.Automation.SwitchParameter | The Hotmail parameter tries to configure the subscription settings for a Hotmail mailbox. |
| Imap | Optional | System.Management.Automation.SwitchParameter | The Imap parameter tries to configure the subscription settings for an IMAP mailbox. |
| Mailbox | Optional | Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter | The Mailbox parameter specifies the cloud-based mailbox that contains the subscription. You can use any value that uniquely identifies the mailbox. For example:
|
| Pop | Optional | System.Management.Automation.SwitchParameter | The Pop parameter tries to configure the subscription settings for a POP mailbox. |
| 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.
