mimeEntityGetChildNumber

SYNOPSIS

int mimeEntityGetChildNumber(mimeEntity entityOrReader)

Parameters:

• entityOrReader - A mimeEntity or mimeReader object

Returns:

• int child number of the entity

DESCRIPTION
The mimeEntityGetChildNumber function returns the sequence number (in source message order) of the current entity relative to its siblings, starting with 0. I.e. the first "payload" child entity (after the preamble) of a multipart is child number 0, the second is child 1, etc. If a child entity is another multipart entity, its descendant entities will in turn will be numbered starting over at 0. The very first entity (preamble) of the source message is considered the 0th child of a non-existent parent, for consistent numbering.

EXAMPLE

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

For the example MIME message above (here), each multipart/... preamble would be child 0, as each is the first child of its parent. The text/html entity would be child 1, as it is the second entity of its parent (the multipart/alternative entity).

CAVEATS

SEE ALSO
mimeEntityGetImapSectionSpecification, mimeEntityIsLastChild, mimeEntityGetSequenceNumber