mimeEntityGetDepth

 

SYNOPSIS

int mimeEntityGetDepth(mimeEntity entityOrReader)

Parameters:

  • entityOrReader - A mimeEntity or mimeReader object

Returns:

  • int depth of the entity from root


DESCRIPTION
The mimeEntityGetDepth function returns the integer depth of the entity, in levels from the root entity of the message. Thus a plain RFC 822 message (single entity) is depth 0, as is the top-level preamble of a multipart message.


EXAMPLE

<$ret = (mimeEntityGetDepth($reader))>


CAVEATS

SEE ALSO
mimeEntityGetChildNumber


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