From 4a8a65c1ae21c89d9b49f0d3a3322aa7ec21890c Mon Sep 17 00:00:00 2001
From: Rik Heywood <rik@smallneatbox.co.uk>
Date: Sun, 10 Mar 2013 19:53:46 +0000
Subject: [PATCH] Added some comments to teh Email Interface so that auto
 suggest works better in IDEs

---
 email/EmailInterface.php | 59 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 59 insertions(+)

diff --git a/email/EmailInterface.php b/email/EmailInterface.php
index 661fe58..e6472f1 100644
--- a/email/EmailInterface.php
+++ b/email/EmailInterface.php
@@ -10,16 +10,75 @@
 
 interface EmailInterface
 {
+    /**
+     * @param $subject
+     * @return EmailInterface
+     */
     public function subject($subject);
+
+    /**
+     * @param $email
+     * @param null $name
+     * @return EmailInterface
+     */
     public function to($email, $name=null);
+
+    /**
+     * @param $email
+     * @param null $name
+     * @return EmailInterface
+     */
     public function cc($email, $name=null);
+
+    /**
+     * @param $email
+     * @param null $name
+     * @return EmailInterface
+     */
     public function bcc($email, $name=null);
+
+    /**
+     * @param $email
+     * @param null $name
+     * @return EmailInterface
+     */
     public function from($email, $name=null);
+
+    /**
+     * @param $email
+     * @param null $name
+     * @return EmailInterface
+     */
     public function replyTo($email, $name = null);
+
+    /**
+     * @param $html
+     * @return EmailInterface
+     */
     public function htmlBody($html);
+
+    /**
+     * @param $plain
+     * @return EmailInterface
+     */
     public function textBody($plain);
+
+    /**
+     * @param $filename
+     * @param string $mime
+     * @return EmailInterface
+     */
     public function attach($filename, $mime='application/octet-stream');
+
+    /**
+     * @param $tag
+     * @return EmailInterface
+     */
     public function tag($tag);
+
+    /**
+     * @return bool
+     */
     public function send();
 
     public function getHtmlBody();