Indy 9 | Content | Index | Reference

TIdMessageEncoderInfo
Hierarchy, Properties, Methods, See Also, Unit: IdMessageCoder
Represents information about registered encoder classes and generates RFC message headers for the encoder class.

    TIdMessageEncoderInfo = class(TObject)

Unit
IdMessageCoder
Description
TIdMessageEncoderInfo is a TObject descendant that specifies the base class for representing information about a registered encoder classes. TIdMessageEncoderInfo also provides a mechanism to create RFC 822 headers for the encoder class in an associated TIdMessage instance.

Descendant classes, like TIdMessageEncoderInfoMIME, TIdMessageEncoderInfoUUE, and TIdMessageEncoderInfoXXE, should reimplement the virtual methods in TIdMessageEncoderInfo to provide support for assigning the correct MessageEncoderClass class type and InitializeHeaders values for the specific encoder.

TIdMessageEncoderInfo.MessageEncoderClass
TIdMessageEncoderInfo, See Also
Represents the class type used to create new instances for the registered encoder class.

    property MessageEncoderClass: TIdMessageEncoderClass;

Description
MessageEncoderClass is a TIdMessageEncoderClass property that represents the class type used to create new instances for the registered encoder class.

MessageEncoderClass is assigned a class type instance in the Create Constructor for a specific encoder class. MessageCoderClass is used accesed when TIdMessagePart descendants call their Encode method. A new instance of the registerd encoder class is created, and used to perform the encoding operation.

TIdMessageEncoderInfo.Create
TIdMessageEncoderInfo, See Also
Constructor for the object instance.

    constructor Create; virtual;

Description
Create is the Constructor for the object instance. Descendant classes, like TIdMessageEncoderInfoMIME, TIdMessageEncoderInfoUUE, and TIdMessageEncoderInfoXXE must assign the correct class type value for MessageEncoderClass in their overridden Constructors.

TIdMessageEncoderInfo.InitializeHeaders
TIdMessageEncoderInfo, See Also
Specifies a method for generating RFC 822 headers for a message.

    procedure InitializeHeaders(AMsg: TIdMessage); virtual;

Parameters
AMsg: TIdMessage
Message instance to be updated with RFC message headers.
Description
InitializeHeaders is a virtual procedure in TIdMessageEncoderInfo that Specifies a method for generating RFC 822 message headers for an instance of TIdMessage. Descendant classes, like TIdMessageEncoderInfoMIME, TIdMessageEncoderInfoUUE, and TIdMessageEncoderInfoXXE should override the method to provide support for generating message headers specific to the giver encoder type.

Created with Doc-O-Matic 2 donated to Project JEDI. Commercial license available from the Doc-O-Matic site.