CSmtp Class

Provide a class for Internet Protocol SMTP.

Inheritance Hierarchy

Object
CMailAbstract
CSmtp

Namespace: VO
Assembly: VOInternetClasses (in VOInternetClasses.dll) Version: 2.21

Syntax

Copy

 CLASS CSmtp INHERIT CMailAbstract

public class CSmtp : CMailAbstract

Request Example View Source

The CSmtp type exposes the following members.

Constructors

	Name	Description
	CSmtp	Construct a CSmtp object.

Top

Properties

	Name	Description
	DomainName	Missing documentation (Inherited from CMailAbstract.)
	Email	An instance of the CEmail class.
	EmailFormat	The format of the email.
	Error	Numeric value representing the last occurring error code. (Inherited from CMailAbstract.)
	ErrorMsg	A string representing the error description. (Inherited from CMailAbstract.)
	MailApplication	A string that holds the name that is used when connection to mail servers
	PassWord	A string representing the password to be used. (Inherited from CMailAbstract.)
	RemoteHost	String representing the address of the mail server. (Inherited from CMailAbstract.)
	RemotePort	Numeric value representing the port number. (Inherited from CMailAbstract.)
	ReplyCode	Numeric value representing the server's reply code. (Inherited from CMailAbstract.)
	ReplyString	String representing the server's reply. (Inherited from CMailAbstract.)
	SecureSMTP	A logic indicating if the CSmtp class should use Secure SMTP
	TextEncoding	The text encoding type of the email.
	Timeout	Numeric value representing the time-out in milliseconds. (Inherited from CMailAbstract.)
	TimeoutRetries	Missing documentation (Inherited from CMailAbstract.)
	UserName	A string containing the user name to be used. (Inherited from CMailAbstract.)

Top

Methods

	Name	Description
	CheckReply	Check the response from a mail server for error codes.
	Close	De-initialize all internal values of an Internet session. (Inherited from CMailAbstract.)
	connect	Establish a connection to a remote SMTP server.
	Destroy	Missing documentation (Inherited from CMailAbstract.)
	Disconnect	Shut down the current SMTP connection.
	InternetStatus	Missing documentation (Inherited from CMailAbstract.)
	Logon	Logs on to the remote host with the user name and password of the smtp class
	Open	Initialize all internal startup values for an Internet session. (Inherited from CMailAbstract.)
	RecvRemote	Receive response data from a remote mail server. (Overrides RecvRemote.)
	SendData	Send data to a remote host. (Inherited from CMailAbstract.)
	SendHeaderInfo	Create a mail header and send it as part of an e-mail to a remote SMTP server.
	SendMail	Send a complete e-mail to a remote SMTP server.
	SendRaw	Missing documentation (Inherited from CMailAbstract.)
	SendRemote	Send any data to a remote host. (Inherited from CMailAbstract.)

Top

Fields

	Name	Description
	oSocket	(Inherited from CMailAbstract.)

Top

Remarks

This class provides all necessary methods and properties for sending e-mail to a Simple Message Transfer Protocol (SMTP) server.

Examples

Copy

 1FUNCTION SMTPSendMail       (cServerIP      AS STRING,;
 2     cMailSubject   AS STRING,;
 3     xDestUser      AS USUAL,;
 4     xCCUser        AS USUAL,;
 5     cBody          AS STRING,;
 6     cFromAddress   AS STRING,;
 7     xAttachFile    AS USUAL,;
 8     cFromName      AS STRING,;
 9     xBCCUser       AS USUAL,;
10     cCargo         AS STRING)   AS LOGIC PASCAL
11  LOCAL oSmtp    AS CSMTP
12  LOCAL lRet     AS LOGIC
13  LOCAL oEmail   AS CEmail
14  oEMail := CEmail{}
15  oEmail:FromAddress   := cFromAddress
16  oEmail:FromName      := cFromName
17  oEmail:Cargo         := cCargo
18  oEmail:Subject       := cMailSubject
19  oEmail:DestList      := xDestUser
20  oEmail:CCList        := xCCUser
21  oEmail:BCCList       := xBCCUser
22  oEmail:MailBody        := cBody
23  IF !IsNil(xAttachFile)
24     oEmail:AttachmentFileList := xAttachFile
25  ENDIF
26  oSmtp := CSmtp{oEmail}
27  oSMtp:RemoteHost  := cServerIP
28  oSmtp:TimeOut := 5000
29  lRet := oSmtp:SendMail()
30  RETURN lRet

Reference

VO Namespace