mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-20 19:08:54 +00:00
4c31e191c5
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@69281 c90b9560-bf6c-de11-be94-00142212c4b1
292 lines
9 KiB
XML
292 lines
9 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.3 $ -->
|
|
<reference id="ref.mailparse">
|
|
<title>mailparse functions</title>
|
|
<titleabbrev>mailparse functions</titleabbrev>
|
|
|
|
<partintro>
|
|
<para>
|
|
&warn.experimental;
|
|
</para>
|
|
</partintro>
|
|
|
|
<refentry id="function.mailparse-uudecode-all">
|
|
<refnamediv>
|
|
<refname>mailparse_uudecode_all</refname>
|
|
<refpurpose>
|
|
Scans the data from fp and extract each embedded uuencoded
|
|
file. Returns an array listing filename information
|
|
</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>array</type><methodname>mailparse_uudecode_all</methodname>
|
|
<methodparam><type>resource</type><parameter>fp</parameter></methodparam>
|
|
</methodsynopsis>
|
|
&warn.experimental.func;
|
|
<para>
|
|
&warn.undocumented.func;
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.mailparse-rfc822-parse-addresses">
|
|
<refnamediv>
|
|
<refname>mailparse_rfc822_parse_addresses</refname>
|
|
<refpurpose>
|
|
Parse addresses and returns a hash containing that data
|
|
</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>array</type><methodname>mailparse_rfc822_parse_addresses</methodname>
|
|
<methodparam><type>string</type><parameter>addresses</parameter></methodparam>
|
|
</methodsynopsis>
|
|
&warn.experimental.func;
|
|
<para>
|
|
&warn.undocumented.func;
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.mailparse-determine-best-xfer-encoding">
|
|
<refnamediv>
|
|
<refname>mailparse_determine_best_xfer_encoding</refname>
|
|
<refpurpose>
|
|
Figures out the best way of encoding the content read from the
|
|
file pointer fp, which must be seek-able
|
|
</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>int</type><methodname>mailparse_determine_best_xfer_encoding</methodname>
|
|
<methodparam><type>resource</type><parameter>fp</parameter></methodparam>
|
|
</methodsynopsis>
|
|
&warn.experimental.func;
|
|
<para>
|
|
&warn.undocumented.func;
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.mailparse-stream-encode">
|
|
<refnamediv>
|
|
<refname>mailparse_stream_encode</refname>
|
|
<refpurpose>
|
|
Streams data from source file pointer, apply encoding and write
|
|
to destfp
|
|
</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>mailparse_stream_encode</methodname>
|
|
<methodparam><type>resource</type><parameter>sourcefp</parameter></methodparam>
|
|
<methodparam><type>resource</type><parameter>destfp</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>encoding</parameter></methodparam>
|
|
</methodsynopsis>
|
|
&warn.experimental.func;
|
|
<para>
|
|
&warn.undocumented.func;
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.mailparse-msg-parse">
|
|
<refnamediv>
|
|
<refname>mailparse_msg_parse</refname>
|
|
<refpurpose>Incrementally parse data into buffer </refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>void</type><methodname>mailparse_msg_parse</methodname>
|
|
<methodparam><type>resource</type><parameter>rfc2045buf</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>data</parameter></methodparam>
|
|
</methodsynopsis>
|
|
&warn.experimental.func;
|
|
<para>
|
|
&warn.undocumented.func;
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.mailparse-msg-parse-file">
|
|
<refnamediv>
|
|
<refname>mailparse_msg_parse_file</refname>
|
|
<refpurpose>Parse file and return a resource representing the structure </refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>resource</type><methodname>mailparse_msg_parse_file</methodname>
|
|
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
|
|
</methodsynopsis>
|
|
&warn.experimental.func;
|
|
<para>
|
|
&warn.undocumented.func;
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.mailparse-msg-free">
|
|
<refnamediv>
|
|
<refname>mailparse_msg_free</refname>
|
|
<refpurpose>Frees a handle allocated by mailparse_msg_crea</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>void</type><methodname>mailparse_msg_free</methodname>
|
|
<methodparam><type>resource</type><parameter>rfc2045buf</parameter></methodparam>
|
|
</methodsynopsis>
|
|
&warn.experimental.func;
|
|
<para>
|
|
&warn.undocumented.func;
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.mailparse-msg-create">
|
|
<refnamediv>
|
|
<refname>mailparse_msg_create</refname>
|
|
<refpurpose>Returns a handle that can be used to parse a message </refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>int</type><methodname>mailparse_msg_create</methodname>
|
|
<void/>
|
|
</methodsynopsis>
|
|
&warn.experimental.func;
|
|
<para>
|
|
&warn.undocumented.func;
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.mailparse-msg-get-structure">
|
|
<refnamediv>
|
|
<refname>mailparse_msg_get_structure</refname>
|
|
<refpurpose>Returns an array of mime section names in the supplied message </refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>array</type><methodname>mailparse_msg_get_structure</methodname>
|
|
<methodparam><type>resource</type><parameter>rfc2045</parameter></methodparam>
|
|
</methodsynopsis>
|
|
&warn.experimental.func;
|
|
<para>
|
|
&warn.undocumented.func;
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.mailparse-msg-extract-part">
|
|
<refnamediv>
|
|
<refname>mailparse_msg_extract_part</refname>
|
|
<refpurpose>
|
|
Extracts/decodes a message section. If callbackfunc is not
|
|
specified, the contents will be sent to "stdout"
|
|
</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>void</type><methodname>mailparse_msg_extract_part</methodname>
|
|
<methodparam><type>resource</type><parameter>rfc2045</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>msgbody</parameter></methodparam>
|
|
<methodparam choice="opt"><type>string</type><parameter>callbackfunc</parameter></methodparam>
|
|
</methodsynopsis>
|
|
&warn.experimental.func;
|
|
<para>
|
|
&warn.undocumented.func;
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.mailparse-msg-extract-part-file">
|
|
<refnamediv>
|
|
<refname>mailparse_msg_extract_part_file</refname>
|
|
<refpurpose>Extracts/decodes a message section, decoding the transfer encoding </refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>string</type><methodname>mailparse_msg_extract_part_file</methodname>
|
|
<methodparam><type>resource</type><parameter>rfc2045</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
|
|
<methodparam choice="opt"><type>string</type><parameter>callbackfunc</parameter></methodparam>
|
|
</methodsynopsis>
|
|
&warn.experimental.func;
|
|
<para>
|
|
&warn.undocumented.func;
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.mailparse-msg-get-part-data">
|
|
<refnamediv>
|
|
<refname>mailparse_msg_get_part_data</refname>
|
|
<refpurpose>Returns an associative array of info about the message </refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>array</type><methodname>mailparse_msg_get_part_data</methodname>
|
|
<methodparam><type>resource</type><parameter>rfc2045</parameter></methodparam>
|
|
</methodsynopsis>
|
|
&warn.experimental.func;
|
|
<para>
|
|
&warn.undocumented.func;
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.mailparse-msg-get-part">
|
|
<refnamediv>
|
|
<refname>mailparse_msg_get_part</refname>
|
|
<refpurpose>Returns a handle on a given section in a mimemessage </refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>int</type><methodname>mailparse_msg_get_part</methodname>
|
|
<methodparam><type>resource</type><parameter>rfc2045</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>mimesection</parameter></methodparam>
|
|
</methodsynopsis>
|
|
&warn.experimental.func;
|
|
<para>
|
|
&warn.undocumented.func;
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
</reference>
|
|
|
|
<!-- Keep this comment at the end of the file
|
|
Local variables:
|
|
mode: sgml
|
|
sgml-omittag:t
|
|
sgml-shorttag:t
|
|
sgml-minimize-attributes:nil
|
|
sgml-always-quote-attributes:t
|
|
sgml-indent-step:1
|
|
sgml-indent-data:t
|
|
indent-tabs-mode:nil
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"../../manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
vim600: syn=xml fen fdm=syntax fdl=2 si
|
|
vim: et tw=78 syn=sgml
|
|
vi: ts=1 sw=1
|
|
-->
|
|
|
|
|