C# Class MimeKit.MessagePartial

A MIME part containing a partial message as its content.

Represents a MIME part with a Content-Type of message/partial.

Inheritance: MimePart

Show file Open project: nachocove/MimeKit Class Usage Examples

Public Methods

Method	Description
Accept ( MimeKit.MimeVisitor visitor ) : void	Dispatches to the specific visit method for this MIME entity. This default implementation for MimeKit.MessagePartial nodes calls MimeKit.MimeVisitor.VisitMessagePartial. Override this method to call into a more specific method on a derived visitor class of the MimeKit.MimeVisitor class. However, it should still support unknown visitors by calling MimeKit.MimeVisitor.VisitMessagePartial.
Join ( IEnumerable partials ) : MimeMessage	Joins the specified message/partial parts into the complete message. Combines all of the message/partial fragments into its original, complete, message.
Join ( ParserOptions options, IEnumerable partials ) : MimeMessage	Joins the specified message/partial parts into the complete message. Combines all of the message/partial fragments into its original, complete, message.
MessagePartial ( MimeKit.MimeEntityConstructorArgs args ) : System	Initializes a new instance of the MimeKit.MessagePartial class. This constructor is used by MimeKit.MimeParser.
MessagePartial ( string id, int number, int total ) : System	Initializes a new instance of the MimeKit.MessagePartial class. Creates a new message/partial entity. Three (3) parameters must be specified in the Content-Type header of a message/partial: id, number, and total. The "id" parameter is a unique identifier used to match the parts together. The "number" parameter is the sequential (1-based) index of the partial message fragment. The "total" parameter is the total number of pieces that make up the complete message.
Split ( MimeMessage message, int maxSize ) : IEnumerable	Splits the specified message into multiple messages. Splits the specified message into multiple messages, each with a message/partial body no larger than the max size specified.

Private Methods

Method	Description
CloneMessage ( MimeMessage message ) : MimeMessage
PartialCompare ( MessagePartial partial1, MessagePartial partial2 ) : int

Method Details

Accept() public method

Dispatches to the specific visit method for this MIME entity.

This default implementation for MimeKit.MessagePartial nodes calls MimeKit.MimeVisitor.VisitMessagePartial. Override this method to call into a more specific method on a derived visitor class of the MimeKit.MimeVisitor class. However, it should still support unknown visitors by calling MimeKit.MimeVisitor.VisitMessagePartial.

/// is null. ///

public Accept ( MimeKit.MimeVisitor visitor ) : void
visitor	MimeKit.MimeVisitor	The visitor.
return	void

Join() public static method

Joins the specified message/partial parts into the complete message.

Combines all of the message/partial fragments into its original, complete, message.

/// is null. ///

public static Join ( IEnumerable partials ) : MimeMessage
partials	IEnumerable	The list of partial message parts.
return	MimeMessage

Join() public static method

Joins the specified message/partial parts into the complete message.

Combines all of the message/partial fragments into its original, complete, message.

/// is null. /// -or- /// is null. /// /// The last partial does not have a Total. /// -or- /// The number of partials provided does not match the expected count. /// -or- /// One or more partials is missing. ///

public static Join ( ParserOptions options, IEnumerable partials ) : MimeMessage
options	ParserOptions	The parser options to use.
partials	IEnumerable	The list of partial message parts.
return	MimeMessage

MessagePartial() public method

Initializes a new instance of the MimeKit.MessagePartial class.

This constructor is used by MimeKit.MimeParser.

/// is null. ///

public MessagePartial ( MimeKit.MimeEntityConstructorArgs args ) : System
args	MimeKit.MimeEntityConstructorArgs	Information used by the constructor.
return	System

MessagePartial() public method

Initializes a new instance of the MimeKit.MessagePartial class.

Creates a new message/partial entity.

Three (3) parameters must be specified in the Content-Type header of a message/partial: id, number, and total.

The "id" parameter is a unique identifier used to match the parts together.

The "number" parameter is the sequential (1-based) index of the partial message fragment.

The "total" parameter is the total number of pieces that make up the complete message.

/// is null. /// /// is less than 1. /// -or- /// is less than . ///

public MessagePartial ( string id, int number, int total ) : System
id	string	The id value shared among the partial message parts.
number	int	The (1-based) part number for this partial message part.
total	int	The total number of partial message parts.
return	System

Split() public static method

Splits the specified message into multiple messages.

Splits the specified message into multiple messages, each with a message/partial body no larger than the max size specified.

/// is null. /// /// is less than 1. ///

public static Split ( MimeMessage message, int maxSize ) : IEnumerable
message	MimeMessage	The message.
maxSize	int	The maximum size for each message body.
return	IEnumerable