w3JMail Reference

Reference 4.5

 JMail.POP3
    Count : Integer
    Log : String
    Logging : Boolean
    Messages : Pointer
    Size : Integer
    Connect( Username, Password, Server, Port ) : 
    DeleteMessages( ) : 
    DeleteSingleMessage( MessageID ) : 
    Disconnect( ) : 
    DownloadHeaders( ) : 
    DownloadMessages( ) : 
    DownloadSingleHeader( MessageID ) : 
    DownloadUnreadMessages( ) : 
    GetLastUnreadMessage( ) : Integer
    GetMessageUID( MessageID ) : String


Properties

  Count() : 
Returns the number of messages on the POP3 server.
'i = mailbox.Count'
  Log() : 
This is the log created by w3 JMail when logging is set to TRUE.
'Response.Write( mailbox.Log )'
  Logging() : 
Enables/Disables logging in w3 JMail. Default value is FALSE.
'mailbox.Logging = true'
  Messages() : 
Returns the Messages object through which you can access the messages.
'set messages = mailbox.Messages'
  Size() : 
Returns the total size of your mailbox in bytes.
'size = mailbox.Size'

Methods

  Connect(Username, Password, Server, Port) : 
Opens the connection to the POP3 server. The Port argument is optional and defaults to 110.
'mailbox.Connect "john", "qwerty", "mail.myDomain.com"'
  DeleteMessages() : 
Deletes all messages from the mail server.
'Mailbox.DeleteMessages'
  DeleteSingleMessage(MessageID) : 
Deletes a single message on the mail server.
'Mailbox.DeleteSingleMessage 1'
  Disconnect() : 
Closes the connection to the server.
'mailbox.Disconnect'
  DownloadHeaders() : 
Downloads all headers and adds them to the Messages collection.
'Mailbox.DownloadHeaders'
  DownloadMessages() : 
Downloads all messages.
'Mailbox.DownloadMessages'
  DownloadSingleHeader(MessageID) : 
Downloads the headers of a single message and adds them to the Messages collection.
'Mailbox.DownloadSingleHeader 1'
  DownloadUnreadMessages() : 
Downloads all unread (messages that have not been downloaded by ANY clientsoftware) e-mails. The e-mails are added to the messages collection. Note this command has been removed from the POP3 specification (RFC1725), so it may not be supported by all mail servers.
'Mailbox.DownloadUnreadMessages'
  GetLastUnreadMessage() : 
Returns the ID of the first unread (message that has not been downloaded by ANY client software) message. Return 0 if no messages have been accessed, -1 if this command is not supported by the server. Note this command has been removed from the POP3 specification (RFC1725), so it may not be supported by all mail servers.
'lastMessage = Mailbox.GetLastUnreadMessage'
  GetMessageUID(MessageID) : 
Returns the serverīs unique id for this message.
'Mailbox.GetMessageUID 1'


Dimac w3 JMail is composed of several objects. The most important one is the Message object. You will best get acquainted with them, by reading the examples provided. If you are running the old version of w3 JMail (3.7), you can find the reference in the menu to the left.