TechNet
Export (0) Print
Expand All

Get-ImapSubscription

 

Applies to: Exchange Online

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

Use the Get-ImapSubscription cmdlet to view information about IMAP subscriptions configured in cloud-based mailboxes.

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

Get-ImapSubscription [-Identity <AggregationSubscriptionIdParameter>] [-IncludeReport <SwitchParameter>] [-Mailbox <MailboxIdParameter>] [-AggregationType <Aggregation | Mirrored | Migration | PeopleConnection | All>] [-Confirm [<SwitchParameter>]] [-ResultSize <Unlimited>] [-WhatIf [<SwitchParameter>]]

This example shows detailed information for all the IMAP subscriptions configured in the mailbox of the user Kim Akers.

Get-ImapSubscription -Mailbox "Kim Akers" | Format-List

This example returns additional information about the IMAP subscriptions configured in the mailbox of the user Kim Akers.

Get-ImapSubscription -Mailbox "Kim Akers" -IncludeReport | Export-CSV C:\KimAkersImapReport

You can view the properties of the IMAP subscription, such as the IMAP server, authentication method, connection status, and the last time a successful synchronization occurred.

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

AggregationType

Optional

Microsoft.Exchange.Transport.Sync.Common.Subscription.Pim.AggregationType

The AggregationType parameter filters the results by type. The acceptable values for this parameter are:

  • All

  • Aggregation

  • Migration

  • Mirrored

  • PeopleConnection

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.

Identity

Optional

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

IncludeReport

Optional

System.Management.Automation.SwitchParameter

The IncludeReport switch specifies whether to return additional details, which can be used for troubleshooting.

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)

ResultSize

Optional

Microsoft.Exchange.Data.Unlimited

The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000.

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