ipworksssl
Class PopsTransferEvent

java.lang.Object
  java.util.EventObject
      ipworksssl.PopsTransferEvent

All Implemented Interfaces:

java.io.Serializable

public class PopsTransferEvent
extends java.util.EventObject

Fired while the message gets transferred from MailServer .

The Text parameter contains the portion of the message 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. For complete lines, there is no terminating newline at the end of the Text parameter, and EOL is True. The EOL parameter is False when a line is broken (usually for being too long).

A faster way to retrieve a message is to assign a value to the LocalFile property and use the Transfer event 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. If PercentDone can not be calculated the value will be -1.

Note that events are not re-entrant. Performing time consuming operations within this event will prevent it from firing again in a timely manner and may impact overall performance.

NOTE: For the PercentDone parameter value to be correct, the {@link ipworksssl.Pops#config must be set to true.

See Also:

Pops, Pops.TransferEvent, Serialized Form

Field Summary

long	bytesTransferred
int	direction
boolean	EOL
int	percentDone
byte[]	text

Fields inherited from class java.util.EventObject

source

Method Summary

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 byte[] text

EOL

public boolean EOL