DataStandardizer.File.InternetMessage API reference

The public types of DataStandardizer.File.InternetMessage. All types are in the DataStandardizer.File.InternetMessage namespace.

Every type is available on netstandard1.1, netstandard2.0, netstandard2.1, and net10.0. Each page’s Applies to section names the members that some targets don’t have.

Classes

Type Description
EmlxEntry The content of an EMLX file: one message and its metadata.
EmlxMetadata The metadata of an EMLX file, from the XML property list that ends it.
EmlxMissingPart A part that a partial EMLX file stores in another file: an entity with an X-Apple-Content-Length field and an empty body.
EmlxPlistValue A value in an XML property list. It can’t be changed once made.
EmlxReader Represents a reader of an Apple Mail EMLX file (.emlx, .partial.emlx) into an EmlxEntry: one message, with a byte count before it and a property list of metadata after it.
EmlxWriter Represents a writer of an Apple Mail EMLX file from an EmlxEntry: the byte count, the message and the property list of metadata.
ImfAddress An address (RFC 5322 §3.4): an ImfMailbox or an ImfGroup.
ImfAddressList An ordered, read-only list of addresses (RFC 5322 §3.4), with at least one.
ImfContentDisposition The value of a Content-Disposition header field (RFC 2183), such as attachment; filename=genome.jpeg.
ImfDiagnostic A problem in a message that does not stop it being read.
ImfEntity A MIME entity (RFC 2045 §2.4): an ordered list of header fields, with typed accessors over them, and a body. An ImfMultipart holds other entities, an ImfMessagePart holds a message, and any other entity holds content.
ImfEntityCollection The parts of an ImfMultipart, in order.
ImfEntityNode An entity that ImfMessage.EnumerateEntities found, with where it is in the message.
ImfEntityReader Represents a reader that provides fast, non-cached, forward-only access to a whole Internet message as a stream of events: entity start, header field, header end, body chunk and entity end. It follows RFC 2046 §5 into multipart and embedded message entities, and never holds a whole body in memory.
ImfEntitySource Describes one entity for an ImfEntityWriter to write: the fields and the content of a message or a part, or the raw bytes of one that has not changed.
ImfEntityWriter Represents a writer that provides fast, non-cached, forward-only output of whole Internet messages, with their MIME entities (RFC 2045, RFC 2046), from a description of each message.
ImfGroup A group (RFC 5322 §3.4): a display name and a list of mailboxes, which may be empty, such as Undisclosed recipients:;.
ImfHeaderField One field of the header of an Internet message: either what a reader read, which is written back byte for byte, or a name and body that a writer formats. A field doesn’t change. To change a field of a message, replace it in its ImfHeaderFieldCollection.
ImfHeaderFieldCollection The fields of a header, in order. Lookups by name are case-insensitive.
ImfHeaderReader Represents a reader that provides fast, non-cached, forward-only access to the fields of one header section of an Internet message (RFC 5322 §2.2).
ImfHeaderWriter Represents a writer that provides fast, non-cached, forward-only output of the fields of one header section of an Internet message (RFC 5322 §2.2).
ImfMailbox A mailbox (RFC 5322 §3.4): an optional display name, and an address made of a local part and a domain.
ImfMessage An Internet message (RFC 5322): an ordered list of header fields, with typed accessors over them, and a body.
ImfMessageBuilder Builds a message from its header, its text, and what goes with the text, in the structure that those call for.
ImfMessageId A message identifier (RFC 5322 §3.6.4), as in a Message-ID, In-Reply-To or References header field, such as <1234@local.machine.example>.
ImfMessagePart An entity that holds a message (RFC 2046 §5.2.1, RFC 6532 §3.7), such as one that is being forwarded.
ImfMultipart A multipart entity (RFC 2046 §5.1): an ordered list of entities, with a preamble and an epilogue.
ImfOptions Options to configure the behaviour of an Internet message reader or writer.
ImfPhraseList An ordered, read-only list of phrases, as in a Keywords header field (RFC 5322 §3.6.5).
ImfReader Represents a reader of a whole Internet message into an ImfMessage, which holds it in memory. To read a message without holding it, use an ImfEntityReader.
ImfResentBlock The resent fields of one resending of a message (RFC 5322 §3.6.6).
ImfTraceField A Return-Path or Received field (RFC 5322 §3.6.7). These are strictly informational, and any formal interpretation of them is left to RFC 5321.
ImfWriter Represents a writer of whole Internet messages from ImfMessage objects.
MboxEntry One message of an mbox file, with its separator line.
MboxEnvelope The separator line before a message in an mbox file (RFC 4155 Appendix A): From, a space, the address of the sender, a space, and the UTC date and time that the message was received, in the form of the ctime function with no time zone.
MboxReader Represents a reader of an mbox file (RFC 4155): many Internet messages in one file, each after a separator line. Messages are read one at a time, so a mailbox of any size can be processed without loading it whole.
MboxWriter Represents a writer of mbox files (RFC 4155): many Internet messages in one file, each after a separator line and ended by an empty line.
MhtmlDocument A view of an ImfMessage as an aggregate document (RFC 2557): a web page saved with its resources, as in an MHTML file.
MhtmlDocumentBuilder Builds an aggregate document (RFC 2557) from a root document and its resources: a multipart/related entity whose type and start parameters name the root, with each part labelled with its URL.
MhtmlReader Represents a reader of an MHTML file (.mht, .mhtml), or any other aggregate document (RFC 2557), into an MhtmlDocument.
MhtmlResource A part of an MhtmlDocument, with the URI that its Content-Location field resolves to.
MhtmlWriter Represents a writer of MHTML files (.mht, .mhtml), or any other aggregate documents (RFC 2557), from MhtmlDocument objects.

Static classes

Type Description
ImfHeaderText Reads and writes the text of an unstructured header field or a comment, with RFC 2047 encoded words where RFC 2047 §5 allows them.
ImfMimeFields Reads and writes the bodies of the MIME header fields whose values are not types of this package: MIME-Version, Content-Type, Content-Transfer-Encoding and Content-Language.

Structs

Type Description
ImfDateTime A date-time (RFC 5322 §3.3), as in a Date or Resent-Date header field or at the end of a Received header field, such as Fri, 21 Nov 1997 09:55:06 -0600.
ImfEntityEvent A view of the event an ImfEntityReader has just read, without allocation.
ImfHeaderFieldView A view of the header field an ImfHeaderReader or ImfEntityReader has just read, without allocation.
ImfWriteProgress The progress of a writer. ImfHeaderWriter reports it after each field of a bulk write, ImfEntityWriter after each block of output, and ImfWriter after each field and each block of a body, and MboxWriter after each message of a bulk write.

Exceptions

Type Description
ImfFileException Exception to normal processing of an Internet message.

Delegates

Type Description
EmlxPartResolver Supplies the content of a part that a partial EMLX file stores in another file.

Enumerations

Type Description
EmlxMessageFlags The single-bit flags in the flags key of the property list of an EMLX file.
EmlxPlistValueKind The kinds of value in an XML property list.
ImfDiagnosticKind The kinds of problem that an ImfDiagnostic reports.
ImfEntityEventKind The kinds of event that an ImfEntityReader gives.
ImfHeaderEncoding How an Internet message writer writes header text that is not US-ASCII.
ImfHeaderFieldKind How an Internet message writer may fold a header field (RFC 5322 §2.2).
ImfTraceFieldKind The kinds of trace field (RFC 5322 §3.6.7).
MboxLineBreak The line breaks that an MboxWriter writes.
MboxVariant The variants of the mbox format, which differ in how they keep a line of a message that starts with From from being taken for a separator line.

This site uses Just the Docs, a documentation theme for Jekyll.