 | Header |
A list of Headers.
Inheritance HierarchyNamespace: MimeKit
Assembly: MimeKit (in MimeKit.dll) Version: 4.12.0
SyntaxC#
public sealed class HeaderList : IList<Header>, ICollection<Header>, IEnumerable<Header>, IEnumerable
The HeaderList type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | HeaderList | Initialize a new instance of the HeaderList class. |
Properties| Name | Description | |
|---|---|---|
 | Count | Get the number of headers in the list. |
| IsReadOnly | Get whether the header list is read only. |
| ItemHeaderId | Get or set the value of the first occurrence of a header with the specified field name. |
| ItemInt32 | Get or set the Header at the specified index. |
| ItemString | Get or set the value of the first occurrence of a header with the specified field name. |
Methods| Name | Description | |
|---|---|---|
| Add(Header) | Add the specified header. |
| Add(HeaderId, String) | Add a header with the specified field and value. |
| Add(String, String) | Add a header with the specified field and value. |
| Add(HeaderId, Encoding, String) | Add a header with the specified field and value. |
| Add(String, Encoding, String) | Add a header with the specified field and value. |
| Clear | Clear the header list. |
| Contains(Header) | Check if the HeaderList contains the specified header. |
| Contains(HeaderId) | Check if the HeaderList contains a header with the specified field name. |
| Contains(String) | Check if the HeaderList contains a header with the specified field name. |
| CopyTo | Copy all the headers in the HeaderList to the specified array. |
| Equals | (Inherited from Object) |
| GetEnumerator | Get an enumerator for the list of headers. |
| GetHashCode | (Inherited from Object) |
| GetType | (Inherited from Object) |
| IndexOf(Header) | Get the index of the requested header, if it exists. |
| IndexOf(HeaderId) | Get the index of the requested header, if it exists. |
| IndexOf(String) | Get the index of the requested header, if it exists. |
| Insert(Int32, Header) | Insert the specified header at the given index. |
| Insert(Int32, HeaderId, String) | Insert a header with the specified field and value at the given index. |
| Insert(Int32, String, String) | Insert a header with the specified field and value at the given index. |
| Insert(Int32, HeaderId, Encoding, String) | Insert a header with the specified field and value at the given index. |
| Insert(Int32, String, Encoding, String) | Insert a header with the specified field and value at the given index. |
| LastIndexOf(HeaderId) | Get the last index of the requested header, if it exists. |
| LastIndexOf(String) | Get the last index of the requested header, if it exists. |
 | Load(Stream, CancellationToken) | Load a HeaderList from the specified stream. |
| Load(String, CancellationToken) | Load a HeaderList from the specified file. |
| Load(ParserOptions, Stream, CancellationToken) | Load a HeaderList from the specified stream. |
| Load(ParserOptions, String, CancellationToken) | Load a HeaderList from the specified file. |
| LoadAsync(Stream, CancellationToken) | Asynchronously load a HeaderList from the specified stream. |
| LoadAsync(String, CancellationToken) | Asynchronously load a HeaderList from the specified file. |
| LoadAsync(ParserOptions, Stream, CancellationToken) | Asynchronously load a HeaderList from the specified stream. |
| LoadAsync(ParserOptions, String, CancellationToken) | Asynchronously load a HeaderList from the specified file. |
| Remove(Header) | Remove the specified header. |
| Remove(HeaderId) | Remove the first occurrence of the specified header field. |
| Remove(String) | Remove the first occurrence of the specified header field. |
| RemoveAll(HeaderId) | Remove all the headers matching the specified field name. |
| RemoveAll(String) | Remove all the headers matching the specified field name. |
| RemoveAt | Remove the header at the specified index. |
| Replace(Header) | Replace all headers with identical field names with the single specified header. |
| Replace(HeaderId, String) | Replace all headers with identical field names with the single specified header. |
| Replace(String, String) | Replace all headers with identical field names with the single specified header. |
| Replace(HeaderId, Encoding, String) | Replace all headers with identical field names with the single specified header. |
| Replace(String, Encoding, String) | Replace all headers with identical field names with the single specified header. |
| ToString | (Inherited from Object) |
| WriteTo(Stream, CancellationToken) | Write the HeaderList to the specified output stream. |
| WriteTo(FormatOptions, Stream, CancellationToken) | Write the HeaderList to the specified output stream. |
| WriteToAsync(Stream, CancellationToken) | Asynchronously write the HeaderList to the specified output stream. |
| WriteToAsync(FormatOptions, Stream, CancellationToken) | Asynchronously write the HeaderList to the specified output stream. |
Remarks
Represents a list of headers as found in a MimeMessage
or MimeEntity.
See Also