| HeaderCollection Class |
Represents a collection of all the headers of a mail message or a MIME part.
Inheritance HierarchyNamespace: MailBee.Mime
Assembly: MailBee.NET (in MailBee.NET.dll) Version: 12.5.0 build 687 for .NET 4.5
SyntaxThe HeaderCollection type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | HeaderCollection | Initializes a new instance of the HeaderCollection class |
Methods| Name | Description | |
|---|---|---|
 | Add(String, String, Boolean) |
Adds a header to the collection.
|
| Add(String, String, Boolean, Int32) |
Adds a header to the collection at the specified position.
|
| Clear |
Clears the collection of the headers.
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Exists |
Checks whether a header with the given name exists in the collection.
|
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetEnumerator | Returns an enumerator that iterates through the CollectionBase instance. (Inherited from CollectionBase.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| Items |
Returns the collection of headers having the given name.
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| OnClear | Performs additional custom processes when clearing the contents of the CollectionBase instance. (Inherited from CollectionBase.) |
| OnClearComplete | Performs additional custom processes after clearing the contents of the CollectionBase instance. (Inherited from CollectionBase.) |
| OnInsert | Performs additional custom processes before inserting a new element into the CollectionBase instance. (Inherited from CollectionBase.) |
| OnInsertComplete | Performs additional custom processes after inserting a new element into the CollectionBase instance. (Inherited from CollectionBase.) |
| OnRemove | Performs additional custom processes when removing an element from the CollectionBase instance. (Inherited from CollectionBase.) |
| OnRemoveComplete | Performs additional custom processes after removing an element from the CollectionBase instance. (Inherited from CollectionBase.) |
| OnSet | Performs additional custom processes before setting a value in the CollectionBase instance. (Inherited from CollectionBase.) |
| OnSetComplete | Performs additional custom processes after setting a value in the CollectionBase instance. (Inherited from CollectionBase.) |
| OnValidate | Performs additional custom processes when validating a value. (Inherited from CollectionBase.) |
| Remove |
Removes the header from the collection by the given name.
|
| RemoveAt |
Removes the header from the collection at the given zero-based index.
|
| RemoveCustomHeaders |
Removes any custom headers from the collection of the message headers.
|
| RemoveRouteHeaders |
Removes all route headers from the collection.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Properties| Name | Description | |
|---|---|---|
 | Capacity | Gets or sets the number of elements that the CollectionBase can contain. (Inherited from CollectionBase.) |
| Count | Gets the number of elements contained in the CollectionBase instance. This property cannot be overridden. (Inherited from CollectionBase.) |
 | InnerList | Gets an ArrayList containing the list of elements in the CollectionBase instance. (Inherited from CollectionBase.) |
| ItemInt32 |
Gets or sets the Header object in the collection at the specified zero-based index.
|
| ItemString |
Gets or sets the header value by the header name.
|
| List | Gets an IList containing the list of elements in the CollectionBase instance. (Inherited from CollectionBase.) |
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