EndByte Property
The byte index of the position where the transfer should end.
Syntax
pimap.getEndByte([callback]) pimap.setEndByte( endByte, [callback])
Default Value
0
Callback
The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).
The callback for the getEndByte([callback]) method is defined as:
function(err, data){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'data' is the value returned by the method.
The callback for the setEndByte([callback]) method is defined as:
function(err){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'err' has 2 properties which hold detailed information:
err.code err.message
Remarks
StartByte and EndByte are used together with the FetchMessagePart method to specify the portion of the message part to be retrieved from the server.
When StartByte or EndByte contain values other than the defaults (0), only the corresponding portion of the message part is retrieved from the server.
Byte indexes start from 1. The default value for EndByte is 0, which corresponds to the end of the message.
This property is not available at design time.
Data Type
Long64