ipworks
Class ImapTransferEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--ipworks.ImapTransferEvent

All Implemented Interfaces:

java.io.Serializable

public class ImapTransferEvent

extends java.util.EventObject

Fired while the message gets transferred from the MailServer .

The Transfer event is fired for every incoming line when receiving a message or part data from the MailServer

The Text parameter contains the portion of the message or the part data being retrieved.

The BytesTransferred parameter contains the number of bytes transferred since the beginning of the message, including header bytes. At the end of transmission (i.e. when the last Transfer event is fired), BytesTransferred equals the value of the MessageSize property.

The Transfer event is fired for every line of the message. There is no terminating newline at the end of the Text parameter. A faster way to retrieve a message is to assign a value to the LocalFile property and use the Transfer event only to check the progress rather than to get the actual data.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The PercentDone parameter shows the progress of the transfer in the corresponding direction.

See Also:

Imap, Imap.TransferEvent, Serialized Form

Field Summary

long	bytesTransferred
int	direction
int	percentDone
java.lang.String	text

Fields inherited from class java.util.EventObject

source

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

direction

public int direction

bytesTransferred

public long bytesTransferred

percentDone

public int percentDone

text

public java.lang.String text