Click or drag to resize
MimeKit

MetadataOptionsDepth Property

Get or set the depth.

Namespace: MailKit
Assembly: MailKit (in MailKit.dll) Version: 4.7.1
Syntax
C#
Copy
public int Depth { get; set; }

Property Value

Int32
The depth.
Exceptions
ExceptionCondition
ArgumentOutOfRangeExceptionvalue is out of range.
Remarks

When the Depth option is specified, it extends the list of metadata tag values returned by the GetMetadata() call. For each MetadataTag specified in the the GetMetadata() call, the method returns the value of the specified metadata tag (if it exists), plus all metadata tags below the specified entry up to the specified depth.

Three values are allowed for Depth:

0 - no entries below the specified metadata tag are returned.

1 - only entries immediately below the specified metadata tag are returned.

MaxValue - all entries below the specified metadata tag are returned.

Thus, a depth of 1 for a tag entry of "/a" will match "/a" as well as its children entries (e.g., "/a/b"), but will not match grandchildren entries (e.g., "/a/b/c").

If the Depth option is not specified, this is the same as specifying 0.

See Also