HeaderCollection Class
Represents a collection of all the headers of a mail message or a MIME part.
Inheritance Hierarchy

Namespace: MailBee.Mime
Assembly: MailBee.NET (in MailBee.NET.dll) Version: 11.2.0 build 590 for .NET 4.5
Syntax
public class HeaderCollection : CollectionBase

The HeaderCollection type exposes the following members.

Constructors
  NameDescription
Public methodHeaderCollection
Initializes a new instance of the HeaderCollection class
Top
Methods
  NameDescription
Public methodCode exampleAdd(String, String, Boolean)
Adds a header to the collection.
Public methodCode exampleAdd(String, String, Boolean, Int32)
Adds a header to the collection at the specified position.
Public methodCode exampleClear
Clears the collection of the headers.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodCode exampleExists
Checks whether a header with the given name exists in the collection.
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetEnumerator
Returns an enumerator that iterates through the CollectionBase instance.
(Inherited from CollectionBase.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodCode exampleItems
Returns the collection of headers having the given name.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodOnClear
Performs additional custom processes when clearing the contents of the CollectionBase instance.
(Inherited from CollectionBase.)
Protected methodOnClearComplete
Performs additional custom processes after clearing the contents of the CollectionBase instance.
(Inherited from CollectionBase.)
Protected methodOnInsert
Performs additional custom processes before inserting a new element into the CollectionBase instance.
(Inherited from CollectionBase.)
Protected methodOnInsertComplete
Performs additional custom processes after inserting a new element into the CollectionBase instance.
(Inherited from CollectionBase.)
Protected methodOnRemove
Performs additional custom processes when removing an element from the CollectionBase instance.
(Inherited from CollectionBase.)
Protected methodOnRemoveComplete
Performs additional custom processes after removing an element from the CollectionBase instance.
(Inherited from CollectionBase.)
Protected methodOnSet
Performs additional custom processes before setting a value in the CollectionBase instance.
(Inherited from CollectionBase.)
Protected methodOnSetComplete
Performs additional custom processes after setting a value in the CollectionBase instance.
(Inherited from CollectionBase.)
Protected methodOnValidate
Performs additional custom processes when validating a value.
(Inherited from CollectionBase.)
Public methodCode exampleRemove
Removes the header from the collection by the given name.
Public methodCode exampleRemoveAt
Removes the header from the collection at the given zero-based index.
Public methodCode exampleRemoveCustomHeaders
Removes any custom headers from the collection of the message headers.
Public methodCode exampleRemoveRouteHeaders
Removes all route headers from the collection.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Properties
  NameDescription
Public propertyCapacity
Gets or sets the number of elements that the CollectionBase can contain.
(Inherited from CollectionBase.)
Public propertyCount
Gets the number of elements contained in the CollectionBase instance. This property cannot be overridden.
(Inherited from CollectionBase.)
Protected propertyInnerList
Gets an ArrayList containing the list of elements in the CollectionBase instance.
(Inherited from CollectionBase.)
Public propertyCode exampleItemInt32
Gets or sets the Header object in the collection at the specified zero-based index.
Public propertyCode exampleItemString
Gets or sets the Header object of the collection by the header name.
Protected propertyList
Gets an IList containing the list of elements in the CollectionBase instance.
(Inherited from CollectionBase.)
Top
Remarks
This collection can be used to examine, modify, add or remove headers to the mail message or its individual parts (such as attachments).

For mail messages, this collection is available through the MailMessage.Headers.

For individual MIME parts, the developer can access headers via MimePart.Headers property.

Attachment and TextBodyPart objects also support MimePart.Headers property.

To get the headers section of the message as string, use MailMessage.RawHeader property. MimePart class also supports such property. Please note that RawHeader properties will return empty string if the source of the message is not available (this is common when you're composing a new message rather than examining an existing one).

Examples
The example is available in Header class overview.
See Also