|
Summary
Specifies the number of octets to retrieve when fetching only a portion of the message data.
Description
When fetching message data the application may fetch a portion of the specified message section. In this case this property is used to specify the total number of octets to be retrieved. The
BodyStartOctet property is used to specify the first octet which is to be the starting point for retrieving this portion of the message section.
If the start octet specified is beyond the end of the text then an empty string will be returned. If used this property is set in the OnBodyAttributes event that occurs in response to calling the
Fetch or UidFetch method with the DataItems parameter containing IMAP_BODY OR IMAP_BODY_PEEK. If the application wants to retrieve the entire message the BodyNumOctets and BodyStartOctet properties
should be set to -1.
If used this property should be set at run time in the OnBodyAttributes event. The default value for this property is -1 which means that the entire message will be retrieved.
Example
Private Sub Imap_OnBodyAttributes()
'Set the body attributes to fetch
'In response to Fetch with IMAP_BODY OR IMAP_BODY_PEEK as a DataItem
Imap.BodyFlags = IMAP_ENTIRE_MESSAGE
Imap.BodyHeaderFields = ""
Imap.BodyPart = ""
'Sets the point from where to start retrieving the message
Imap.BodyStartOctet = -1024
'Tells the control how many bytes of the message it wants to receive starting from byte 1024
Imap.BodyNumOctets = -2048
' reset for next event
BodyFlag = 0
End Sub
| 
