Terrasite.com - World Leader in Windows Web Hosting

Overview

AspPOP3 allows you to receive mail using the industry standard POP3 protocol from any program that can use ActiveX/OLE components.
Features include:

POP3 (retrieve) Messages
Multiple File Attachments
File attachments support MIME and UUEncoding
US Ascii and ISO-8859-1 character sets
Exposes standard headers via properties and special properties via a method.

User Manual

AspPOP3 Properties

AttContentType	Contains the ContentType for a message attachment after you call Mailer.GetAttachmentInfo. Example: if Mailer.GetAttachmentInfo (intCount) then Response.Write "ContentType=" & Mailer.AttContentType
AttFileName	Contains the FileName for a message attachment after you call Mailer.GetAttachmentInfo. Example: if Mailer.GetAttachmentInfo (intCount) then Response.Write "FileName=" & Mailer.AttFileName
AttFileSize	Contains the FileSize for a message attachment after you call Mailer.GetAttachmentInfo. Example: if Mailer.GetAttachmentInfo (intCount) then Response.Write "File Size=" & Mailer.AttFileSize
AttachmentCount	After you have retrieved a message the AttachmentCount property contains the number of attachments that were found within the message. Example: Mailer.Retrieve intMsgNumber Response.Write "This message has " & _ Mailer.AttachmentCount & " attachments"
BodyText	After you have retrieved a message the BodyText property contains the message text. This does not include header information which is accessed via other properties and one method. Example: Mailer.Retrieve intMsgNumber Response.Write "This message is " & _ Mailer.BodyText
CC	The CC property contains any CarbonCopy addresses the message was sent to.
Error	The Error property returns any error message if a failure is detected by the component.
Encoding	The encoding type used for the message. Valid values: 1 = UUEncoded 2 = MIME Example: If Mailer.Encoding = 1 then Response.Write "UUEncoded"
Expires	If the component is an eval version the expires property will return the date that the component quits functioning. Example: Response.Write "Component Expires: " & Mailer.Expires
FromAddress	The message originator’s email address. Example: Response.Write "From " & Mailer.FromAddress
FromName	The message originator’s name. Example: Response.Write "From " & Mailer.FromName
MailDirectory	The MailDirectory property specifies where mail messages will be written to.
MessageCount	The MessageCount property indicates how many messages are located on the server. This property is updated when the GetPopHeaders method is called or when MessageCount is 0. Example: if Mailer.MessageCount = 0 then Response.Write "There are no messages on the server." end if
MessageID	The MessageID property returns the MessageID header for the Retrieved message.
MessageInfo	The MessageInfo property returns the header data that is received from a call to GetPopHeaders. After a call to GetPopHeaders, and if there are messages on the server, this property is a variant array of variant arrays that contains information about the messages on the server. Values returned are: intMessageID, strSubject, strDate, strFrom, strSender ,strTo, strReplyTo, intSize, strStatus.
Password	Password is the password of the account on the POP3 server that you will be retrieving messages for. This is used along with UserName to log into the POP server.
Pop3Log	You can debug a POP3 session by assigning a path and filename to the POP3Log property. The complete POP3 session will be written to this file. Be sure the logged in user under IIS has permission to write to this file. Do NOT use this in a multi-user environment. This is only for debugging.
Priority	Gets the message priority. Priorities are 1-5 and are reflected in the X-Priority header. Valid values: 1 – High 3 – Normal 5 – Low Example: if Mailer.Priority = 1 then Response.Write "This message is high priority" end if
Recipients	The Recipients property contains any To: addresses the message was sent to.
RemoteHost	RemoteHost property should be set to the host name or IP address of the POP3 server you will be pulling messages from.
ReturnReceipt	The ReturnReceipt flag. Example: If Mailer.ReturnReceipt then rem User expected return receipt on this message end if
Subject	The Subject property returns the Subject of the message that you have retrieved.
TimeOut	Sets the maximum time to wait for a response from the POP3 server.
UserName	UserName is the user name of the account on the POP3 server that you will be retrieving messages for. This is used along with Password to log into the POP server.
Version	Returns the version of the Pop3 component.

AspPOP3 Component Methods

Method	Parameters	Return Value	Description
ClosePop3	None	N/A	Quits the current POP3 session and closes the connection.
Delete	Integer value indicating which message on the server to delete.	True/False	Permanently deletes the specified message from the server.
EraseFile	String value indicating full path to file you want to erase.	True/False	Permanently deletes a file from the local drive. This is used to clean up messages that are written to disk using the RetrieveToFile method.
GetAttachmentInfo	Integer value indicating which message attachment you want to get the properties for.	N/A	GetAttachment Info will get the properties for the specified attachment and fill in the AttContentType, AttFileName and AttFileSize properties.
GetHeaderField	String value indicating which header field you want to return	String value with header field info.	GetHeaderField is provided so that you can query the current message for any specific header field information that isn't provided through AspPOP3 properties.
GetPopHeader	Integer value indicating the message number to retrieve the header for.	True or False	GetPopHeader allows you to retrieve the header information for one message instead of all messages. See GetPopHeaders to retrieve all message headers.
GetPopHeaders	None	True or False	GetPopHeaders provides a simple interface to retrieving information about each message on the server. This makes it easy to present a list of message info. The examples provided with AspPOP3, WebMail and WebMail2 provide good examples of how to use this method.
OpenPop3	None	True or False	The OpenPop3 method opens the connection to the POP3 RemoteHost using the UserName and Password properties.
Retrieve	Integer value indicating which message to retrieve from the POP3 server.	True or False	The Retrieve method will retrieve the entire message from the POP3 server including any attachments. Once you have used Retrieve to get a valid message the AspPOP3 properties are filled in with the appropriate values and any attachments are available using the attachment methods/properties.
RetrieveToFile	Integer value indicating which message and a string value indicating the filename to save to.	True or False	RetrieveToFile simply pulls the message without processing anything. The entire message including any attachments is saved to the file.
RetrieveToMemory	Integer value indicating which message to retrieve	strMsg - the unprocessed message in string format	Retrieves the specified message and returns the message in an unprocessed form.
SaveAttachment	intAttachment Integer value indicating which attachment to save.	True or False	SaveAttachment will save an attachment to the MailDirectory's path. SaveAttachment will attempt to determine the proper file name before saving.
SaveAttachmentToFile	intAttachment, strFileName Integer value indicating which attachment to save and a pathless filename to save the attachment into.	True or False	SaveAttachment will save an attachment to the MailDirectory's path. SaveAttachmentToFile uses strFileName as the filename to save the message to.

Example

Set Mailer = Server.CreateObject("POP3svg.Mailer")
			Mailer.RemoteHost = "mailhost.localisp.net"
			Mailer.UserName   = "myname"
			Mailer.Password   = "mypassword"
			Mailer.MailDirectory = "d:\usermail\myname"
			Mailer.OpenPop3
			
			rem We could do multiple retrieves here but this demo only shows the
			rem  selected message.
			
			
			Mailer.MailDirectory = "d:\usermail\myname"
			Mailer.RetrieveToFile 1, "1.txt"
			Mailer.ClosePop3

The file d:\usermail\myname\1.txt now holds the complete message text for this message. You could optionally do the following:

Set Mailer = Server.CreateObject("POP3svg.Mailer")
			Mailer.RemoteHost = "mailhost.localisp.net"
			Mailer.UserName   = "myname"
			Mailer.Password   = "mypassword"
			Mailer.OpenPop3
			
			rem We could do multiple retrieves here but this demo only shows the
			rem  selected message.
			
			
			Mailer.Retrieve 1
			Mailer.ClosePop3

You can now use Mailer's properties to examine each part of the message. For example:

Mailer.MessageID
			Mailer.Date
			Mailer.Subject
			Mailer.FromName
			Mailer.FromAddress
			Mailer.BodyText