YEncHeader Constructor

Initialize the metadata for a single-part or multipart yEnc block.

Definition

Namespace: MimeKit.Encodings
Assembly: MimeKit.Core (in MimeKit.Core.dll) Version: 5.0.0
C#
public YEncHeader(
	string fileName,
	long size,
	int lineLength = 128,
	int partNumber = 0,
	int totalParts = 0,
	long begin = 0,
	long end = 0
)

Parameters

fileName  String
The filename, treated as metadata, never as a filesystem path.
size  Int64
The entire file's decoded size.
lineLength  Int32  (Optional)
The nominal payload line length. Writers support 60 through 998.
partNumber  Int32  (Optional)
The part number, or zero for a single-part file.
totalParts  Int32  (Optional)
The total part count, or zero if unspecified.
begin  Int64  (Optional)
The one-based, inclusive start of a multipart range.
end  Int64  (Optional)
The one-based, inclusive end of a multipart range.

Remarks

For a single-part file, leave all part and range arguments at zero.

Exceptions

ArgumentNullException fileName is .
ArgumentException The filename is empty, has leading or trailing spaces, or contains NUL, CR or LF.
ArgumentOutOfRangeException A size, line length, part number or range is invalid or inconsistent.

See Also