mimeReaderOpenFile

SYNOPSIS

mimeReader mimeReaderOpenFile(varchar file[, int64 maxDepth])

Parameters:

• file - A varchar path to the MIME file to open

• maxDepth An optional integer maximum depth to parse to

Returns:

• mimeReader object for parsing the file

DESCRIPTION
The mimeReaderOpenFile function returns a new mimeReader object for parsing the MIME message in file.

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

<$file = "/tmp/mimeMessage.eml">
  <$reader = (mimeReaderOpenFile($file))>
  <if "" eq $reader>
    Cannot open $file
  </if>

CAVEATS

SEE ALSO
mimeReaderOpenString