cvs: peardoc /en/package/mail/mail-queue/mail-queue get.xml

quipo Fri Mar 12 05:02:06 2004 EDT Modified files: /peardoc/en/package/mail/mail-queue/mail-queue get.xml Log: update documentation of preload() http://cvs.php.net/diff.php/peardoc/en/package/mail/mail-queue/mail-queue/get.xml?r1=1.2&r2=1.3&ty=u Index: peardoc/en/package/mail/mail-queue/mail-queue/get.xml diff -u peardoc/en/package/mail/mail-queue/mail-queue/get.xml:1.2 peardoc/en/package/mail/mail-queue/mail-queue/get.xml:1.3 --- peardoc/en/package/mail/mail-queue/mail-queue/get.xml:1.2 Mon Mar 8 06:21:53 2004 +++ peardoc/en/package/mail/mail-queue/mail-queue/get.xml Fri Mar 12 05:02:06 2004 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="package.mail.mail-queue.mail-queue.get"> <refnamediv> <refname><function>Mail_Queue::get</function></refname> @@ -18,8 +18,12 @@ <refsect1 id="package.mail.mail-queue.mail-queue.get.desc"> &title.desc; - <para>Get next mail from queue. Will preload the queue when called for - the first time.</para> + <para>Get next mail from queue. The emails are preloaded into an internal memory + buffer to speed up the process. Since <classname>Mail_Queue</classname> v.1.1, + the <function>preload</function> method doesn't preload ALL the mails in memory, + but just a few of them each time. When the buffer is empty, it is filled again + automatically. You can set the size of the buffer via the + <function>setBufferSize</function> method.</para> </refsect1> <refsect1 id="package.mail.mail-queue.mail-queue.get.returns"> &title.returns; @@ -56,4 +60,4 @@ vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 ---> +-->