mimeReaderGetFullEntity

SYNOPSIS

mimeEntity mimeReaderGetFullEntity(mimeReader reader)

Parameters:

• reader - A mimeReader object

Returns:

• mimeEntity object for entire entity tree at cursor

DESCRIPTION
The mimeReaderGetFullEntity function returns the mimeEntity object for the full entity tree at the reader's cursor. This object can be saved for future reference after the reader has moved on to other entities. Unlike the value returned by mimeReaderGetEntity (here), this entity holds the entire entity tree at the reader's location - regardless of max depth for the reader - not just the "node" atomic entity. Thus it can be used to open a new reader to parse just that sub-tree of the message.

EXAMPLE

<$entity = (mimeReaderGetFullEntity($reader))>
  <$newReader = (mimeReaderOpenEntity($entity, -1,
                                      "inherittreeposition"))>

SEE ALSO
mimeReaderGetEntity, mimeReaderOpenEntity