mimeEntityIsStartBodyPart

`mimeEntityIsStartBodyPart`

SYNOPSIS

int mimeEntityIsStartBodyPart(mimeEntity entityOrReader)

Parameters:

entityOrReader - A mimeEntity or mimeReader object

Returns:

int boolean value indicating whether the entity is the overall message start part

DESCRIPTION
The mimeEntityGet function returns an integer boolean value (1 if true, 0 if false) indicating whether the entity is the start body part for the overall message. I.e. in a multipart/related message, one entity is the actual message - the start body part - and the others are inline images or other associated objects. The start body part is always named index.ext by the mimeEntityGetSafeFilename function (here), so that if all the message's entities are written to the same directory and the directory is accessed via the web, the start body part will be returned by the web server.

An appropriate start body part is always chosen for every overall message, even if the overall type is not multipart/related.

EXAMPLE

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