|
Summary
Specifies the initial or encapsulated header fields to be retrieved.
Description
When fetching message data the application may want to retrieve specific header fields. This property can be used to specify the header fields to retrieve.
This property can be 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.
To retrieve only the specified fields from the initial header the BodyFlags property should be set to IMAP_HEADER_FIELDS or IMAP_HEADER_FIELDS_NOT. In this case the BodyHeaderFields
property must contain the name of the header fields that needs to be fetched or not to be fetched. The fields must be space separated, for example if the application wants to fetch only the "from"
and the "to" fields then the BodyHeaderFields property should contain "from to". If the application wants to retrieve the entire header then BodyFlags should be set to IMAP_HEADER and this property
should not be used.
Note that IMAP_HEADER, IMAP_HEADER_FIELDS_NOT, IMAP_HEADER_FIELDS should be used only to fetch the fields of the initial header or the encapsulated header of a message of type message/rfc822. To get
any portion of a multipart MIME message the application must use IMAP_MIME_PART_HEADER or IMAP_MIME_PART_BODY.
If used this property should be set at run time in the OnBodyAttributes event. There is no default value for this property.
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
If (not AttrDone) Then
Imap.BodyFlags = IMAP_HEADER_FIELDS
Imap.BodyHeaderFields = "From Subject"
AttrDone = True
Else
Imap.BodyFlags= 0
End If
End Sub
See Also
Body Flags property and Fetch method
| 
