Entity Class

Namespace:
GemBox.Email.Mime
Assembly:
GemBox.Email.dll

Provides the abstract base class for MIME entities.

public abstract class Entity
Public MustInherit Class Entity
Inheritance:
System.Object
Entity
Derived
ContentEntity
MultipartEntity

Properties

ContentType

Gets the Content-Type header value.

public MediaType ContentType { get; }
Public ReadOnly Property ContentType As MediaType
Property Value
MediaType

The Content-Type header value.

Headers

Gets the Entity headers.

public HeaderCollection Headers { get; }
Public ReadOnly Property Headers As HeaderCollection
Property Value
HeaderCollection

The Entity headers.

IsMultipart

Gets a value indicating whether this Entity is multipart.

public abstract bool IsMultipart { get; }
Public MustOverride ReadOnly Property IsMultipart As Boolean
Property Value
System.Boolean

True if this Entity is multipart; otherwise, false.

Parent

Gets the Entity parent.

public MultipartEntity Parent { get; }
Public ReadOnly Property Parent As MultipartEntity
Property Value
MultipartEntity

The Entity parent.

Methods

Clone()

Creates a copy of this Entity instance.

public abstract Entity Clone()
Public MustOverride Function Clone As Entity
Returns
Entity

The copy of this Entity instance.

Find(MediaType)

Checks if this Entity instance or one of its children matches the specified content type.

public Entity Find(MediaType contentType)
Public Function Find(contentType As MediaType) As Entity
Parameters
contentType
MediaType

The content type.

Returns
Entity

Entity instance whose content type matches specified one; otherwise, null.

Find(Func<Entity, Boolean>)

Checks if this Entity instance or one of its children satisfies a condition.

public abstract Entity Find(Func<Entity, bool> predicate)
Public MustOverride Function Find(predicate As Func(Of Entity, Boolean)) As Entity
Parameters
predicate
System.Func<Entity, System.Boolean>

A function to test each element for a condition.

Returns
Entity

Entity instance which satisfies a condition; otherwise, null.

Find(String)

Checks if this Entity instance or one of its children matches the specified top level media type.

public Entity Find(string topLevelMediaType)
Public Function Find(topLevelMediaType As String) As Entity
Parameters
topLevelMediaType
System.String

The top level media type.

Returns
Entity

Entity instance whose top level media type matches specified one; otherwise, null.