.png)
Get-ImapSubscription
Applies to: Exchange Online
Topic Last Modified: 2012-09-18
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 Syntax.
Get-ImapSubscription [-Identity <AggregationSubscriptionIdParameter>] [-IncludeReport <SwitchParameter>] [-Mailbox <MailboxIdParameter>] [-AggregationType <Aggregation | Mirrored | Migration | PeopleConnection | All>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-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:
|
| 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. |
| DomainController | Optional | Microsoft.Exchange.Data.Fqdn | This parameter is reserved for internal Microsoft use. |
| 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:
You can find the identifying values for an IMAP subscription, such as Identity and Name, by running this command: |
| 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:
|
| ResultSize | Optional | Microsoft.Exchange.Data.Unlimited | The ResultSize parameter specifies the total number of subscriptions to return. If no value is specified, the parameter returns all results that match the filter. |
| 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.
