Get-CASMailbox
Cette cmdlet est disponible dans Exchange sur site et dans le service cloud. Certains paramètres et paramètres peuvent être exclusifs à un environnement ou à l’autre.
Utilisez l’applet de commande Get-CASMailbox pour afficher les paramètres d’accès au client configurés sur les boîtes aux lettres.
Remarque : Dans Exchange Online PowerShell, nous vous recommandons d’utiliser l’applet de commande Get-EXOCASMailbox au lieu de cette applet de commande. Pour plus d’informations, reportez-vous à Connexion à Exchange Online.
Pour plus d’informations sur les jeux de paramètres dans la section Syntaxe ci-après, voir Syntaxe da la cmdlet Exchange.
Syntaxe
AnrSet
Get-CASMailbox
[-Anr <String>]
[-ActiveSyncDebugLogging]
[-ActiveSyncSuppressReadReceipt]
[-Credential <PSCredential>]
[-DomainController <Fqdn>]
[-Filter <String>]
[-IgnoreDefaultScope]
[-Monitoring]
[-OrganizationalUnit <OrganizationalUnitIdParameter>]
[-ProtocolSettings]
[-ReadFromDomainController]
[-ResultSize <Unlimited>]
[-SortBy <String>]
[-ReadIsOptimizedForAccessibility]
[-RecalculateHasActiveSyncDevicePartnership]
[-RecipientTypeDetails <RecipientTypeDetails[]>]
[<CommonParameters>]
Identity
Get-CASMailbox
[[-Identity] <MailboxIdParameter>]
[-ActiveSyncDebugLogging]
[-ActiveSyncSuppressReadReceipt]
[-Credential <PSCredential>]
[-DomainController <Fqdn>]
[-Filter <String>]
[-IgnoreDefaultScope]
[-Monitoring]
[-OrganizationalUnit <OrganizationalUnitIdParameter>]
[-ProtocolSettings]
[-ReadFromDomainController]
[-ResultSize <Unlimited>]
[-SortBy <String>]
[-ReadIsOptimizedForAccessibility]
[-RecalculateHasActiveSyncDevicePartnership]
[-RecipientTypeDetails <RecipientTypeDetails[]>]
[<CommonParameters>]
Description
Cette cmdlet renvoie divers paramètres d’accès client pour une ou plusieurs boîtes aux lettres. Ces paramètres incluent des options pour Outlook sur le web, Exchange ActiveSync, POP3 et IMAP4.
Des autorisations doivent vous être attribuées avant de pouvoir exécuter cette cmdlet. Bien que cet article répertorie tous les paramètres de l’applet de commande, il se peut que vous n’ayez pas accès à certains paramètres s’ils ne sont pas inclus dans les autorisations qui vous sont attribuées. Pour rechercher les autorisations requises pour exécuter une cmdlet ou un paramètre dans votre organisation, voir Find the permissions required to run any Exchange cmdlet.
Exemples
Exemple 1
Get-CASMailbox "Jeff Hay"
Cet exemple renvoie les valeurs des paramètres d’accès client suivants pour l’utilisateur nommé Jeff Hay.
- ActiveSyncEnabled
- OWAEnabled
- PopEnabled
- ImapEnabled
- MapiEnabled
Exemple 2
Get-CASMailbox tony@contoso.com | Format-List Imap*
Cet exemple retourne tous les paramètres IMAP4 de l’utilisateur tony@contoso.com.
Exemple 3
Get-CASMailbox chris@contoso.com | Format-List Ews*
Cet exemple retourne tous les paramètres des services Web Exchange pour l’utilisateur chris@contoso.com.
Exemple 4
Get-CASMailbox -RecipientTypeDetails SharedMailbox | Select *
Dans Exchange Online, cet exemple filtre la sortie de l’applet de commande pour inclure uniquement les boîtes aux lettres partagées.
Paramètres
-ActiveSyncDebugLogging
Applicable : Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
Le commutateur ActiveSyncDebugLogging indique la valeur réelle de la propriété ActiveSyncDebugLogging de la boîte aux lettres. Il n’est pas nécessaire de spécifier une valeur pour ce commutateur.
Si vous n’utilisez pas ce commutateur, la valeur apparaît toujours sous la forme $false.
Pour afficher cette valeur, vous devez utiliser une cmdlet de mise en forme. Par exemple : Get-CasMailbox laura@contoso.com -ActiveSyncDebugLogging | Format-List.
Propriétés du paramètre
| Type: | SwitchParameter |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-ActiveSyncSuppressReadReceipt
Applicable : Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
Ce paramètre est réservé à l’usage interne chez Microsoft.
Propriétés du paramètre
| Type: | SwitchParameter |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-Anr
Applicable : Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
Le paramètre Anr spécifie une chaîne sur laquelle une recherche de résolution de noms ANR (Ambiguous Name Resolution) peut porter. Vous pouvez spécifier une chaîne partielle et rechercher des objets ayant un attribut correspondant à cette chaîne. Les attributs par défaut recherchés sont :
- CommonName (CN)
- DisplayName
- FirstName
- LastName
- Alias
Propriétés du paramètre
| Type: | String |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
AnrSet
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-Credential
Applicable : Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
Le paramètre Credential spécifie le nom d’utilisateur et le mot de passe utilisés pour exécuter cette commande. En règle générale, vous utilisez ce paramètre dans des scripts ou lorsque vous avez besoin de fournir différentes informations d’identification qui ont les autorisations requises.
Ce paramètre requiert la création et la transmission d’un objet d’informations d’identification. Cet objet d’informations d’identification est créé à l’aide de la cmdlet Get-Credential. Pour plus d’informations, voir Get-Credential.
Propriétés du paramètre
| Type: | PSCredential |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-DomainController
Applicable : Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE
Ce paramètre est disponible uniquement dans Exchange sur site.
Le paramètre DomainController spécifie le contrôleur de domaine qui est utilisé par cette cmdlet pour lire ou écrire les données dans Active Directory. Vous identifiez le contrôleur de domaine par son nom de domaine complet (FQDN). Par exemple : « dc01.contoso.com ».
Propriétés du paramètre
| Type: | Fqdn |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-Filter
Applicable : Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
Le paramètre Filter utilise la syntaxe OPATH pour filtrer les résultats en fonction des propriétés et valeurs spécifiées. Les critères de recherche utilisent la syntaxe "Property -ComparisonOperator 'Value'".
- Placez l’ensemble du filtre OPATH entre guillemets doubles « ». Si le filtre contient des valeurs système (par exemple,
$true,$falseou$null), utilisez plutôt des guillemets simples « ». Bien que ce paramètre soit une chaîne (et non un bloc système), vous pouvez également utiliser des accolades { }, mais uniquement si le filtre ne contient pas de variables. - Property est une propriété filtrable. Pour plus d’informations sur les propriétés filtrables, consultez Propriétés filtrables pour le paramètre Filter.
- ComparisonOperator est un opérateur de comparaison OPATH (par exemple
-eq, pour des valeurs égales et-likepour la comparaison de chaînes). Pour plus d'informations sur les opérateurs de comparaison, reportez-vous à la rubrique about_Comparison_Operators. - Value est la valeur de propriété à rechercher. Placez les valeurs de texte et les variables entre guillemets simples (
'Value'ou'$Variable'). Si une valeur de variable contient des guillemets simples, vous devez identifier (échappement) les guillemets simples pour développer la variable correctement. Par exemple, au lieu de'$User', utilisez'$($User -Replace "'","''")'. Ne placez pas entre guillemets les entiers ou les valeurs système (par exemple, utilisez500,$true,$falseou$nullà la place).
Vous pouvez chaîner plusieurs critères de recherche à l’aide des opérateurs logiques -and et -or. Par exemple : "Criteria1 -and Criteria2" ou "(Criteria1 -and Criteria2) -or Criteria3".
Pour plus d’informations sur les filtres OPATH dans Exchange, consultez Informations supplémentaires sur la syntaxe OPATH.
Propriétés du paramètre
| Type: | String |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-Identity
Applicable : Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
Le paramètre Identity spécifie la boîte aux lettres que vous voulez afficher. Vous pouvez utiliser n’importe quelle valeur qui identifie la boîte aux lettres de manière unique. Par exemple :
- Nom
- Alias
- Nom unique
- Nom unique
- Domaine\Nom d’utilisateur
- Adresse e-mail
- GUID
- LegacyExchangeDN
- SamAccountName
- Identifiant utilisateur ou nom d’utilisateur principal (UPN)
Propriétés du paramètre
| Type: | MailboxIdParameter |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
Identity
| Position: | 1 |
| Obligatoire: | False |
| Valeur du pipeline: | True |
| Valeur du pipeline par nom de propriété: | True |
| Valeur des arguments restants: | False |
-IgnoreDefaultScope
Applicable : Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
Le commutateur IgnoreDefaultScope indique à la commande d’ignorer le paramètre d’étendue du destinataire par défaut pour la session Exchange PowerShell et d’utiliser la forêt entière comme étendue. Il n’est pas nécessaire de spécifier une valeur pour ce commutateur.
Ce commutateur permet à la commande d’accéder aux objets Active Directory qui ne sont pas actuellement disponibles dans l’étendue par défaut, mais introduit également les restrictions suivantes :
- Vous ne pouvez pas utiliser le paramètre DomainController. La commande utilise automatiquement un serveur de catalogue global approprié.
- Vous ne pouvez pas utiliser le paramètre DomainController. La commande utilise automatiquement un serveur de catalogue global approprié.
Propriétés du paramètre
| Type: | SwitchParameter |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-Monitoring
Applicable : Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE
Ce paramètre est disponible uniquement dans Exchange sur site.
Le commutateur Surveillance est nécessaire pour retourner des boîtes aux lettres de surveillance dans les résultats. Il n’est pas nécessaire de spécifier une valeur pour ce commutateur.
Les boîtes aux lettres de surveillance sont associées à la disponibilité managée et au service Exchange Health Manager, et ont une valeur de propriété RecipientTypeDetails de MonitoringMailbox.
Propriétés du paramètre
| Type: | SwitchParameter |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-OrganizationalUnit
Applicable : Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
Le paramètre OrganizationalUnit filtre les résultats en fonction de l’emplacement de l’objet dans Active Directory. Seuls les objets qui existent dans l’emplacement spécifié sont renvoyés. L’entrée valide pour ce paramètre est une unité d’organisation (UO) ou un domaine retourné par l’applet de commande Get-OrganizationalUnit. Vous pouvez utiliser n’importe quelle valeur qui identifie de façon unique l’unité d’organisation ou le domaine. Par exemple :
- Nom
- Nom
- Nom unique
- GUID
Propriétés du paramètre
| Type: | OrganizationalUnitIdParameter |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-ProtocolSettings
Applicable : Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
Le commutateur ProtocolSettings renvoie les noms de serveur, les ports TCP et les méthodes de chiffrement pour les paramètres suivants :
- ExternalImapSettings
- InternalImapSettings
- ExternalPopSettings
- InternalPopSettings
- ExternalSmtpSettings
- InternalSmtpSettings
Il n’est pas nécessaire de spécifier une valeur pour ce commutateur.
Pour afficher ces valeurs, vous devez utiliser une cmdlet de mise en forme. Par exemple : Get-CasMailbox laura@contoso.com -ProtocolSettings | Format-List.
Propriétés du paramètre
| Type: | SwitchParameter |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-ReadFromDomainController
Applicable : Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE
Ce paramètre est disponible uniquement dans Exchange sur site.
Le commutateur ReadFromDomainController spécifie quelles informations doivent être lues à partir d’un contrôleur de domaine dans le domaine de l’utilisateur. Il n’est pas nécessaire de spécifier une valeur pour ce commutateur.
La commande : Set-AdServerSettings -ViewEntireForest $true pour inclure tous les objets dans la forêt, nécessite le commutateur ReadFromDomainController. Sinon, la commande peut utiliser un catalogue global qui contient des informations obsolètes. En outre, vous devrez peut-être exécuter plusieurs itérations de la commande avec le commutateur ReadFromDomainController pour obtenir les informations.
Par défaut, l’étendue du destinataire est définie sur le domaine qui héberge vos serveurs Exchange.
Propriétés du paramètre
| Type: | SwitchParameter |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-ReadIsOptimizedForAccessibility
Applicable : Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
Le commutateur ReadIsOptimizedForAccessibility spécifie s’il faut lire la valeur de la propriété IsOptimizedForAccessibility sur la boîte aux lettres (si la boîte aux lettres est configurée pour utiliser la version légère de Outlook sur le web). Il n’est pas nécessaire de spécifier une valeur pour ce commutateur.
Propriétés du paramètre
| Type: | SwitchParameter |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-RecalculateHasActiveSyncDevicePartnership
Applicable : Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
Le commutateur RecalculateHasActiveSyncDevicePartnership recalcule la valeur de la propriété HasActiveSyncDevicePartnership de la boîte aux lettres. Il n’est pas nécessaire de spécifier une valeur pour ce commutateur.
La valeur est automatiquement mise à jour si elle est jugée incorrecte.
Propriétés du paramètre
| Type: | SwitchParameter |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-RecipientTypeDetails
Applicable : Exchange Online, Exchange Online Protection
Ce paramètre est disponible uniquement dans le service basé sur le cloud.
Le paramètre RecipientTypeDetails filtre les résultats en fonction du sous-type de destinataire spécifié. Les valeurs valides sont les suivantes :
- DiscoveryMailbox
- ÉquipementMailbox
- LegacyMailbox
- LinkedMailbox
- LinkedRoomMailbox
- MailUser
- RoomMailbox
- SharedMailbox
- TeamMailbox
- UserMailbox
Vous pouvez spécifier plusieurs valeurs séparées par des virgules.
Propriétés du paramètre
| Type: | RecipientTypeDetails[] |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-ResultSize
Applicable : Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
Le paramètre ResultSize spécifie le nombre maximal de résultats à renvoyer. Pour retourner toutes les demandes correspondant à la requête, utilisez unlimited comme valeur pour ce paramètre. La valeur par défaut est 1000.
Propriétés du paramètre
| Type: | Unlimited |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-SortBy
Applicable : Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
Le paramètre SortBy spécifie la propriété utilisée pour trier les résultats. Vous ne pouvez trier que sur une propriété à la fois. Les résultats sont triés selon un ordre croissant.
Si l’affichage par défaut n’inclut pas la propriété que vous triez, vous pouvez ajouter la commande avec | Format-Table -Auto Property1,Property2,...PropertyX. pour créer une vue qui contient toutes les propriétés que vous souhaitez voir. Les caractères génériques (*) sont pris en charge dans les noms de propriété.
Vous pouvez filtrer selon les propriétés suivantes :
- Nom
- DisplayName
- ServerLegacyDN
Propriétés du paramètre
| Type: | String |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
CommonParameters
Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters.
Entrées
Input types
Pour visualiser les types d'entrées acceptés par cette cmdlet, consultez la rubrique Types d'entrée et de sortie de la cmdlet d'Exchange Management Shell. Si le champ Type d'entrée pour une cmdlet est vide, la cmdlet n'accepte pas les données d'entrée.
Sorties
Output types
Pour visualiser les types de retours, également appelés types de sorties, acceptés par cette cmdlet, consultez la rubrique Types d'entrée et de sortie de la cmdlet d'Exchange Management Shell. Si le champ Type de sortie est vide, la cmdlet ne renvoie pas de données.