TROCustomEmailServer

 

Standard component constructor

constructor Create(aOwner: TComponent)

Parameters:

• aOwner: Owner

---

Toggles whether the server ready to receive requests from clients. Depending on the server type, changing this property might open/close a network socket or otherwise toggle whether the server will process incoming requests.

property Active: Boolean read write

---

Copies the contents of another, similar object.

procedure Assign(Source: TPersistent)

Parameters:

• Source: Instance whose properties will be copied

---

Validates the server properties.

procedure CheckProperties

---

Decrypt stream

procedure DecryptStream(const Source: TStream; const Dest: TStream)

Parameters:

• Source: Source
• Dest: Destination

---

Decrypt stream

procedure DecryptStream(const Stream: TStream)

Parameters:

• Stream: Stream

---

Holds the message that will be sent back to the client if it improperly "welcomes" the server.

property DefaultResponse: string read write

---

Specifies how incoming requests will be processed and dispatched. Depending on the server type, one or multiple dispatchers can be configured to receive messages from the client. Each dispatcher consists of a Message and an optional Name. Also, each dispatcher can be individually enabled or disabled. Each server must have at least one dispatcher configured, in order to be able to process messages.

=Essential Sub-Properties=

• Message specifies the message format to be used for this dispatcher.
• Name specifies the name, or possibly the URL for the dispatcher.

In HTTP based servers (such as the TROIndyHTTPServer, the Name will be appended as folder to the server URL allowing the server to make multiple dispatchers available at different URLs.

property Dispatchers: TROMessageDispatchers read write

---

function DispatchMessage(const aTransport: IROTransport; aRequestStream: TStream; aResponseStream: TStream): Boolean

Parameters:

• aTransport:
• aRequestStream:
• aResponseStream:

---

function DispatchMessage(const aTransport: IROTransport; aRequestStream: TStream; aResponseStream: TStream; out oResponseOptions: TROResponseOptions): Boolean

Parameters:

• aTransport:
• aRequestStream:
• aResponseStream:
• oResponseOptions:

---

procedure DoBeforeDecryptEvent(aEncryptedStream: TStream)

Parameters:

• aEncryptedStream: Stream

---

This is DES based enscryption, it is obsolete because works only for Delphi. Use message envelope AES Encryption Envelope instead.

property Encryption: TROEncryption read write

---

Encrypt stream

procedure EncryptStream(const Source: TStream; const Dest: TStream)

Parameters:

• Source: Source
• Dest: Destination

---

Encrypt stream

procedure EncryptStream(const Stream: TStream)

Parameters:

• Stream: Stream

---

Returns TROMessageDispatchers class

function GetDispatchersClass: TROMessageDispatchersClass

---

function GetRODLReader: TROCustomRODLReader

---

Returns SSL state

function GetSecure: Boolean

---

Returns current server type

function GetServerType: TROServerType

---

function GetServiceMetaData(aServiceName: string; aOptions: string; out aContentType: string): TStream

Parameters:

• aServiceName:
• aOptions:
• aContentType:

---

Returns itself.

function GetTransportObject: TObject

---

function IntDispatchMessage(Dispatcher: TROMessageDispatcher; const aTransport: IROTransport; aRequestStream: TStream; aResponseStream: TStream; out oResponseOptions: TROResponseOptions): Boolean

Parameters:

• Dispatcher:
• aTransport:
• aRequestStream:
• aResponseStream:
• oResponseOptions:

---

Checks if encryption was used

function IsEncryptionUsed: Boolean

---

function IsServiceAllowed(Value: string): Boolean

Parameters:

• Value:

---

Checks state of stream

function IsStreamEncrypted(Source: TStream): Boolean

Parameters:

• Source: Stream

---

Forwards notification messages to all owned components.

procedure Notification(AComponent: TComponent; Operation: TOperation)

Parameters:

• AComponent: component
• Operation: operation

---

Fired after stream was encrypted

property OnAfterEncrypt: TROBaseConnectionOperation read write
delegate:  procedure OnAfterEncrypt(Sender: TROBaseConnection; aEncryptedStream: TStream)

---

Fires after the server has been activated.

property OnAfterServerActivate: TNotifyEvent read write

---

Fires after the server has been deactivated. You can use this event handler to perform any cleanup you might need after the server has stopped processing new requests.

property OnAfterServerDeactivate: TNotifyEvent read write

---

Fired before stream will be decrypted

property OnBeforeDecrypt: TROBaseConnectionOperation read write
delegate:  procedure OnBeforeDecrypt(Sender: TROBaseConnection; aEncryptedStream: TStream)

---

Fires just before the server is activated. You can use this event handler to perform any initialization you might need before the server starts processing new requests.

property OnBeforeServerActivate: TNotifyEvent read write

---

Fires just before the server is deactivated. You can use this event handler to perform any cleanup you might need before the server stops processing new requests.

property OnBeforeServerDeactivate: TNotifyEvent read write

---

This event is fired if an exception was raised in the worker thread. Users can handle it and respond to those exceptions.

Because polling the account happens in a worker thread, any problems encountered during polling (such as failed authentication with the POP3 server) will not bubble up to the main application. It is therefore important to handle this event if you want to be informed of error conditions.

property OnException: TROExceptionEvent read write
delegate:  procedure OnException(aSender: TObject; aExceptionClass: TClass; const aExceptionMessage: string)

---

property OnGetRODLReader: TROGetRODLReader read write
delegate:  procedure OnGetRODLReader(Sender: TROServer; var aRODLReader: TROCustomRODLReader)

---

Fires after a stream with a request message has been received from the client. The event handler can inspect and possibly modify the stream, before it continues to be processed by the higher levels of the Remoting SDK framework.

property OnReadFromStream: TStreamOperation read write
delegate:  procedure OnReadFromStream(aStream: TStream)

---

Fires just before a stream with a response message is sent back to the client. The event handler can inspect and possibly modify the stream, before it continues to be sent off to the client.

property OnWriteToStream: TStreamOperation read write
delegate:  procedure OnWriteToStream(aStream: TStream)

---

The server will check the POP3 account for new incoming requests with this interval (in seconds). The default value is 60 seconds.

property Pop3CheckInterval: Integer read write

---

Provides direct access to the underlying Indy POP3 Client implementation. You can use this property to control advanced settings on the Indy POP3 object, such as setting authentication options. The concrete set of properties available in this object depends on the Indy version in use.
The SmtpClient property can be used to control advanced options.

property Pop3Client: TIdPOP3 read write

---

Password to be used to authenticate with the POP3 server.

property Pop3Password: string read write

---

Defines the address of the POP3 server that will be used to collect incoming request emails. This can be a host name or IP address, and should point to the POP3 server where email specified in ServerEmail will be delivered.

property Pop3ServerAddress: string read write

---

Specifies the login name to be used to authenticate with the POP3 server.

property Pop3Username: string read write

---

The network socket where the server will be listening

property Port: Integer read write

---

Forwards notification messages to all owned components.

procedure ROFreeNotification(aComponent: TComponent)

Parameters:

• aComponent: component

---

Forwards notification messages to all owned components.

procedure RORemoveFreeNotification(aComponent: TComponent)

Parameters:

• aComponent: component

---

Forwards notification messages to all owned components.

procedure SendRemoveNotification(aComponent: TComponent)

Parameters:

• aComponent: component

---

Specifies the email address of the server. This address will be used by the client to deliver emails to this server, and it will also be placed in the "From:" field of sent emails. This email address should match the POP3 account configured for the server, so that the server will be able to access requests directed at it.

property ServerEmail: string read write

---

Specifies whether the server will make the contained RODL file available to clients (true, default) or not. Keep this property set to true if clients need to access the RODL (or WSDL), for example so that third parties (including Service Tester) can import services. Set it to false if you do not want to provide this information, for example for security reasons.

property ServeRodl: Boolean read write

---

Allows to get/set Service Groups

property ServiceGroup: string read write

---

Provides direct access to the underlying Indy SMTP client implementation. You can use this property to control advanced settings on the Indy SMTP object, such as setting authentication options. The concrete set of properties available in this object depends on the Indy version in use.

property SmtpClient: TIdSMTP read write

---

Sets the address of the SMTP server that will be used to dispatch outgoing messages. This can be a host name or an IP address, and can be any SMTP server capable of relaying mails to the destination, including an open relay or the ISP's email server.
The SmtpClient property can be used to control advanced options such as authentication.

property SmtpServerAddress: string read write

---

Fires the OnReadFromStream event

procedure TriggerReadFromStream(aSource: TStream)

Parameters:

• aSource: stream

---

Fires the OnReadFromStream event

procedure TriggerWriteToStream(aDest: TStream)

Parameters:

• aDest: stream

 

Toggles whether the server ready to receive requests from clients. Depending on the server type, changing this property might open/close a network socket or otherwise toggle whether the server will process incoming requests.

property Active: Boolean read write

---

Holds the message that will be sent back to the client if it improperly "welcomes" the server.

property DefaultResponse: string read write

---

Specifies how incoming requests will be processed and dispatched. Depending on the server type, one or multiple dispatchers can be configured to receive messages from the client. Each dispatcher consists of a Message and an optional Name. Also, each dispatcher can be individually enabled or disabled. Each server must have at least one dispatcher configured, in order to be able to process messages.

=Essential Sub-Properties=

• Message specifies the message format to be used for this dispatcher.
• Name specifies the name, or possibly the URL for the dispatcher.

In HTTP based servers (such as the TROIndyHTTPServer, the Name will be appended as folder to the server URL allowing the server to make multiple dispatchers available at different URLs.

property Dispatchers: TROMessageDispatchers read write

---

This is DES based enscryption, it is obsolete because works only for Delphi. Use message envelope AES Encryption Envelope instead.

property Encryption: TROEncryption read write

---

The server will check the POP3 account for new incoming requests with this interval (in seconds). The default value is 60 seconds.

property Pop3CheckInterval: Integer read write

---

Provides direct access to the underlying Indy POP3 Client implementation. You can use this property to control advanced settings on the Indy POP3 object, such as setting authentication options. The concrete set of properties available in this object depends on the Indy version in use.
The SmtpClient property can be used to control advanced options.

property Pop3Client: TIdPOP3 read write

---

Password to be used to authenticate with the POP3 server.

property Pop3Password: string read write

---

Defines the address of the POP3 server that will be used to collect incoming request emails. This can be a host name or IP address, and should point to the POP3 server where email specified in ServerEmail will be delivered.

property Pop3ServerAddress: string read write

---

Specifies the login name to be used to authenticate with the POP3 server.

property Pop3Username: string read write

---

The network socket where the server will be listening

property Port: Integer read write

---

Specifies the email address of the server. This address will be used by the client to deliver emails to this server, and it will also be placed in the "From:" field of sent emails. This email address should match the POP3 account configured for the server, so that the server will be able to access requests directed at it.

property ServerEmail: string read write

---

Specifies whether the server will make the contained RODL file available to clients (true, default) or not. Keep this property set to true if clients need to access the RODL (or WSDL), for example so that third parties (including Service Tester) can import services. Set it to false if you do not want to provide this information, for example for security reasons.

property ServeRodl: Boolean read write

---

Allows to get/set Service Groups

property ServiceGroup: string read write

---

Provides direct access to the underlying Indy SMTP client implementation. You can use this property to control advanced settings on the Indy SMTP object, such as setting authentication options. The concrete set of properties available in this object depends on the Indy version in use.

property SmtpClient: TIdSMTP read write

---

Sets the address of the SMTP server that will be used to dispatch outgoing messages. This can be a host name or an IP address, and can be any SMTP server capable of relaying mails to the destination, including an open relay or the ISP's email server.
The SmtpClient property can be used to control advanced options such as authentication.

property SmtpServerAddress: string read write

 

Standard component constructor

constructor Create(aOwner: TComponent)

Parameters:

• aOwner: Owner

---

Copies the contents of another, similar object.

procedure Assign(Source: TPersistent)

Parameters:

• Source: Instance whose properties will be copied

---

Validates the server properties.

procedure CheckProperties

---

Decrypt stream

procedure DecryptStream(const Source: TStream; const Dest: TStream)

Parameters:

• Source: Source
• Dest: Destination

---

Decrypt stream

procedure DecryptStream(const Stream: TStream)

Parameters:

• Stream: Stream

---

function DispatchMessage(const aTransport: IROTransport; aRequestStream: TStream; aResponseStream: TStream): Boolean

Parameters:

• aTransport:
• aRequestStream:
• aResponseStream:

---

function DispatchMessage(const aTransport: IROTransport; aRequestStream: TStream; aResponseStream: TStream; out oResponseOptions: TROResponseOptions): Boolean

Parameters:

• aTransport:
• aRequestStream:
• aResponseStream:
• oResponseOptions:

---

procedure DoBeforeDecryptEvent(aEncryptedStream: TStream)

Parameters:

• aEncryptedStream: Stream

---

Encrypt stream

procedure EncryptStream(const Source: TStream; const Dest: TStream)

Parameters:

• Source: Source
• Dest: Destination

---

Encrypt stream

procedure EncryptStream(const Stream: TStream)

Parameters:

• Stream: Stream

---

Returns TROMessageDispatchers class

function GetDispatchersClass: TROMessageDispatchersClass

---

function GetRODLReader: TROCustomRODLReader

---

Returns SSL state

function GetSecure: Boolean

---

Returns current server type

function GetServerType: TROServerType

---

function GetServiceMetaData(aServiceName: string; aOptions: string; out aContentType: string): TStream

Parameters:

• aServiceName:
• aOptions:
• aContentType:

---

Returns itself.

function GetTransportObject: TObject

---

function IntDispatchMessage(Dispatcher: TROMessageDispatcher; const aTransport: IROTransport; aRequestStream: TStream; aResponseStream: TStream; out oResponseOptions: TROResponseOptions): Boolean

Parameters:

• Dispatcher:
• aTransport:
• aRequestStream:
• aResponseStream:
• oResponseOptions:

---

Checks if encryption was used

function IsEncryptionUsed: Boolean

---

function IsServiceAllowed(Value: string): Boolean

Parameters:

• Value:

---

Checks state of stream

function IsStreamEncrypted(Source: TStream): Boolean

Parameters:

• Source: Stream

---

Forwards notification messages to all owned components.

procedure Notification(AComponent: TComponent; Operation: TOperation)

Parameters:

• AComponent: component
• Operation: operation

---

Forwards notification messages to all owned components.

procedure ROFreeNotification(aComponent: TComponent)

Parameters:

• aComponent: component

---

Forwards notification messages to all owned components.

procedure RORemoveFreeNotification(aComponent: TComponent)

Parameters:

• aComponent: component

---

Forwards notification messages to all owned components.

procedure SendRemoveNotification(aComponent: TComponent)

Parameters:

• aComponent: component

---

Fires the OnReadFromStream event

procedure TriggerReadFromStream(aSource: TStream)

Parameters:

• aSource: stream

---

Fires the OnReadFromStream event

procedure TriggerWriteToStream(aDest: TStream)

Parameters:

• aDest: stream

 

Fired after stream was encrypted

property OnAfterEncrypt: TROBaseConnectionOperation read write
delegate:  procedure OnAfterEncrypt(Sender: TROBaseConnection; aEncryptedStream: TStream)

---

Fires after the server has been activated.

property OnAfterServerActivate: TNotifyEvent read write

---

Fires after the server has been deactivated. You can use this event handler to perform any cleanup you might need after the server has stopped processing new requests.

property OnAfterServerDeactivate: TNotifyEvent read write

---

Fired before stream will be decrypted

property OnBeforeDecrypt: TROBaseConnectionOperation read write
delegate:  procedure OnBeforeDecrypt(Sender: TROBaseConnection; aEncryptedStream: TStream)

---

Fires just before the server is activated. You can use this event handler to perform any initialization you might need before the server starts processing new requests.

property OnBeforeServerActivate: TNotifyEvent read write

---

Fires just before the server is deactivated. You can use this event handler to perform any cleanup you might need before the server stops processing new requests.

property OnBeforeServerDeactivate: TNotifyEvent read write

---

This event is fired if an exception was raised in the worker thread. Users can handle it and respond to those exceptions.

Because polling the account happens in a worker thread, any problems encountered during polling (such as failed authentication with the POP3 server) will not bubble up to the main application. It is therefore important to handle this event if you want to be informed of error conditions.

property OnException: TROExceptionEvent read write
delegate:  procedure OnException(aSender: TObject; aExceptionClass: TClass; const aExceptionMessage: string)

---

property OnGetRODLReader: TROGetRODLReader read write
delegate:  procedure OnGetRODLReader(Sender: TROServer; var aRODLReader: TROCustomRODLReader)

---

Fires after a stream with a request message has been received from the client. The event handler can inspect and possibly modify the stream, before it continues to be processed by the higher levels of the Remoting SDK framework.

property OnReadFromStream: TStreamOperation read write
delegate:  procedure OnReadFromStream(aStream: TStream)

---

Fires just before a stream with a response message is sent back to the client. The event handler can inspect and possibly modify the stream, before it continues to be sent off to the client.

property OnWriteToStream: TStreamOperation read write
delegate:  procedure OnWriteToStream(aStream: TStream)