POP3 Class Reference

Inheritance diagram for POP3:

Collaboration diagram for POP3:

Public Member Functions
_.Library.Status	Connect (_.Library.String PopServer, _.Library.String UserName, _.Library.String Password, _.Library.String AccessToken)
_.Library.Status	ConnectPort (_.Library.String PopServer, _.Library.Integer PopPort, _.Library.String UserName, _.Library.String Password, _.Library.String AccessToken)
_.Library.Status	DeleteMessage (_.Library.Integer MessageNumber)
_.Library.Status	Fetch (_.Library.Integer MessageNumber, _.Net.MailMessage MailMsg, _.Library.Boolean Delete, _.Library.BinaryStream messageStream)
_.Library.Status	FetchFromStream (_.Library.BinaryStream messageStream, _.Net.MailMessage MailMsg)
_.Library.Status	FetchMessage (_.Library.Integer MessageNumber, _.Library.String From, _.Library.String To, _.Library.String Date, _.Library.String Subject, _.Library.Integer MessageSize, _.Library.ArrayOfDataTypes MsgHeaders, _.Net.MailMessage MailMsg, _.Library.Boolean Delete)
_.Library.Status	FetchMessageHeaders (_.Library.Integer MessageNumber, _.Library.String MsgHeadersArray)
_.Library.Status	FetchMessageInfo (_.Library.Integer MessageNumber, _.Library.Integer Lines, _.Library.String From, _.Library.String To, _.Library.String Date, _.Library.String Subject, _.Library.Integer MessageSize, _.Library.ArrayOfDataTypes MsgHeaders, _.Library.String MessageText)
_.Library.Status	GetAttachedEmail (_.Net.MailMessagePart msgpart, _.Net.MailMessage mailmsg)
	Convert the text of an attached email (Content-Type: message/rfc822) to a Net.mailMessage.
_.Library.Status	GetMailBoxStatus (_.Library.Integer NumberOfMessages, _.Library.Integer NumberOfBytes)
_.Library.Status	GetMessageUID (_.Library.Integer MessageNumber, _.Library.String UniqueID)
_.Library.Status	GetMessageUIDArray (_.Library.String MessageNumber, _.Library.ArrayOfDataTypes ListOfUniqueIDs)
_.Library.Status	GetSizeOfMessages (_.Library.String MessageNumber, _.Library.ArrayOfDataTypes ListOfSizes)
_.Library.Status	Ping ()
_.Library.Status	QuitAndCommit ()
_.Library.Status	QuitAndRollback ()
_.Library.Status	RollbackDeletes ()
Public Member Functions inherited from FetchMailProtocol
_.Library.Status	Connect (_.Library.String PopServer, _.Library.String UserName, _.Library.String Password)
Public Member Functions inherited from RegisteredObject
_.Library.Status	OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
	This callback method is invoked when the current object is added to the SaveSet,. More...
_.Library.Status	OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
	This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...
_.Library.Status	OnNew ()
	This callback method is invoked by the <METHOD>New</METHOD> method to. More...
_.Library.Status	OnValidateObject ()
	This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...

Public Attributes
	IgnoreInvalidBase64Chars
	If IgnoreInvalidBase64Chars is true, then unexpected characters will be ignored during base64 decoding. More...
	SSLCheckServerIdentity
	When making an SSL connection check the server identity in the server certificate matches the name of the system we are connecting to. More...
	SSLConfiguration
	The name of the activated TLS/SSL configuration to use for pop3s requests. More...
	UseSTARTTLS
	If true then the STARTTLS extension to POP3 (RFC 2595) should be used to authenticate. More...
	port
	The port of the POP3 server, the default is 110 for plain text and 995 for SSL. More...
	timeout
	The read timeout in seconds to use when communicating with the POP3 server. More...
Public Attributes inherited from FetchMailProtocol
	AttachDir
	When receiving messages using POP3, the directory where attached files will be stored. More...
	Connected
	More...
	Debug
	More...
	StoreAttachToFile
	We always store attachments as a part in the message. More...
	StoreInlineToFile
	We always store attachments as a part in the message. More...

Private Member Functions
_.Library.Status	OnClose ()
	Cleanup the temp global used to store the message.

Additional Inherited Members
Static Public Attributes inherited from RegisteredObject
	CAPTION = None
	Optional name used by the Form Wizard for a class when generating forms. More...
	JAVATYPE = None
	The Java type to be used when exported.
	PROPERTYVALIDATION = None
	This parameter controls the default validation behavior for the object. More...

Detailed Description

For information on using this class, see Sending and Receiving Email.

Implements <CLASS>Net.FetchMailProtocol</CLASS>

Member Function Documentation

Connect()

_.Library.Status Connect	(	_.Library.String	PopServer,
		_.Library.String	UserName,
		_.Library.String	Password,
		_.Library.String	AccessToken
	)

see <CLASS>Net.FetchMailProtocol</CLASS> <METHOD>Connect</METHOD>

ConnectPort()

_.Library.Status ConnectPort	(	_.Library.String	PopServer,
		_.Library.Integer	PopPort,
		_.Library.String	UserName,
		_.Library.String	Password,
		_.Library.String	AccessToken
	)

see <CLASS>Net.FetchMailProtocol</CLASS> <METHOD>Connect</METHOD>

DeleteMessage()

_.Library.Status DeleteMessage

(

_.Library.Integer

MessageNumber

)

see <CLASS>Net.FetchMailProtocol</CLASS> <METHOD>DeleteMessage</METHOD>

Reimplemented from FetchMailProtocol.

Fetch()

_.Library.Status Fetch	(	_.Library.Integer	MessageNumber,
		_.Net.MailMessage	MailMsg,
		_.Library.Boolean	Delete,
		_.Library.BinaryStream	messageStream
	)

see <CLASS>Net.FetchMailProtocol</CLASS> <METHOD>Fetch</METHOD>

Reimplemented from FetchMailProtocol.

FetchFromStream()

_.Library.Status FetchFromStream	(	_.Library.BinaryStream	messageStream,
		_.Net.MailMessage	MailMsg
	)

see <CLASS>Net.FetchMailProtocol</CLASS> <METHOD>FetchFromStream</METHOD>

Reimplemented from FetchMailProtocol.

FetchMessage()

_.Library.Status FetchMessage	(	_.Library.Integer	MessageNumber,
		_.Library.String	From,
		_.Library.String	To,
		_.Library.String	Date,
		_.Library.String	Subject,
		_.Library.Integer	MessageSize,
		_.Library.ArrayOfDataTypes	MsgHeaders,
		_.Net.MailMessage	MailMsg,
		_.Library.Boolean	Delete
	)

see <CLASS>Net.FetchMailProtocol</CLASS> <METHOD>FetchMessage</METHOD>

Reimplemented from FetchMailProtocol.

FetchMessageHeaders()

_.Library.Status FetchMessageHeaders	(	_.Library.Integer	MessageNumber,
		_.Library.String	MsgHeadersArray
	)

see <CLASS>Net.FetchMailProtocol</CLASS> <METHOD>FetchMessageHeaders</METHOD>

FetchMessageInfo()

_.Library.Status FetchMessageInfo	(	_.Library.Integer	MessageNumber,
		_.Library.Integer	Lines,
		_.Library.String	From,
		_.Library.String	To,
		_.Library.String	Date,
		_.Library.String	Subject,
		_.Library.Integer	MessageSize,
		_.Library.ArrayOfDataTypes	MsgHeaders,
		_.Library.String	MessageText
	)

This method retrieves a single message. MessageNumber must be a

valid message number and the message must not be currently marked for deletion.

An upper bound is put on number of lines of message text retrieved by Lines.

The text of the retrieved message is returned in the MessageText argument as a String.

FetchMessageInfo is typically used to get From, Date, and other header information without actually getting the message text. This allows one to filter out messages from parties one wishes to exclude or to zero in on messages one particularly wants. Since getting message text is something that can happen over a slow modem, this is a desirable feature.

Reimplemented from FetchMailProtocol.

GetMailBoxStatus()

_.Library.Status GetMailBoxStatus	(	_.Library.Integer	NumberOfMessages,
		_.Library.Integer	NumberOfBytes
	)

see <CLASS>Net.FetchMailProtocol</CLASS> <METHOD>GetMailBoxStatus</METHOD>

Reimplemented from FetchMailProtocol.

GetMessageUID()

_.Library.Status GetMessageUID	(	_.Library.Integer	MessageNumber,
		_.Library.String	UniqueID
	)

see <CLASS>Net.FetchMailProtocol</CLASS> <METHOD>GetMessageUID</METHOD>

Reimplemented from FetchMailProtocol.

GetMessageUIDArray()

_.Library.Status GetMessageUIDArray	(	_.Library.String	MessageNumber,
		_.Library.ArrayOfDataTypes	ListOfUniqueIDs
	)

see <CLASS>Net.FetchMailProtocol</CLASS> <METHOD>GetMessageUIDArray</METHOD>

Reimplemented from FetchMailProtocol.

GetSizeOfMessages()

_.Library.Status GetSizeOfMessages	(	_.Library.String	MessageNumber,
		_.Library.ArrayOfDataTypes	ListOfSizes
	)

see <CLASS>Net.FetchMailProtocol</CLASS> <METHOD>GetSizeOfMessages</METHOD>

Reimplemented from FetchMailProtocol.

Ping()

_.Library.Status Ping

(

)

see <CLASS>Net.FetchMailProtocol</CLASS> <METHOD>Ping</METHOD>

Reimplemented from FetchMailProtocol.

QuitAndCommit()

_.Library.Status QuitAndCommit

(

)

see <CLASS>Net.FetchMailProtocol</CLASS> <METHOD>QuitAndCommit</METHOD>

Reimplemented from FetchMailProtocol.

QuitAndRollback()

_.Library.Status QuitAndRollback

(

)

see <CLASS>Net.FetchMailProtocol</CLASS> <METHOD>QuitAndRollback</METHOD>

Reimplemented from FetchMailProtocol.

RollbackDeletes()

_.Library.Status RollbackDeletes

(

)

see <CLASS>Net.FetchMailProtocol</CLASS> <METHOD>RollbackDeletes</METHOD>

Reimplemented from FetchMailProtocol.

Member Data Documentation

IgnoreInvalidBase64Chars

IgnoreInvalidBase64Chars

If IgnoreInvalidBase64Chars is true, then unexpected characters will be ignored during base64 decoding.

RFC 2045 is ambiguous about whether unexpected characters should be ignored or result in an error during base64 decoding. The default is false.  

SSLCheckServerIdentity

SSLCheckServerIdentity

When making an SSL connection check the server identity in the server certificate matches the name of the system we are connecting to.

This defaults to being on and matches based on the rules layed out in section 3.1 of RFC 2818.  

SSLConfiguration

SSLConfiguration

The name of the activated TLS/SSL configuration to use for pop3s requests.

 

UseSTARTTLS

UseSTARTTLS

If true then the STARTTLS extension to POP3 (RFC 2595) should be used to authenticate.

to the POP3 server on the normal POP3 port. The SSLConfiguration must be specified.  

port

port

The port of the POP3 server, the default is 110 for plain text and 995 for SSL.

 

timeout

timeout

The read timeout in seconds to use when communicating with the POP3 server.