Allow more advanced element focusing

[squirrelmail.git] / class / deliver / Deliver_IMAP.class.php

diff --git a/class/deliver/Deliver_IMAP.class.php b/class/deliver/Deliver_IMAP.class.php
index 60309a2646aa03579597c6a5b4ccf7daaed67c12..b559e5c60ced8b71888eb72ed4f8e247c115f977 100644 (file)
--- a/class/deliver/Deliver_IMAP.class.php
+++ b/class/deliver/Deliver_IMAP.class.php
@@ -1,26 +1,85 @@
 <?php
+
 /**
  * Deliver_IMAP.class.php
  *
- * Copyright (c) 1999-2002 The SquirrelMail Project Team
- * Licensed under the GNU GPL. For full terms see the file COPYING.
- *
  * Delivery backend for the Deliver class.
  *
- * $Id$
+ * @copyright 1999-2018 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
+ * @version $Id$
+ * @package squirrelmail
  */
 
+/** This of course depends upon Deliver.. */
+
 require_once(SM_PATH . 'class/deliver/Deliver.class.php');
 
+/**
+ * This class is incomplete and entirely undocumented.
+ * @package squirrelmail
+ */
 class Deliver_IMAP extends Deliver {
 
     function getBcc() {
        return true;
     }
-    
-    /* to do: finishing the imap-class so the initStream function can call the 
-       imap-class */
-}
 
+    /**
+     * function send_mail - send the message parts to the IMAP stream
+     *
+     * Overridden from parent class so that we can insert some 
+     * IMAP APPEND commands before and after the message is 
+     * sent on the IMAP stream.
+     *
+     * @param Message  $message      Message object to send
+     * @param string   $header       Headers ready to send
+     * @param string   $boundary     Message parts boundary
+     * @param resource $stream       Handle to the SMTP stream
+     *                               (when FALSE, nothing will be
+     *                               written to the stream; this can
+     *                               be used to determine the actual
+     *                               number of bytes that will be
+     *                               written to the stream)
+     * @param int     &$raw_length   The number of bytes written (or that
+     *                               would have been written) to the 
+     *                               output stream - NOTE that this is
+     *                               passed by reference
+     * @param string   $folder       The IMAP folder to which the 
+     *                               message is being sent
+     *
+     * @return void
+     *
+     */
+    function send_mail($message, $header, $boundary, $stream=false, 
+                       &$raw_length, $folder=NULL) {
+
+        if (is_null($folder))
+            die('Internal error. Cannot pass NULL folder name to Deliver_IMAP::send_mail()');
+
+        // write the body without providing a stream so we
+        // can calculate the final length - after this call,
+        // $final_length will be our correct final length value
+        //
+        $final_length = $raw_length;
+        $this->writeBody($message, 0, $final_length, $boundary);
 
-?>
+
+        // now if we have a real live stream, send the message
+        //
+        if ($stream) {
+            sqimap_append ($stream, $folder, $final_length);
+
+            $this->preWriteToStream($header);
+            $this->writeToStream($stream, $header);
+            $this->writeBody($message, $stream, $raw_length, $boundary);
+
+            sqimap_append_done ($stream, $folder);
+        }
+
+    }
+
+
+    /* to do: finishing the imap-class so the initStream function can call the
+       imap-class */
+}