Implements a message client.

TIdMessageClient = class(TIdTCPClient)

TIdMessageClient is a TIdTCPClient descendant that implements a generic message client. TIdMessageClient can read and write Internet messages compliant with the RFC 822 message specification.

TIdMessageClient provides methods and properties needed to handle transmission and receipt of both the headers and the body for an Internet message, including line folding.

Identifies the line fold character sequence.

property MsgLineFold: string;

MsgLineFold is a String property that identifies the line fold character sequence inserted at the beginning of a folded line. The default value for MsgLineFold is TAB (Decimal 9), as assigned in the Create constructor.

Maximum line length.

property MsgLineLength: integer;

MsgLineLength is an Integer property that specifies the maximum length of a header line. If the length is exceeded, the header line is folded. The default value for MsgLineLength is 79, as assigned in the Create constructor.

Constructor for the object instance.

constructor Create(AOwner: TComponent); override;

Owner of the object instance.

Create is the constructor for the object instance. Create relies on the inherited create constructor, and initializes the following property values:

• MsgLineLength - 79

• MsgLineFold = TAB character (Decimal 9)

Loads and processes message headers and contents into a TIdMessage instance.

procedure ProcessMessage(AMsg: TIdMessage; AHeaderOnly: Boolean = False); overload;
procedure ProcessMessage(AMsg: TIdMessage; const AStream: TStream; AHeaderOnly: Boolean = False); overload;
procedure ProcessMessage(AMsg: TIdMessage; const AFilename: string; AHeaderOnly: Boolean = False); overload;

Message to receive header and contents.

Stream containing headers and contents to be loaded.

File containing headers and contents to be loaded.

ProcessMessage is an overloaded method in TIdMessageClient that implements loading and processing of message headers and contents using socket-, stream-, or file-based IOHandlers.

The default implementation of ProcessMessage uses the IOHandler assigned to the client connection to receive the header and body of the message, and stores data in the message instance specified in AMsg.

The stream-based variant of ProcessMessage creates a TIdIOHandlerStream instance that can be used to load data from the stream specified in AStream into AMsg. The TIdIOHandlerStream instance is freed prior to exiting from the method.

The file-based variant of ProcessMessage creates a TFileStream used to access message data in the file specified by AFilename, and calls the stream-based variant of ProcessMessage to load message data into AMsg. The TFileStream instance is freed prior to exiting from the method.

Loads and processes message headers and contents into a TIdMessage instance.

procedure ProcessMessage(AMsg: TIdMessage; AHeaderOnly: Boolean = False); overload;
procedure ProcessMessage(AMsg: TIdMessage; const AStream: TStream; AHeaderOnly: Boolean = False); overload;
procedure ProcessMessage(AMsg: TIdMessage; const AFilename: string; AHeaderOnly: Boolean = False); overload;

Message to receive header and contents.

Stream containing headers and contents to be loaded.

File containing headers and contents to be loaded.

ProcessMessage is an overloaded method in TIdMessageClient that implements loading and processing of message headers and contents using socket-, stream-, or file-based IOHandlers.

The default implementation of ProcessMessage uses the IOHandler assigned to the client connection to receive the header and body of the message, and stores data in the message instance specified in AMsg.

The stream-based variant of ProcessMessage creates a TIdIOHandlerStream instance that can be used to load data from the stream specified in AStream into AMsg. The TIdIOHandlerStream instance is freed prior to exiting from the method.

The file-based variant of ProcessMessage creates a TFileStream used to access message data in the file specified by AFilename, and calls the stream-based variant of ProcessMessage to load message data into AMsg. The TFileStream instance is freed prior to exiting from the method.

Loads and processes message headers and contents into a TIdMessage instance.

procedure ProcessMessage(AMsg: TIdMessage; AHeaderOnly: Boolean = False); overload;
procedure ProcessMessage(AMsg: TIdMessage; const AStream: TStream; AHeaderOnly: Boolean = False); overload;
procedure ProcessMessage(AMsg: TIdMessage; const AFilename: string; AHeaderOnly: Boolean = False); overload;

Message to receive header and contents.

Stream containing headers and contents to be loaded.

File containing headers and contents to be loaded.

ProcessMessage is an overloaded method in TIdMessageClient that implements loading and processing of message headers and contents using socket-, stream-, or file-based IOHandlers.

The default implementation of ProcessMessage uses the IOHandler assigned to the client connection to receive the header and body of the message, and stores data in the message instance specified in AMsg.

The stream-based variant of ProcessMessage creates a TIdIOHandlerStream instance that can be used to load data from the stream specified in AStream into AMsg. The TIdIOHandlerStream instance is freed prior to exiting from the method.

The file-based variant of ProcessMessage creates a TFileStream used to access message data in the file specified by AFilename, and calls the stream-based variant of ProcessMessage to load message data into AMsg. The TFileStream instance is freed prior to exiting from the method.

Sends message headers and body on the client connection.

procedure SendMsg(AMsg: TIdMessage; const AHeadersOnly: Boolean = False); virtual;

Message to be sent by the client.

Client will write only headers. Default value is False.

SendMsg is a virtual procedure in TIdMessageClient that performs the processing required to send the message headers and optional message parts from the message specified in AMsg using the message client. The default implementation of SendMsg calls SendHeader to write the message headers in AMsg. When AHeaderOnly is False, SendMsg also writes a blank separator line signalling the end of message headers, and calls SendBody to send the contents of the message body or message parts.

Descendant classes may override the default SendMsg behavior to implement protocol specific message transmission requirements.