Indy 9 | Content | Index | Reference

TIdSMTPGreeting
Hierarchy, Properties, Methods, See Also, Unit: IdSMTPServer
Implements greeting messages used by the SMTP server.

    TIdSMTPGreeting = class(TPersistent)

Unit
IdSMTPServer
Description
TIdSMTPGreeting is a TPersistent descendant that specifies properties and methods need to implement greeting messages used by the TIdSMTPServer. TIdSMTPGreeting is the type used to represent the TIdSMTPMessages.Greeting property.

TIdSMTPGreeting.AuthFailed
TIdSMTPGreeting, See Also
Authentication error message.

    property AuthFailed: string;

Description
AuthFailed is a String property that contains the message written to the client connection when an Authentication attempt to the SMTP server is not successful.

TIdSMTPGreeting.EHLONotSupported
TIdSMTPGreeting
Represents the message used when the EHLO command is not supported.

    property EHLONotSupported: string;

Description
EHLONotSupported is a String property that represents the message written to client connection when the SMTP EHLO command verb is not supported in the SMTP server implementation. EHLONotSupported is used in the TIdSMTPServer.CommandEHLO action handler. EHLOReply is the message sent to the client when the EHLO command is supported.

TIdSMTPGreeting.EHLOReply
TIdSMTPGreeting
SMTP service extentions to be include in the EHLO command response.

    property EHLOReply: TStrings;

Description
EHLOReply is a TStrings property that represents one or more lines of text to be sent in response to the SMTP EHLO command verb. EHLO is an alternate form of the SMTP HELO command verb that provides additional information about SMTP service exstensions in the server response.

EHLOReply is used in the TIdSMTPServer.CommandEHLO action handler when the command object contains parameter values.

The default values in EHLOReply are assigned in the Create constructor, and represent the SMTP service extensions availble in the default server implementation. For example:

        250-localhost
        250-AUTH LOGIN
        250 HELP

If additional SMTP service extensions are added to the server implementation, their keywords should be added to the lines in EHLOReply.

TIdSMTPGreeting.HelloReply
TIdSMTPGreeting
Server response message for the SMTP HLO command verb.

    property HelloReply: string;

Description
HelloReply is a String property that specifies the server response message used for the SMTP HELO command verb. HelloReply is used in the TIdSMTPServer.CommandHELO action handler when the command object contains parameter values.

TIdSMTPGreeting.NoHello
TIdSMTPGreeting
Represents the error response message used prior to HELO or EHLO commands.

    property NoHello: string;

Description
NoHello is a String property to specifies the server response issued to a client requesting a SMTP command verb prior to issuing a HELO or EHLO command. NoHello is used in the TIdSMTPServer action handlers invoked for the SMTP MAIL, RCPT or DATA command verbs.

TIdSMTPGreeting.Assign
TIdSMTPGreeting
Copies the properties of one Object instance to another.

    procedure Assign(Source: TPersistent); override;

Parameters
Source: TPersistent
Object instance containing values to be copied.
Description
Assign is an overridden procedure that copies the property values in Source to the current object instance. Assign calls the inherited Assign method.

Assign checks whether the Source parameter specifies another TIdSMTPGreeting instance, and if so, copies the values of the EHLONotSupported, HelloReply, NoHello, and EHLOReply properties.

If Source is not a TIdSMTPGreeting instance, Assign calls the inherited method, which assigns properties from any object that specifies how to copy using the AssignTo method.

TIdSMTPGreeting.Create
TIdSMTPGreeting
Constructor for the object instance.

    constructor Create;

Description
Create is the constructor for the object instance, anc calls the inherited Create method to initialize object properties. Create allocates resources for the EHLOReply property, and sets the following properties to their default values:

- HelloReply - RSSMTPSvrHello

- NoHello - RSSMTPSvrNoHello

- EHLONotSupported - RSSMTPSvrCmdNotRecognized

- AuthFailed - RSSMTPSvrAuthFailed

TIdSMTPGreeting.Destroy
TIdSMTPGreeting, See Also
Frees the object instance.

    destructor Destroy; override;

Description
Destroy is the destructor for the object instance. Destroy frees resources allocated to the EHLOReply, and calls the inherited Destroy method.

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