Cmdlets for Microsoft Exchange

Build 25.0.9434

DirectoryRetrievalDepth Parameter (Connect-Exchange Cmdlet)

Specifies the folder depth to use when retrieving items and subfolders from the directory.

Syntax

Connect-Exchange -DirectoryRetrievalDepth string

Data Type

cstr

Default Value

"5"

Remarks

This property controls how many levels deep the cmdlet queries when retrieving folders and items from the directory hierarchy.

Set this property to a numeric value representing the desired depth. For example, a value of 1 retrieves only top-level folders, while higher values allow deeper traversal into subfolders.

If not explicitly set, the cmdlet defaults to a depth of 5.

This property is useful for controlling the scope of folder discovery, especially when working with deeply nested folder structures or when performance is a concern.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9434