home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _182df4738e753cb780cfac62198b3364 < prev    next >
Text File  |  2000-03-23  |  8KB  |  202 lines
  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>Net::POP3 - Post Office Protocol 3 Client class</TITLE>
  5. <LINK REL="stylesheet" HREF="../../../Active.css" TYPE="text/css">
  6. <LINK REV="made" HREF="mailto:">
  7. </HEAD>
  8.  
  9. <BODY>
  10. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  11. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  12. <STRONG><P CLASS=block> Net::POP3 - Post Office Protocol 3 Client class</P></STRONG>
  13. </TD></TR>
  14. </TABLE>
  15.  
  16. <A NAME="__index__"></A>
  17. <!-- INDEX BEGIN -->
  18.  
  19. <UL>
  20.  
  21.     <LI><A HREF="#name">NAME</A></LI><LI><A HREF="#supportedplatforms">SUPPORTED PLATFORMS</A></LI>
  22.  
  23.     <LI><A HREF="#synopsis">SYNOPSIS</A></LI>
  24.     <LI><A HREF="#description">DESCRIPTION</A></LI>
  25.     <LI><A HREF="#examples">EXAMPLES</A></LI>
  26.     <LI><A HREF="#constructor">CONSTRUCTOR</A></LI>
  27.     <LI><A HREF="#methods">METHODS</A></LI>
  28.     <LI><A HREF="#notes">NOTES</A></LI>
  29.     <LI><A HREF="#see also">SEE ALSO</A></LI>
  30.     <LI><A HREF="#author">AUTHOR</A></LI>
  31.     <LI><A HREF="#copyright">COPYRIGHT</A></LI>
  32. </UL>
  33. <!-- INDEX END -->
  34.  
  35. <HR>
  36. <P>
  37. <H1><A NAME="name">NAME</A></H1>
  38. <P>Net::POP3 - Post Office Protocol 3 Client class (RFC1081)</P>
  39. <P>
  40. <HR>
  41. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  42. <UL>
  43. <LI>Linux</LI>
  44. <LI>Solaris</LI>
  45. <LI>Windows</LI>
  46. </UL>
  47. <HR>
  48. <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  49. <PRE>
  50.     use Net::POP3;
  51. </PRE>
  52. <PRE>
  53.  
  54.     # Constructors
  55.     $pop = Net::POP3->new('pop3host');
  56.     $pop = Net::POP3->new('pop3host', Timeout => 60);</PRE>
  57. <P>
  58. <HR>
  59. <H1><A NAME="description">DESCRIPTION</A></H1>
  60. <P>This module implements a client interface to the POP3 protocol, enabling
  61. a perl5 application to talk to POP3 servers. This documentation assumes
  62. that you are familiar with the POP3 protocol described in RFC1081.</P>
  63. <P>A new Net::POP3 object must be created with the <EM>new</EM> method. Once
  64. this has been done, all POP3 commands are accessed via method calls
  65. on the object.</P>
  66. <P>
  67. <HR>
  68. <H1><A NAME="examples">EXAMPLES</A></H1>
  69. <PRE>
  70.     Need some small examples in here :-)</PRE>
  71. <P>
  72. <HR>
  73. <H1><A NAME="constructor">CONSTRUCTOR</A></H1>
  74. <DL>
  75. <DT><STRONG><A NAME="item_new">new ( [ HOST, ] [ OPTIONS ] )</A></STRONG><BR>
  76. <DD>
  77. This is the constructor for a new Net::POP3 object. <CODE>HOST</CODE> is the
  78. name of the remote host to which a POP3 connection is required.
  79. <P>If <CODE>HOST</CODE> is not given, then the <CODE>POP3_Host</CODE> specified in <CODE>Net::Config</CODE>
  80. will be used.</P>
  81. <P><CODE>OPTIONS</CODE> are passed in a hash like fashion, using key and value pairs.
  82. Possible options are:</P>
  83. <P><STRONG>ResvPort</STRONG> - If given then the socket for the <CODE>Net::POP3</CODE> object
  84. will be bound to the local port given using <A HREF="../../../lib/Pod/perlfunc.html#item_bind"><CODE>bind</CODE></A> when the socket is
  85. created.</P>
  86. <P><STRONG>Timeout</STRONG> - Maximum time, in seconds, to wait for a response from the
  87. POP3 server (default: 120)</P>
  88. <P><STRONG>Debug</STRONG> - Enable debugging information</P>
  89. <P></P></DL>
  90. <P>
  91. <HR>
  92. <H1><A NAME="methods">METHODS</A></H1>
  93. <P>Unless otherwise stated all methods return either a <EM>true</EM> or <EM>false</EM>
  94. value, with <EM>true</EM> meaning that the operation was a success. When a method
  95. states that it returns a value, failure will be returned as <EM>undef</EM> or an
  96. empty list.</P>
  97. <DL>
  98. <DT><STRONG><A NAME="item_user">user ( USER )</A></STRONG><BR>
  99. <DD>
  100. Send the USER command.
  101. <P></P>
  102. <DT><STRONG><A NAME="item_pass">pass ( PASS )</A></STRONG><BR>
  103. <DD>
  104. Send the PASS command. Returns the number of messages in the mailbox.
  105. <P></P>
  106. <DT><STRONG><A NAME="item_login">login ( [ USER [, PASS ]] )</A></STRONG><BR>
  107. <DD>
  108. Send both the the USER and PASS commands. If <CODE>PASS</CODE> is not given the
  109. <CODE>Net::POP3</CODE> uses <CODE>Net::Netrc</CODE> to lookup the password using the host
  110. and username. If the username is not specified then the current user name
  111. will be used.
  112. <P>Returns the number of messages in the mailbox.</P>
  113. <P>If the server cannot authenticate <CODE>USER</CODE> the <EM>undef</EM> will be returned.</P>
  114. <P></P>
  115. <DT><STRONG><A NAME="item_apop">apop ( USER, PASS )</A></STRONG><BR>
  116. <DD>
  117. Authenticate with the server identifying as <CODE>USER</CODE> with password <CODE>PASS</CODE>.
  118. Similar ti <A HREF="#item_login">login</A>, but the password is not sent in clear text.
  119. <P>To use this method you must have the MD5 package installed, if you do not
  120. this method will return <EM>undef</EM></P>
  121. <P></P>
  122. <DT><STRONG><A NAME="item_top">top ( MSGNUM [, NUMLINES ] )</A></STRONG><BR>
  123. <DD>
  124. Get the header and the first <CODE>NUMLINES</CODE> of the body for the message
  125. <CODE>MSGNUM</CODE>. Returns a reference to an array which contains the lines of text
  126. read from the server.
  127. <P></P>
  128. <DT><STRONG><A NAME="item_list">list ( [ MSGNUM ] )</A></STRONG><BR>
  129. <DD>
  130. If called with an argument the <A HREF="#item_list"><CODE>list</CODE></A> returns the size of the message
  131. in octets.
  132. <P>If called without arguments a reference to a hash is returned. The
  133. keys will be the <CODE>MSGNUM</CODE>'s of all undeleted messages and the values will
  134. be their size in octets.</P>
  135. <P></P>
  136. <DT><STRONG><A NAME="item_get">get ( MSGNUM )</A></STRONG><BR>
  137. <DD>
  138. Get the message <CODE>MSGNUM</CODE> from the remote mailbox. Returns a reference to an
  139. array which contains the lines of text read from the server.
  140. <P></P>
  141. <DT><STRONG><A NAME="item_last">last ()</A></STRONG><BR>
  142. <DD>
  143. Returns the highest <CODE>MSGNUM</CODE> of all the messages accessed.
  144. <P></P>
  145. <DT><STRONG><A NAME="item_popstat">popstat ()</A></STRONG><BR>
  146. <DD>
  147. Returns an array of two elements. These are the number of undeleted
  148. elements and the size of the mbox in octets.
  149. <P></P>
  150. <DT><STRONG><A NAME="item_uidl">uidl ( [ MSGNUM ] )</A></STRONG><BR>
  151. <DD>
  152. Returns a unique identifier for <CODE>MSGNUM</CODE> if given. If <CODE>MSGNUM</CODE> is not
  153. given <A HREF="#item_uidl"><CODE>uidl</CODE></A> returns a reference to a hash where the keys are the
  154. message numbers and the values are the unique identifiers.
  155. <P></P>
  156. <DT><STRONG><A NAME="item_delete">delete ( MSGNUM )</A></STRONG><BR>
  157. <DD>
  158. Mark message <CODE>MSGNUM</CODE> to be deleted from the remote mailbox. All messages
  159. that are marked to be deleted will be removed from the remote mailbox
  160. when the server connection closed.
  161. <P></P>
  162. <DT><STRONG><A NAME="item_reset">reset ()</A></STRONG><BR>
  163. <DD>
  164. Reset the status of the remote POP3 server. This includes reseting the
  165. status of all messages to not be deleted.
  166. <P></P>
  167. <DT><STRONG><A NAME="item_quit">quit ()</A></STRONG><BR>
  168. <DD>
  169. Quit and close the connection to the remote POP3 server. Any messages marked
  170. as deleted will be deleted from the remote mailbox.
  171. <P></P></DL>
  172. <P>
  173. <HR>
  174. <H1><A NAME="notes">NOTES</A></H1>
  175. <P>If a <CODE>Net::POP3</CODE> object goes out of scope before <A HREF="#item_quit"><CODE>quit</CODE></A> method is called
  176. then the <A HREF="#item_reset"><CODE>reset</CODE></A> method will called before the connection is closed. This
  177. means that any messages marked to be deleted will not be.</P>
  178. <P>
  179. <HR>
  180. <H1><A NAME="see also">SEE ALSO</A></H1>
  181. <P><A HREF="../../../site/lib/Net/Netrc.html">the Net::Netrc manpage</A>
  182. <A HREF="../../../site/lib/Net/Cmd.html">the Net::Cmd manpage</A></P>
  183. <P>
  184. <HR>
  185. <H1><A NAME="author">AUTHOR</A></H1>
  186. <P>Graham Barr <<A HREF="mailto:gbarr@pobox.com">gbarr@pobox.com</A>></P>
  187. <P>
  188. <HR>
  189. <H1><A NAME="copyright">COPYRIGHT</A></H1>
  190. <P>Copyright (c) 1995-1997 Graham Barr. All rights reserved.
  191. This program is free software; you can redistribute it and/or modify
  192. it under the same terms as Perl itself.</P>
  193. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  194. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  195. <STRONG><P CLASS=block> Net::POP3 - Post Office Protocol 3 Client class</P></STRONG>
  196. </TD></TR>
  197. </TABLE>
  198.  
  199. </BODY>
  200.  
  201. </HTML>
  202.