Class wwPop3 (deprecated)

Unsupported

We no longer support this class as it's old and dated. This class was never meant to be a full featured POP3 client but rather as a server support class to help with validating email confirmations. It continues to work for basic scenarios, but please don't use it for sophisticated mail processing or email integrations.

The wwPOP3 class can be used to read email from POP3 mail boxes.

This class works only with plain text logins. If your mailbox requires encrypted logins this class will not work.

wwPOP3.prg is an example of using the wwSocket class to do low level socket access to interact with a server application.

Class Members

MemberDescription

Connect

Connects to the POP server and logs in and sets the message nMessageCount of the mail box.

o.Connect()

DeleteMessage

Deletes a message by message number or full message id.

o.DeleteMessage(lvMessage)

GetMessage

Retrieves a message from the POP3 mailbox.

o.GetMessage(lvMessage)

GetMessageHeader

Retrieves a message from the mail server without retrieving the body. Returns a message object minus the cBody property.

o.GetMessageHeader(lnMessage)

GetMessages

High level method that retrieves all the messages on the POP3 server into the internal aMessages array.

o.GetMessages(llNoParseAttachments,llDeleteMessages)

ParseMultiPartMessage

Parses the cBody property of a message and creates an array of attachments.

o.ParseMultiPartMessage(loMsg)

Quit

Shuts down the POP3 session. This method is automatically called from the Destroy method, so generally you don't have to call this explicitly.

o.Quit()

aMessages

Array that holds messages retrieved with GetMessages().

cErrorMsg

Error message property set when an error occurs.

cMailServer

IP address or domain of the mail server that hosts the POP3 box.

cPassword

Password to access the POP3 account.

cUsername

Username to access the POP3 mailbox.

lError

Error flag set when an error occurs.

lLogSession

When .T. the POP3 session is logged and you can retrieve it with loPop.oIP.GetLog(), which returns all the client and server communication.

nError

Error number value - not used at this time.

nMessageCount

Holds the number of messages that are in the mail box. This value is set by the Connect() method.

nPort

Port to connect on. Default: 110 (standard POP3 port)

oIP

The wwSocket object that's used to access the mail server. This object is passed through so you can access the TCP session logging features, but also allows you straight socket access.


© West Wind Technologies, 1996-2019 • Updated: 07/13/17
Comment or report problem with topic