mimeEntityGetSequenceNumber

 

SYNOPSIS

int mimeEntityGetSequenceNumber(mimeEntity entityOrReader)

Parameters:

  • entityOrReader - A mimeEntity or mimeReader object

Returns:

  • int sequence number for the entity


DESCRIPTION
The mimeEntityGetSequenceNumber function returns the sequence number for the entity. This is an ordinal integer number starting with zero and incrementing by one for each entity; it identifies the order of the entity within the overall message.


EXAMPLE

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


CAVEATS
Another mimeReader object opened on the same message - but with a different max depth - may number the entities differently, as entities at greater than max depth will be grouped into one entity tree, but may be separated in the other reader (if greater max depth).


SEE ALSO
mimeEntityGetChildNumber


Copyright © Thunderstone Software     Last updated: Dec 10 2018
Copyright © 2019 Thunderstone Software LLC. All rights reserved.