File: reference.xml

package info (click to toggle)
phpdoc 20050512-1
  • links: PTS
  • area: non-free
  • in suites: sarge
  • size: 36,592 kB
  • ctags: 1,501
  • sloc: xml: 376,768; php: 6,708; cpp: 500; makefile: 293; perl: 161; sh: 151; awk: 28
file content (159 lines) | stat: -rw-r--r-- 5,082 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.16 $ -->
 <reference id='ref.imap'>
  <title>IMAP, POP3 and NNTP Functions</title>
  <titleabbrev>IMAP</titleabbrev>

  <partintro>
   <section id="imap.intro">
   &reftitle.intro;
   <para>
     These functions are not limited to the <acronym>IMAP</acronym> protocol,
     despite their name. The underlying c-client library also supports
     <acronym>NNTP</acronym>, <acronym>POP3</acronym> and local mailbox access
     methods.
    </para>
   </section>

   <section id="imap.requirements">
    &reftitle.required;
    <para>
     This extension requires the c-client library to be installed.
     Grab the latest version from <ulink url="&url.imap;">&url.imap;</ulink>
     and compile it.
    </para>
    <para>
     It's important that you do not copy the IMAP source files directly into
     the system include directory as there may be conflicts.  Instead, create
     a new directory inside the system include directory, such as 
     <filename>/usr/local/imap-2000b/</filename> (location and name
     depend on your setup and IMAP version), and inside this new 
     directory create additional directories named <filename>lib/</filename> 
     and <filename>include/</filename>.  From the <filename>c-client</filename> 
     directory from your IMAP source tree, copy all the <filename>*.h</filename> 
     files into <filename>include/</filename> and all the 
     <filename>*.c</filename> files into <filename>lib/</filename>.  
     Additionally when you compiled IMAP, a file named
     <filename>c-client.a</filename> was created.  Also put this in the 
     <filename>lib/</filename> directory but rename it as
     <filename>libc-client.a</filename>.
    </para>
    <note>
     <para>
      To build the c-client library with SSL or/and Kerberos support read
      the docs supplied with the package.
     </para>
    </note>
    <note>
     <simpara>
      In Mandrake Linux, the IMAP library (<filename>libc-client.a</filename>)
      is compiled without Kerberos support. A separate version with SSL
      (<filename>client-PHP4.a</filename>) is installed. The library must
      be recompiled in order to add Kerberos support.
     </simpara>
    </note>
   </section>

   &reference.imap.configure;

   <section id="imap.configuration">
    &reftitle.runtime;
    &no.config;
   </section>

   <section id="imap.resources">
    &reftitle.resources;
    <para>
    </para>
   </section>

   &reference.imap.constants;

   <section id="imap.seealso">
   &reftitle.seealso;
    <para>
     This document can't go into detail on all the topics touched by
     the provided functions. Further information is provided by the
     documentation of the c-client library source
     (<filename>docs/internal.txt</filename>). and the following RFC
     documents:
     <itemizedlist>
      <listitem>
       <simpara>
        <ulink url="&url.rfc;2821">RFC2821</ulink>: Simple Mail
        Transfer Protocol (SMTP).
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        <ulink url="&url.rfc;2822">RFC2822</ulink>: Standard for
        ARPA internet text messages.
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        <ulink url="&url.rfc;2060">RFC2060</ulink>: Internet
        Message Access Protocol (IMAP) Version 4rev1. 
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        <ulink url="&url.rfc;1939">RFC1939</ulink>:  Post
        Office Protocol Version 3 (POP3).
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        <ulink url="&url.rfc;977">RFC977</ulink>: Network News
        Transfer Protocol (NNTP).
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        <ulink url="&url.rfc;2076">RFC2076</ulink>: Common
        Internet Message Headers.
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        <ulink url="&url.rfc;2045">RFC2045</ulink> , <ulink
        url="&url.rfc;2046">RFC2046</ulink> , <ulink
        url="&url.rfc;2047">RFC2047</ulink> , <ulink
        url="&url.rfc;2048">RFC2048</ulink> &amp; <ulink
        url="&url.rfc;2049">RFC2049</ulink>: Multipurpose
        Internet Mail Extensions (MIME).
       </simpara>
      </listitem>
     </itemizedlist> 
     A detailed overview is also available in the books
     <ulink url="&url.email.book;">Programming Internet Email</ulink>
     by David Wood and  <ulink url="&url.imap.book;">Managing
     IMAP</ulink> by Dianna Mullet &amp; Kevin Mullet.
    </para>
   </section>
  </partintro>

&reference.imap.functions;

 </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
-->