mimeReaderOpenEntity

 

SYNOPSIS

mimeReader mimeReaderOpenEntity(mimeEntity entityOrReader
                               [, int64 maxDepth[, varchar flags]])

Parameters:

  • entityOrReader - A mimeEntity or mimeReader object

  • maxDepth - An optional integer maximum depth to parse to

  • flags - An optional CSV list of flags:

    • "inherittreeposition" - Continue with same depth, IMAP number, etc. of parent entityOrReader

Returns:

  • mimeReader object


DESCRIPTION
The mimeReaderOpenEntity function returns a new mimeReader object for parsing the given entity entityOrReader. This function can be used when an entity tree within a message must be "broken off" and parsed by separate code that is to handle only that entity tree, independently.

The optional maxDepth parameter indicates how deep into the message tree to parse; the default of -1 indicates no limit, i.e. the tree is parsed to its leaf node entities. Entities at a depth greater than maxDepth would be embedded as part of an entity tree returned at the max depth.


EXAMPLE

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


SEE ALSO
mimeReaderOpenFile


Copyright © Thunderstone Software     Last updated: Sep 25 2019
Copyright © 2019 Thunderstone Software LLC. All rights reserved.