Domain Detective

API Reference

Class

DmarcReportParser

Namespace DomainDetective
Assembly DomainDetective
Modifiers static

Parses DMARC feedback reports from various formats.

Inheritance

  • Object
  • DmarcReportParser

Methods

Parse 3 overloads
public static DmarcAggregateReport Parse(String path, IList<String> validationMessages = null) #
Returns: DmarcAggregateReport

Parses a DMARC feedback report from the specified path.

Parameters

path System.String requiredposition: 0
Path to a .xml, .gz, or .zip report.
validationMessages System.Collections.Generic.IList{System.String} = null optionalposition: 1
Optional list collecting schema validation errors.

Returns

The parsed aggregate report.

public static DmarcAggregateReport Parse(Stream stream, String name = null, IList<String> validationMessages = null) #
Returns: DmarcAggregateReport

Parses a DMARC feedback report from a stream.

Parameters

stream System.IO.Stream requiredposition: 0
Input stream containing the report data.
name System.String = null optionalposition: 1
Optional name used to determine the format (.xml, .gz, .zip).
validationMessages System.Collections.Generic.IList{System.String} = null optionalposition: 2
Optional list collecting schema validation errors.

Returns

The parsed aggregate report.

public static DmarcAggregateReport Parse(Stream stream, String name, IList<String> validationMessages, Int64 maxUncompressedBytes) #
Returns: DmarcAggregateReport

Parses a DMARC feedback report from a stream with size limits.

Parameters

stream System.IO.Stream requiredposition: 0
Input stream containing the report data.
name System.String requiredposition: 1
Optional name used to determine the format (.xml, .gz, .zip).
validationMessages System.Collections.Generic.IList{System.String} requiredposition: 2
Optional list collecting schema validation errors.
maxUncompressedBytes System.Int64 requiredposition: 3
Maximum uncompressed size to read (0 means unlimited).

Returns

The parsed aggregate report.

public static IEnumerable<DmarcAggregateRecord> ParseMultiple(IEnumerable<String> paths) #
Returns: IEnumerable<DmarcAggregateRecord>

Parses multiple DMARC reports and returns individual records.

Parameters

paths System.Collections.Generic.IEnumerable{System.String} requiredposition: 0
Paths to report files.
{{ include "footer" }}