<?php
/**
 * Wombat Mail Mime Storage
 *
 * $Id$
 *
 * @author gERD Schaufelberger <gerd@exit0.net>
 * @license PHP License
 * @package wombat
 * @subpackage MailMime
 */

/**
 * Wombat Mail Mime Storage
 *
 * Generic storage container for mime mails. Allows to load and save
 * mime mail object
 *
 * @version 0.1.0
 * @package WB
 * @subpackage MailMime
 */
class WBMail_Mime_Storage
{
    /**
     * mail container
     * @var WBMail_Mime
     */
    protected $mail;

    /**
     * constructor
     */
    final public function __construct()
    {
        $this->clear();
        $this->init();
    }

    /**
     * second constructor
     */
    protected function init()
    {
    }

    /**
     * clear everything
     *
     * Start from scratch
     */
    final public function clear()
    {
        $this->mail =   WBClass::create('WBMail_Mime');
    }

    /**
     * create mail object
     *
     * @return WBMail_Mime
     */
    final public function getMimeMail()
    {
        return $this->mail;
    }

    /**
     * set actual mail object
     *
     * @param WBMail_Sendable $mail
     */
    final public function setMimeMail(WBMail_Sendable $mail)
    {
        $this->mail =   $mail;
    }

    /**
     * Receive data of attachment
     *
     * Support for lazy loading of attachment data
     *
     * @param $id
     * @return string
     */
    public function getAttachmentData( $id )
    {
        return '';
    }

    /**
     * Store mime mail
     *
     * Do whatever it takes to make current mail object persistent.
     *
     * @return string $id
     */
    public function save()
    {
        return '';
    }
}