TElMessagePart.Parse method

Discuss this help topic in SecureBlackbox Forum

TElMessagePart.Parse

TElMessagePart See also

Filter: C# VB.NET Pascal C++ PHP Java

Loads MessagePart data from stream.

Declaration

[C#]
int Parse(TElMessageHeader Header, System.IO.Stream Source, string Boundary, string HeaderCharset, string BodyCharset, TElMessageParsingOptions AOptions, bool IgnoreHeaderNativeCharset, bool IgnoreBodyNativeCharset, bool bActivatePartHandlers);

[VB.NET]
Function Parse(ByVal Header As TElMessageHeader, ByVal Source As System.IO.Stream, ByVal Boundary As String, ByVal HeaderCharset As String, ByVal BodyCharset As String, ByVal AOptions As TElMessageParsingOptions, ByVal IgnoreHeaderNativeCharset As Boolean, ByVal IgnoreBodyNativeCharset As Boolean, ByVal bActivatePartHandlers As Boolean) As Integer

[Pascal]
function Parse(Header: TElMessageHeader; Source: TElNativeStream; const Boundary, HeaderCharset, BodyCharset: AnsiString; AOptions: TElMessageParsingOptions; IgnoreHeaderNativeCharset, IgnoreBodyNativeCharset, bActivatePartHandlers: Boolean): ELMIMERESULT;
TElMessageParsingOptions = set of TElMessageParsingOption;

[C++]
int32_t Parse(TElMessageHeader &Header, TStream &Source, const std::string &Boundary, const std::string &HeaderCharset, const std::string &BodyCharset, TElMessageParsingOptions AOptions, bool IgnoreHeaderNativeCharset, bool IgnoreBodyNativeCharset, bool bActivatePartHandlers);
int32_t Parse(TElMessageHeader *Header, TStream *Source, const std::string &Boundary, const std::string &HeaderCharset, const std::string &BodyCharset, TElMessageParsingOptions AOptions, bool IgnoreHeaderNativeCharset, bool IgnoreBodyNativeCharset, bool bActivatePartHandlers);

[PHP]
integer Parse(TElMessageHeader $Header, TStream $Source, string $Boundary, string $HeaderCharset, string $BodyCharset, integer $AOptions, bool $IgnoreHeaderNativeCharset, bool $IgnoreBodyNativeCharset, bool $bActivatePartHandlers)

[Java]
int parse(TElMessageHeader Header, TElStream Source, String Boundary, String HeaderCharset, String BodyCharset, TElMessageParsingOptions AOptions, boolean IgnoreHeaderNativeCharset, boolean IgnoreBodyNativeCharset, boolean bActivatePartHandlers);

Parameters

Header - part header.
Source - source stream.
Boundary - boundary which is used to separate parts in multipart part.
HeaderCharset - charset of the header.
BodyCharset - charset of the body.
AOptions - parsing options.
IgnoreHeaderNativeCharset - determines what charset must be applied to the message header.
True - the one specified in HeaderCharset
False - the one specified in message if it exists or specified in HeaderCharset if there is no charset specified in the message.
IgnoreBodyNativeCharset - determines what charset must be applied to the message body.
True - the one specified in BodyCharset
False - the one specified in message if it exists or specified in BodyCharset if there is no charset specified in the message.
bActivatePartHandlers - shows if handlers must be invoked automatically.
True - if there is a handler determined for the part it will be invoked automatically on part processing.
False - even if handler is determined it won't be invoked automatically.

Return value

Returns 0 (EL_OK) on success, 1 (EL_WARNING) if source data contains byte sequences illegal for given charsets. Error otherwise.

ELMessageParsingOptions values

[.NET]	[Pascal]	[C++]	Description
mpoStoreStream = 1	mpoStoreStream	f_mpoStoreStream = 1	Stores positions of the message parts in internal structure. Allows to decipher message and check signature.
mpoLoadData = 2	mpoLoadData	f_mpoLoadData = 2	Specifies if message body will be loaded into internal storage.
mpoCalcDataSize = 4	mpoCalcDataSize	f_mpoCalcDataSize = 4	Specifies if real message size will be calculated.
mpoRaiseError = 8	mpoRaiseError	f_mpoRaiseError = 8	Specifies whether to raise an exception when an error occurrs during parsing.
mpoDelayDataDecode = 16	mpoDelayDataDecode	f_mpoDelayDataDecode = 16	Defines that the data is not decoded during parsing (if it was encoded). Parsing will be faster, but first data retrieval will be slower, when this option is set.

TElMessageParsingOptions values

[.NET][C++]	[Pascal]	[PHP]	Description
f_mpoStoreStream = 1	mpoStoreStream	mpoStoreStream = 1	Stores positions of the message parts in internal structure. Allows to decipher message and check signature.
f_mpoLoadData = 2	mpoLoadData	mpoLoadData = 2	Specifies if message body will be loaded into internal storage.
f_mpoCalcDataSize = 4	mpoCalcDataSize	mpoCalcDataSize = 4	Specifies if real message size will be calculated.
f_mpoRaiseError = 8	mpoRaiseError	mpoRaiseError = 8	Specifies whether to raise an exception when an error occurrs during parsing.
f_mpoDelayDataDecode = 16	mpoDelayDataDecode	mpoDelayDataDecode = 16	Defines that the data is not decoded during parsing (if it was encoded). Parsing will be faster, but first data retrieval will be slower, when this option is set.

Description

Use this method to decompose message part from stream into parts such as body, header etc. Parse has the functionality opposite to Assemble.
Note, Options setting differs for VCL and .NET versions. To enable several options in .NET use bitwise OR operation, for example "mpoStoreStream | mpoLoadData | mpoCalcDataSize".

See also: Assemble

Discuss this help topic in SecureBlackbox Forum