Table of Contents

Method Create

Namespace
MailFathom.Application.SensitiveContent
Assembly
MailFathom.Application.dll

Create(SensitiveContentScannerKind, IReadOnlyList<SensitiveContentCategory>, IReadOnlyList<SensitiveContentRule>)

Composes the plan for one scanner.

public static SensitiveContentScannerPlan Create(SensitiveContentScannerKind scanner, IReadOnlyList<SensitiveContentCategory> categories, IReadOnlyList<SensitiveContentRule> suppressedRules)

Parameters

scanner SensitiveContentScannerKind

Which of the two switches the plan belongs to.

categories IReadOnlyList<SensitiveContentCategory>

The categories the scanner looks for.

suppressedRules IReadOnlyList<SensitiveContentRule>

The rules that stay silent inside those categories.

Returns

SensitiveContentScannerPlan

The validated plan.

Remarks

A plan naming no category is refused rather than accepted as a scanner that finds nothing, because that is indistinguishable at run time from a scanner that is working and would leave an operator reading a switch that is on as protection that is in force.

Exceptions

ArgumentNullException

Thrown when an argument is null.

ArgumentException

Thrown when no category is named, a category is named twice, or a suppression falls outside the named categories.