svn: /pear/peardoc/trunk/ en/package/mail/mail-mime/encodeheader.xml en/package/mail/mail-mime/get.xml en/package/mail/mail-mime.xml fr/package/mail/mail-mime/get.xml fr/package/mail/mail-mime.xml ja/package/mail/mail-mime/get.xml ja/package/mail/mail-mime.xml pl/package/mail/mail-mime.xml
[email protected] (Aleksander Machniak) Thu, 31 Dec 2009 08:13:36 +0000
| Newsgroups | php.pear.doc |
|---|---|
| Message-ID | <[email protected]> |
alec Thu, 31 Dec 2009 08:13:36 +0000
Revision: http://svn.php.net/viewvc?view=revision&revision=292840
Log:
- update documentation to Mail_Mime 1.5.3
Changed paths:
A pear/peardoc/trunk/en/package/mail/mail-mime/encodeheader.xml
U pear/peardoc/trunk/en/package/mail/mail-mime/get.xml
U pear/peardoc/trunk/en/package/mail/mail-mime.xml
U pear/peardoc/trunk/fr/package/mail/mail-mime/get.xml
U pear/peardoc/trunk/fr/package/mail/mail-mime.xml
U pear/peardoc/trunk/ja/package/mail/mail-mime/get.xml
U pear/peardoc/trunk/ja/package/mail/mail-mime.xml
U pear/peardoc/trunk/pl/package/mail/mail-mime.xml
Added: pear/peardoc/trunk/en/package/mail/mail-mime/encodeheader.xml
===================================================================
--- pear/peardoc/trunk/en/package/mail/mail-mime/encodeheader.xml (rev 0)
+++ pear/peardoc/trunk/en/package/mail/mail-mime/encodeheader.xml 2009-12-31 08:13:36 UTC (rev 292840)
@@ -0,0 +1,65 @@
+<?xml version="1.0" encoding="utf-8"?>
+<refentry xmlns="http://docbook.org/ns/docbook" version="lillet" xml:id="package.mail.mail-mime.encodeheader">
+ <refnamediv>
+ <refname>Mail_Mime::encodeHeader()</refname>
+ <refpurpose>encode header value</refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <funcsynopsis>
+ <funcsynopsisinfo>
+ require_once 'Mail/mime.php';
+ </funcsynopsisinfo>
+ <funcprototype>
+ <funcdef>string <function>encodeHeader</function></funcdef>
+ <paramdef choice="req">string <parameter>$name</parameter></paramdef>
+ <paramdef choice="req">string <parameter>$value</parameter></paramdef>
+ <paramdef choice="req">string <parameter>$charset</parameter></paramdef>
+ <paramdef choice="req">string <parameter>$encoding</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ </refsynopsisdiv>
+ <refsection xml:id="package.mail.mail-mime.encodeheader.desc">
+ &title.desc;
+ <para>
+ Returns encoded header value as for RFC2047.
+ </para>
+ </refsection>
+ <refsection xml:id="package.mail.mail-mime.encodeheader.parameter">
+ &title.param;
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <parameter>string $name</parameter> - The header name
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <parameter>string $value</parameter> - The header body
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <parameter>string $charset</parameter> - Character set used in header body
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <parameter>string $encoding</parameter> - Encoding (<quote>base64</quote>
+ or <quote>quoted-printable</quote>)
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </refsection>
+ <refsection xml:id="package.mail.mail-mime.encodeheader.return">
+ &title.returns;
+ <para>
+ <parameter>string</parameter> - Returns encoded header body (without a name)
+ </para>
+ </refsection>
+ <refsection xml:id="package.mail.mail-mime.encodeheader.note">
+ &title.note;
+ ¬e.notstatic;
+ </refsection>
+ </refentry>
\ No newline at end of file
Modified: pear/peardoc/trunk/en/package/mail/mail-mime/get.xml
===================================================================
--- pear/peardoc/trunk/en/package/mail/mail-mime/get.xml 2009-12-31 07:37:56 UTC (rev 292839)
+++ pear/peardoc/trunk/en/package/mail/mail-mime/get.xml 2009-12-31 08:13:36 UTC (rev 292840)
@@ -51,13 +51,6 @@
</listitem>
<listitem>
<para>
- <parameter>$param["7bit_wrap"]</parameter> - Number of characters after
- which text is wrapped. SMTP stipulates maximum line length of 1000 characters
- including CRLF. Default is 998 (CRLF is appended to make up to 1000).
- </para>
- </listitem>
- <listitem>
- <para>
<parameter>$param["head_charset"]</parameter> - The character set
to use for the headers. Default is <quote>iso-8859-1</quote>.
</para>
Modified: pear/peardoc/trunk/en/package/mail/mail-mime.xml
===================================================================
--- pear/peardoc/trunk/en/package/mail/mail-mime.xml 2009-12-31 07:37:56 UTC (rev 292839)
+++ pear/peardoc/trunk/en/package/mail/mail-mime.xml 2009-12-31 08:13:36 UTC (rev 292840)
@@ -21,6 +21,7 @@
&package.mail.mail-mime.headers;
&package.mail.mail-mime.sethtmlbody;
&package.mail.mail-mime.settxtbody;
+ &package.mail.mail-mime.encodeheader;
&package.mail.mail-mimepart.mail-mimepart;
&package.mail.mail-mimepart.addsubpart;
&package.mail.mail-mimepart.encode;
Modified: pear/peardoc/trunk/fr/package/mail/mail-mime/get.xml
===================================================================
--- pear/peardoc/trunk/fr/package/mail/mail-mime/get.xml 2009-12-31 07:37:56 UTC (rev 292839)
+++ pear/peardoc/trunk/fr/package/mail/mail-mime/get.xml 2009-12-31 08:13:36 UTC (rev 292840)
@@ -73,16 +73,6 @@
</listitem>
<listitem>
<para>
- <parameter>$param["7bit_wrap"]</parameter>
- Le nombre de caractères après quoi de texte est coupé.
- Le SMTP stipule la longueur de ligne maximum de 1000
- caractères comprenant CRLF.
- Par defaut la valeur est 998
- (CRLF est apposé pour atteindre les 1000).
- </para>
- </listitem>
- <listitem>
- <para>
<parameter>$param["text_charset"]</parameter>
Le jeu de caractères à employer
pour la partie textes pur de l'email.
Modified: pear/peardoc/trunk/fr/package/mail/mail-mime.xml
===================================================================
--- pear/peardoc/trunk/fr/package/mail/mail-mime.xml 2009-12-31 07:37:56 UTC (rev 292839)
+++ pear/peardoc/trunk/fr/package/mail/mail-mime.xml 2009-12-31 08:13:36 UTC (rev 292840)
@@ -24,6 +24,7 @@
&package.mail.mail-mime.headers;
&package.mail.mail-mime.sethtmlbody;
&package.mail.mail-mime.settxtbody;
+ &package.mail.mail-mime.encodeheader;
&package.mail.mail-mimepart.mail-mimepart;
&package.mail.mail-mimepart.addsubpart;
&package.mail.mail-mimepart.encode;
Modified: pear/peardoc/trunk/ja/package/mail/mail-mime/get.xml
===================================================================
--- pear/peardoc/trunk/ja/package/mail/mail-mime/get.xml 2009-12-31 07:37:56 UTC (rev 292839)
+++ pear/peardoc/trunk/ja/package/mail/mail-mime/get.xml 2009-12-31 08:13:36 UTC (rev 292840)
@@ -54,14 +54,6 @@
</listitem>
<listitem>
<para>
- <parameter>$param["7bit_wrap"]</parameter> -
- テキストが終わる文字数です。
- SMTP は、CRLF を含む 1000 文字を最大行の長さと規定します。
- デフォルトは 998 文字です (CRLF を追加して 1000 文字になります)。
- </para>
- </listitem>
- <listitem>
- <para>
<parameter>$param["head_charset"]</parameter> -
ヘッダに使用する文字コードセットです。デフォルトは <quote>iso-8859-1</quote> です。
</para>
Modified: pear/peardoc/trunk/ja/package/mail/mail-mime.xml
===================================================================
--- pear/peardoc/trunk/ja/package/mail/mail-mime.xml 2009-12-31 07:37:56 UTC (rev 292839)
+++ pear/peardoc/trunk/ja/package/mail/mail-mime.xml 2009-12-31 08:13:36 UTC (rev 292840)
@@ -21,6 +21,7 @@
&package.mail.mail-mime.headers;
&package.mail.mail-mime.sethtmlbody;
&package.mail.mail-mime.settxtbody;
+ &package.mail.mail-mime.encodeheader;
&package.mail.mail-mimepart.mail-mimepart;
&package.mail.mail-mimepart.addsubpart;
&package.mail.mail-mimepart.encode;
Modified: pear/peardoc/trunk/pl/package/mail/mail-mime.xml
===================================================================
--- pear/peardoc/trunk/pl/package/mail/mail-mime.xml 2009-12-31 07:37:56 UTC (rev 292839)
+++ pear/peardoc/trunk/pl/package/mail/mail-mime.xml 2009-12-31 08:13:36 UTC (rev 292840)
@@ -15,12 +15,13 @@
<chapter>
&package.mail.mail-mime.mail-mime;
- &package.mail.mail-mime.addattachment;
+ &package.mail.mail-mime.addattachment;
&package.mail.mail-mime.addhtmlimage;
&package.mail.mail-mime.get;
&package.mail.mail-mime.headers;
&package.mail.mail-mime.sethtmlbody;
&package.mail.mail-mime.settxtbody;
+ &package.mail.mail-mime.encodeheader;
&package.mail.mail-mimepart.mail-mimepart;
&package.mail.mail-mimepart.addsubpart;
&package.mail.mail-mimepart.encode;