|
IP*Works! V9 | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.util.EventObject
ipworks.PopTransferEvent
public class PopTransferEvent
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: For the PercentDone parameter value to
be correct, the GetMessageSize
must
be set to true.
Pop
,
Pop.TransferEvent
,
Serialized FormField 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 |
---|
public int direction
public long bytesTransferred
public int percentDone
public byte[] text
public boolean EOL
|
IP*Works! V9 | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |