TElMessage.AssembleMessage method

Discuss this help topic in SecureBlackbox Forum

TElMessage.AssembleMessage

TElMessage See also

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

This method assembles body and all header fields into one message.

Declaration

[C#]
int AssembleMessage(System.IO.Stream Destination, bool bAssembleSource);
int AssembleMessage(System.IO.Stream Destination, string ACharset, TElHeaderEncoding HeaderEncoding, string BodyEncoding, string AttachEncoding, bool bAssembleSource);

[VB.NET]
Function AssembleMessage(ByVal Destination As System.IO.Stream, ByVal bAssembleSource As Boolean) As Integer
Function AssembleMessage(ByVal Destination As System.IO.Stream, ByVal ACharset As String, ByVal HeaderEncoding As TElHeaderEncoding, ByVal BodyEncoding As String, ByVal AttachEncoding As String, ByVal bAssembleSource As Boolean) As Integer

[Pascal]
function AssembleMessage( Destination: TElNativeStream; const ACharset: AnsiString; HeaderEncoding: TElHeaderEncoding; const BodyEncoding; AttachEncoding: AnsiString; bAssembleSource: Boolean = False): ELMIMERESULT;
function AssembleMessage( Destination: TElNativeStream; bAssembleSource: Boolean = False): ELMIMERESULT;

[C++]
    int32_t AssembleMessage(TStream &Destination, bool bAssembleSource);
    int32_t AssembleMessage(TStream *Destination, bool bAssembleSource);
    int32_t AssembleMessage(TStream &Destination, const std::string &ACharset, TElHeaderEncoding HeaderEncoding, const std::string &BodyEncoding, const std::string &AttachEncoding, bool bAssembleSource);
    int32_t AssembleMessage(TStream *Destination, const std::string &ACharset, TElHeaderEncoding HeaderEncoding, const std::string &BodyEncoding, const std::string &AttachEncoding, bool bAssembleSource);

[PHP]
integer AssembleMessage(TStream $Destination, bool $bAssembleSource)
integer AssembleMessage(TStream $Destination, string $ACharset, integer $HeaderEncoding, string $BodyEncoding, string $AttachEncoding, bool $bAssembleSource)

[Java]
int assembleMessage(TElStream Destination, boolean bAssembleSource);
int assembleMessage(TElStream Destination, String ACharset, TElHeaderEncoding HeaderEncoding, String BodyEncoding, String AttachEncoding, boolean bAssembleSource);

Parameters

Destination - stream in which assembled data will be written.
ACharset - charset of the message.
HeaderEncoding - type of the header encoding.
BodyEncoding - type of text parts encoding.
AttachEncoding - type of attach encoding.
bAssembleSource - shows assembling type. True - loaded message will be assembled in its unmodified state. The default value is False.

TElHeaderEncoding values

[.NET] [C++]	[Pascal]	Description
heAutoDetect = 0	heAutoDetect	Detect the necessary encoding automatically
he8bit = 1	he8bit	8bit encoding as defined in RFC 2045
heBase64 = 2	heBase64	Base64 encoding as defined in RFC 2045
heQuotedPrintable = 3	heQuotedPrintable	Quoted-printable encoding as defined in RFC 2045

Return value

Returns 0 (EL_OK) on success, 1 (EL_WARNING) if information can't be encoded with given ACharset and encodings.
Error otherwise.

Description

Use this method to compose the message and save it to stream.
AssembleMessage has the functionality opposite to ParseMessage method.

Note, that if you are using "short" form of AssembleMessage() method call, you can specify missing parameters with Charset, HeaderEncoding, BodyEncoding and AttachEncoding properties.

See also: AttachEncoding BodyEncoding Charset HeaderEncoding ParseMessage

Discuss this help topic in SecureBlackbox Forum