<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Parses a file</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.mailparse-msg-get-structure.html">mailparse_msg_get_structure</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.mailparse-msg-parse.html">mailparse_msg_parse</a></div>
<div class="up"><a href="ref.mailparse.html">Mailparse Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.mailparse-msg-parse-file" class="refentry">
<div class="refnamediv">
<h1 class="refname">mailparse_msg_parse_file</h1>
<p class="verinfo">(PECL mailparse >= 0.9.0)</p><p class="refpurpose"><span class="refname">mailparse_msg_parse_file</span> — <span class="dc-title">Parses a file</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.mailparse-msg-parse-file-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">resource</span> <span class="methodname"><strong>mailparse_msg_parse_file</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$filename</code></span>
)</div>
<p class="para rdfs-comment">
Parses a file.
This is the optimal way of parsing a mail file that you have on disk.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.mailparse-msg-parse-file-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">filename</code></em></span>
<dd>
<p class="para">
Path to the file holding the message.
The file is opened and streamed through the parser.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.mailparse-msg-parse-file-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns a <em>MIME</em> resource representing the structure, or
<strong><code>FALSE</code></strong> on error.
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.mailparse-msg-parse-file-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.mailparse-msg-free.html" class="function" rel="rdfs-seeAlso">mailparse_msg_free()</a> - Frees a MIME resource</span></li>
<li class="member"> <span class="function"><a href="function.mailparse-msg-create.html" class="function" rel="rdfs-seeAlso">mailparse_msg_create()</a> - Create a mime mail resource</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.mailparse-msg-get-structure.html">mailparse_msg_get_structure</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.mailparse-msg-parse.html">mailparse_msg_parse</a></div>
<div class="up"><a href="ref.mailparse.html">Mailparse Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
