TechNet
Export (0) Print
Expand All

Set-ImapSubscription

 

Applies to: Exchange Online

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

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

Set-ImapSubscription -Identity <AggregationSubscriptionIdParameter> [-Mailbox <MailboxIdParameter>] <COMMON PARAMETERS>

Set-ImapSubscription -Identity <AggregationSubscriptionIdParameter> [-DisplayName <String>] [-EmailAddress <SmtpAddress>] [-Enabled <$true | $false>] [-Force <SwitchParameter>] [-IncomingAuth <Basic | Ntlm>] [-IncomingPassword <SecureString>] [-IncomingPort <Int32>] [-IncomingSecurity <None | Ssl | Tls>] [-IncomingServer <Fqdn>] [-IncomingUserName <String>] [-Mailbox <MailboxIdParameter>] <COMMON PARAMETERS>

Set-ImapSubscription -Identity <AggregationSubscriptionIdParameter> [-Mailbox <MailboxIdParameter>] [-ValidateSecret <String>] <COMMON PARAMETERS>

Set-ImapSubscription -Identity <AggregationSubscriptionIdParameter> [-Mailbox <MailboxIdParameter>] [-ResendVerification <SwitchParameter>] <COMMON PARAMETERS>

Set-ImapSubscription -Identity <AggregationSubscriptionIdParameter> [-Mailbox <MailboxIdParameter>] <COMMON PARAMETERS>

COMMON PARAMETERS: [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]]

This example modifies the display name of the IMAP subscription Fabrikam IMAP that's configured in the cloud-based mailbox of the user Kim Akers.

Set-ImapSubscription "Fabrikam IMAP" -Mailbox "Kim Akers" -DisplayName "Kim's Fabrikam Mail"

This example changes the IMAP server value to imap.contoso.com for the IMAP subscription Brian Contoso Mail that's configured in the cloud-based mailbox of the user Brian Johnson".

Set-ImapSubscription "Brian Contoso Mail" -Mailbox "Brian Johnson" -IncomingServer imap.contoso.com -Force

You can set properties for the IMAP subscription, such as the IMAP 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 IMAP 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 an IMAP subscription, such as Identity and Name, by running this command: Get-ImapSubscription -Mailbox <mailbox>.

Confirm

Optional

System.Management.Automation.SwitchParameter

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.

DisplayName

Optional

System.String

The DisplayName parameter specifies the friendly name of the subscription.

EmailAddress

Optional

Microsoft.Exchange.Data.SmtpAddress

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

Enabled

Optional

System.Boolean

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

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 IMAP server.

IncomingAuth

Optional

Microsoft.Exchange.Data.IMAPAuthenticationMechanism

The IncomingAuth parameter sets the authentication method used by IMAP clients to access the IMAP server. The values are Basic or Ntlm. The default value is Basic.

IncomingPassword

Optional

System.Security.SecureString

The IncomingPassword parameter specifies the password used to sign in to the IMAP 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 IncomingPort parameter specifies the TCP port number used by IMAP clients to connect to the IMAP server. Typical values are 143 for unencrypted connections and 993 for encrypted connections. By default, the value of the IncomingPort parameter is set to 143 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 993. You can override the default values by specifying an integer for the IncomingPort parameter.

IncomingSecurity

Optional

Microsoft.Exchange.Data.IMAPSecurityMechanism

The IncomingSecurity parameter specifies the encryption method used by IMAP clients to connect to the IMAP server. The values are None, Ssl, or Tls. The default value is None.

IncomingServer

Optional

Microsoft.Exchange.Data.Fqdn

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

IncomingUserName

Optional

System.String

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

Mailbox

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter

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

ResendVerification

Optional

System.Management.Automation.SwitchParameter

The ResendVerification parameter generates verification data for the IMAP subscription. This test 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 IMAP 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 IMAP subscription. This test 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 IMAP 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 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.

 
Show:
© 2016 Microsoft