mail_engine 0.1.6 → 0.1.7

data/doc/MailEngine/Sendgrid/SmtpApi.html

@@ -208,6 +208,30 @@ A new instance of SmtpApi.
 </p>
 </div></span>
   
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#set_send_to-instance_method" title="#set_send_to (instance method)">- (Object) <strong>set_send_to</strong>(to) </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'><p>
+for now only allow to send to one receiver once.
+</p>
+</div></span>
+  
 </li>
 
       
@@ -361,17 +385,17 @@ A new instance of SmtpApi
       <pre class="lines">
 
 
-63
-64
-65
-66</pre>
+71
+72
+73
+74</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/mail_engine/sendgrid/smtp_api.rb', line 63</span>
+      <pre class="code"><span class="info file"># File 'lib/mail_engine/sendgrid/smtp_api.rb', line 71</span>
 
 <span class='def def kw'>def</span> <span class='add_sub_val identifier id'>add_sub_val</span><span class='lparen token'>(</span><span class='var identifier id'>var</span><span class='comma token'>,</span> <span class='val identifier id'>val</span><span class='rparen token'>)</span>
   <span class='@data ivar id'>@data</span><span class='lbrack token'>[</span><span class='string val'>'sub'</span><span class='rbrack token'>]</span> <span class='opasgn op'>||=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span>
-  <span class='@data ivar id'>@data</span><span class='lbrack token'>[</span><span class='string val'>'sub'</span><span class='rbrack token'>]</span><span class='lbrack token'>[</span><span class='var identifier id'>var</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='val identifier id'>val</span><span class='dot token'>.</span><span class='instance_of? fid id'>instance_of?</span><span class='lparen token'>(</span><span class='Array constant id'>Array</span><span class='rparen token'>)</span> <span class='question op'>?</span> <span class='var identifier id'>var</span> <span class='colon op'>:</span> <span class='lbrack token'>[</span><span class='var identifier id'>var</span><span class='rbrack token'>]</span>
+  <span class='@data ivar id'>@data</span><span class='lbrack token'>[</span><span class='string val'>'sub'</span><span class='rbrack token'>]</span><span class='lbrack token'>[</span><span class='var identifier id'>var</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='Array constant id'>Array</span><span class='dot token'>.</span><span class='wrap identifier id'>wrap</span><span class='lparen token'>(</span><span class='val identifier id'>val</span><span class='rparen token'>)</span>
 <span class='end end kw'>end</span>
 </pre>
     </td>
@@ -392,18 +416,18 @@ A new instance of SmtpApi
       <pre class="lines">
 
 
-57
-58
-59
-60
-61</pre>
+65
+66
+67
+68
+69</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/mail_engine/sendgrid/smtp_api.rb', line 57</span>
+      <pre class="code"><span class="info file"># File 'lib/mail_engine/sendgrid/smtp_api.rb', line 65</span>
 
 <span class='def def kw'>def</span> <span class='add_to identifier id'>add_to</span><span class='lparen token'>(</span><span class='to identifier id'>to</span><span class='rparen token'>)</span>
   <span class='@data ivar id'>@data</span><span class='lbrack token'>[</span><span class='string val'>'to'</span><span class='rbrack token'>]</span> <span class='opasgn op'>||=</span> <span class='lbrack token'>[</span><span class='rbrack token'>]</span>
-  <span class='@data ivar id'>@data</span><span class='lbrack token'>[</span><span class='string val'>'to'</span><span class='rbrack token'>]</span> <span class='opasgn op'>+=</span> <span class='to identifier id'>to</span><span class='dot token'>.</span><span class='kind_of? fid id'>kind_of?</span><span class='lparen token'>(</span><span class='Array constant id'>Array</span><span class='rparen token'>)</span> <span class='question op'>?</span> <span class='to identifier id'>to</span> <span class='colon op'>:</span> <span class='lbrack token'>[</span><span class='to identifier id'>to</span><span class='rbrack token'>]</span>
+  <span class='@data ivar id'>@data</span><span class='lbrack token'>[</span><span class='string val'>'to'</span><span class='rbrack token'>]</span> <span class='opasgn op'>+=</span> <span class='Array constant id'>Array</span><span class='dot token'>.</span><span class='wrap identifier id'>wrap</span><span class='lparen token'>(</span><span class='to identifier id'>to</span><span class='rparen token'>)</span>
   <span class='@data ivar id'>@data</span><span class='lbrack token'>[</span><span class='string val'>'to'</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='uniq! fid id'>uniq!</span>
 <span class='end end kw'>end</span>
 </pre>
@@ -472,6 +496,51 @@ A new instance of SmtpApi
     </td>
   </tr>
 </table>
+</div>
+    
+      <div class="method_details ">
+  <p class="signature " id="set_send_to-instance_method">
+  
+    - (<tt>Object</tt>) <strong>set_send_to</strong>(to) 
+  
+
+  
+</p><div class="docstring">
+  <div class="discussion">
+    <p>
+for now only allow to send to one receiver once. maybe we don&#8217;t like
+people received a mail which allow people to view all receivers
+</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+59
+60
+61
+62
+63</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/mail_engine/sendgrid/smtp_api.rb', line 59</span>
+
+<span class='def def kw'>def</span> <span class='set_send_to identifier id'>set_send_to</span><span class='lparen token'>(</span><span class='to identifier id'>to</span><span class='rparen token'>)</span>
+  <span class='@data ivar id'>@data</span><span class='lbrack token'>[</span><span class='string val'>'to'</span><span class='rbrack token'>]</span> <span class='opasgn op'>||=</span> <span class='lbrack token'>[</span><span class='rbrack token'>]</span>
+  <span class='@data ivar id'>@data</span><span class='lbrack token'>[</span><span class='string val'>'to'</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='Array constant id'>Array</span><span class='dot token'>.</span><span class='wrap identifier id'>wrap</span><span class='lparen token'>(</span><span class='to identifier id'>to</span><span class='rparen token'>)</span>
+  <span class='@data ivar id'>@data</span><span class='lbrack token'>[</span><span class='string val'>'to'</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='uniq! fid id'>uniq!</span>
+<span class='end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
 </div>
     
       <div class="method_details ">
@@ -487,12 +556,12 @@ A new instance of SmtpApi
       <pre class="lines">
 
 
-68
-69
-70</pre>
+76
+77
+78</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/mail_engine/sendgrid/smtp_api.rb', line 68</span>
+      <pre class="code"><span class="info file"># File 'lib/mail_engine/sendgrid/smtp_api.rb', line 76</span>
 
 <span class='def def kw'>def</span> <span class='set_unique_args identifier id'>set_unique_args</span><span class='lparen token'>(</span><span class='val identifier id'>val</span><span class='rparen token'>)</span>
   <span class='@data ivar id'>@data</span><span class='lbrack token'>[</span><span class='string val'>'unique_args'</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='val identifier id'>val</span> <span class='if if_mod kw'>if</span> <span class='val identifier id'>val</span><span class='dot token'>.</span><span class='instance_of? fid id'>instance_of?</span><span class='lparen token'>(</span><span class='Hash constant id'>Hash</span><span class='rparen token'>)</span>
@@ -516,12 +585,12 @@ A new instance of SmtpApi
       <pre class="lines">
 
 
-76
-77
-78</pre>
+84
+85
+86</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/mail_engine/sendgrid/smtp_api.rb', line 76</span>
+      <pre class="code"><span class="info file"># File 'lib/mail_engine/sendgrid/smtp_api.rb', line 84</span>
 
 <span class='def def kw'>def</span> <span class='to_hash identifier id'>to_hash</span>
   <span class='lbrace token'>{</span><span class='string val'>'X-SMTPAPI'</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='to_json identifier id'>to_json</span><span class='rbrace token'>}</span>
@@ -545,12 +614,12 @@ A new instance of SmtpApi
       <pre class="lines">
 
 
-72
-73
-74</pre>
+80
+81
+82</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/mail_engine/sendgrid/smtp_api.rb', line 72</span>
+      <pre class="code"><span class="info file"># File 'lib/mail_engine/sendgrid/smtp_api.rb', line 80</span>
 
 <span class='def def kw'>def</span> <span class='to_json identifier id'>to_json</span>
   <span class='@data ivar id'>@data</span><span class='dot token'>.</span><span class='to_json identifier id'>to_json</span><span class='dot token'>.</span><span class='gsub identifier id'>gsub</span><span class='lparen token'>(</span><span class='regexp val'>/([&quot;\]}])([,:])([&quot;\[{])/</span><span class='comma token'>,</span> <span class='string val'>'\\1\\2 \\3'</span><span class='rparen token'>)</span>
@@ -574,12 +643,12 @@ A new instance of SmtpApi
       <pre class="lines">
 
 
-80
-81
-82</pre>
+88
+89
+90</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/mail_engine/sendgrid/smtp_api.rb', line 80</span>
+      <pre class="code"><span class="info file"># File 'lib/mail_engine/sendgrid/smtp_api.rb', line 88</span>
 
 <span class='def def kw'>def</span> <span class='to_s identifier id'>to_s</span>
   <span class='string val'>'X-SMTPAPI: %s'</span> <span class='mod op'>%</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='to_json identifier id'>to_json</span>
@@ -595,7 +664,7 @@ A new instance of SmtpApi
 </div>
     
     <div id="footer">
-  Generated on Fri Mar  4 17:56:25 2011 by 
+  Generated on Mon Mar 14 22:31:44 2011 by 
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.6.4 (ruby-1.8.7).
 </div>

data/doc/MailEngine/Sendgrid.html

@@ -92,7 +92,7 @@
 </div>
     
     <div id="footer">
-  Generated on Fri Mar  4 17:56:25 2011 by 
+  Generated on Mon Mar 14 22:31:44 2011 by 
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.6.4 (ruby-1.8.7).
 </div>

data/doc/MailEngine/ZipProcessor.html

@@ -258,7 +258,7 @@ zip file. the second item is the unzip path.
 </div>
     
     <div id="footer">
-  Generated on Fri Mar  4 17:56:25 2011 by 
+  Generated on Mon Mar 14 22:31:45 2011 by 
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.6.4 (ruby-1.8.7).
 </div>

data/doc/MailEngine.html

@@ -64,7 +64,7 @@
   
     <dt class="r2 last">Defined in:</dt>
     <dd class="r2 last">lib/mail_engine/sendgrid/rest_api.rb<span class="defines">,<br />
-  lib/mail_engine.rb,<br /> lib/mail_engine/base.rb,<br /> lib/mail_engine/engine.rb,<br /> lib/mail_engine/version.rb,<br /> lib/mail_engine/sendgrid.rb,<br /> lib/mail_engine/configuration.rb,<br /> lib/mail_engine/zip_processor.rb,<br /> lib/mail_engine/sendgrid/base.rb,<br /> lib/mail_engine/sendgrid/smtp_api.rb,<br /> lib/mail_engine/generators/install.rb,<br /> lib/mail_engine/mail_log_subscriber.rb,<br /> lib/mail_engine/acts_as_mail_receiver.rb,<br /> lib/mail_engine/generators/create_config.rb,<br /> lib/mail_engine/generators/copy_resources.rb,<br /> lib/mail_engine/generators/copy_migrations.rb,<br /> lib/mail_engine/html_document_assets_replacer.rb</span>
+  lib/mail_engine.rb,<br /> lib/mail_engine/base.rb,<br /> lib/mail_engine/engine.rb,<br /> lib/mail_engine/version.rb,<br /> lib/mail_engine/sendgrid.rb,<br /> lib/mail_engine/configuration.rb,<br /> lib/mail_engine/zip_processor.rb,<br /> lib/mail_engine/sendgrid/base.rb,<br /> lib/mail_engine/sendgrid/smtp_api.rb,<br /> lib/mail_engine/generators/install.rb,<br /> lib/mail_engine/mail_log_subscriber.rb,<br /> lib/mail_engine/acts_as_mail_receiver.rb,<br /> lib/mail_engine/mail_template_resolver.rb,<br /> lib/mail_engine/generators/create_config.rb,<br /> lib/mail_engine/generators/copy_resources.rb,<br /> lib/mail_engine/generators/copy_migrations.rb,<br /> lib/mail_engine/html_document_assets_replacer.rb</span>
 </dd>
   
 </dl>
@@ -89,7 +89,7 @@ Used for setting a User model as a Mail Receiver Data Provider
     
    
     
-      <strong class="classes">Classes:</strong> <span class='object_link'><a href="MailEngine/Base.html" title="MailEngine::Base (class)">Base</a></span>, <span class='object_link'><a href="MailEngine/Configuration.html" title="MailEngine::Configuration (class)">Configuration</a></span>, <span class='object_link'><a href="MailEngine/CopyMigrations.html" title="MailEngine::CopyMigrations (class)">CopyMigrations</a></span>, <span class='object_link'><a href="MailEngine/CopyResources.html" title="MailEngine::CopyResources (class)">CopyResources</a></span>, <span class='object_link'><a href="MailEngine/CreateConfig.html" title="MailEngine::CreateConfig (class)">CreateConfig</a></span>, <span class='object_link'><a href="MailEngine/Engine.html" title="MailEngine::Engine (class)">Engine</a></span>, <span class='object_link'><a href="MailEngine/HtmlDocumentAssetsReplacer.html" title="MailEngine::HtmlDocumentAssetsReplacer (class)">HtmlDocumentAssetsReplacer</a></span>, <span class='object_link'><a href="MailEngine/Install.html" title="MailEngine::Install (class)">Install</a></span>, <span class='object_link'><a href="MailEngine/MailLogSubscriber.html" title="MailEngine::MailLogSubscriber (class)">MailLogSubscriber</a></span>, <span class='object_link'><a href="MailEngine/ZipProcessor.html" title="MailEngine::ZipProcessor (class)">ZipProcessor</a></span>
+      <strong class="classes">Classes:</strong> <span class='object_link'><a href="MailEngine/Base.html" title="MailEngine::Base (class)">Base</a></span>, <span class='object_link'><a href="MailEngine/Configuration.html" title="MailEngine::Configuration (class)">Configuration</a></span>, <span class='object_link'><a href="MailEngine/CopyMigrations.html" title="MailEngine::CopyMigrations (class)">CopyMigrations</a></span>, <span class='object_link'><a href="MailEngine/CopyResources.html" title="MailEngine::CopyResources (class)">CopyResources</a></span>, <span class='object_link'><a href="MailEngine/CreateConfig.html" title="MailEngine::CreateConfig (class)">CreateConfig</a></span>, <span class='object_link'><a href="MailEngine/Engine.html" title="MailEngine::Engine (class)">Engine</a></span>, <span class='object_link'><a href="MailEngine/HtmlDocumentAssetsReplacer.html" title="MailEngine::HtmlDocumentAssetsReplacer (class)">HtmlDocumentAssetsReplacer</a></span>, <span class='object_link'><a href="MailEngine/Install.html" title="MailEngine::Install (class)">Install</a></span>, <span class='object_link'><a href="MailEngine/MailLogSubscriber.html" title="MailEngine::MailLogSubscriber (class)">MailLogSubscriber</a></span>, <span class='object_link'><a href="MailEngine/MailTemplateResolver.html" title="MailEngine::MailTemplateResolver (class)">MailTemplateResolver</a></span>, <span class='object_link'><a href="MailEngine/ZipProcessor.html" title="MailEngine::ZipProcessor (class)">ZipProcessor</a></span>
     
   
 </p>
@@ -137,7 +137,7 @@ used for looking up which layout needs which placeholders.
 </div>
     
     <div id="footer">
-  Generated on Fri Mar  4 17:56:25 2011 by 
+  Generated on Mon Mar 14 22:31:45 2011 by 
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.6.4 (ruby-1.8.7).
 </div>

data/doc/_index.html

@@ -92,16 +92,16 @@
             <ul>
               
                 <li>
-                  <span class='object_link'><a href="MailEngine/Sendgrid/Base.html" title="MailEngine::Sendgrid::Base (module)">Base</a></span> 
+                  <span class='object_link'><a href="ActionMailer/Base.html" title="ActionMailer::Base (class)">Base</a></span> 
                   
-                    <small>(MailEngine::Sendgrid)</small>
+                    <small>(ActionMailer)</small>
                   
                 </li>
               
                 <li>
-                  <span class='object_link'><a href="ActionMailer/Base.html" title="ActionMailer::Base (class)">Base</a></span> 
+                  <span class='object_link'><a href="MailEngine/Sendgrid/Base.html" title="MailEngine::Sendgrid::Base (module)">Base</a></span> 
                   
-                    <small>(ActionMailer)</small>
+                    <small>(MailEngine::Sendgrid)</small>
                   
                 </li>
               
@@ -243,6 +243,19 @@
             </td><td valign='top' width="33%">
             
           
+          <ul id="alpha_L" class="alpha">
+            <li class="letter">L</li>
+            <ul>
+              
+                <li>
+                  <span class='object_link'><a href="LiquidView.html" title="LiquidView (class)">LiquidView</a></span> 
+                  
+                </li>
+              
+            </ul>
+          </ul>
+        
+          
           <ul id="alpha_M" class="alpha">
             <li class="letter">M</li>
             <ul>
@@ -259,6 +272,13 @@
                   
                 </li>
               
+                <li>
+                  <span class='object_link'><a href="MailEngine/MailTemplateResolver.html" title="MailEngine::MailTemplateResolver (class)">MailTemplateResolver</a></span> 
+                  
+                    <small>(MailEngine)</small>
+                  
+                </li>
+              
             </ul>
           </ul>
         
@@ -327,7 +347,7 @@
 </div></div>
     
     <div id="footer">
-  Generated on Fri Mar  4 17:56:24 2011 by 
+  Generated on Mon Mar 14 22:31:43 2011 by 
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.6.4 (ruby-1.8.7).
 </div>

data/doc/class_list.html

@@ -27,7 +27,7 @@
 
       <ul id="full_list" class="class">
         <li><span class='object_link'><a href="top-level-namespace.html" title=" (root)">Top Level Namespace</a></span></li>
-<li><a class='toggle'></a> <span class='object_link'><a href="ActionMailer.html" title="ActionMailer (module)">ActionMailer</a></span><small class='search_info'>Top Level Namespace</small></li><ul><li><span class='object_link'><a href="ActionMailer/Base.html" title="ActionMailer::Base (class)">Base</a></span> &lt; Object<small class='search_info'>ActionMailer</small></li><li><span class='object_link'><a href="ActionMailer/Collector.html" title="ActionMailer::Collector (class)">Collector</a></span> &lt; Object<small class='search_info'>ActionMailer</small></li></ul><li><a class='toggle'></a> <span class='object_link'><a href="MailEngine.html" title="MailEngine (module)">MailEngine</a></span><small class='search_info'>Top Level Namespace</small></li><ul><li><a class='toggle'></a> <span class='object_link'><a href="MailEngine/ActsAsMailReceiver.html" title="MailEngine::ActsAsMailReceiver (module)">ActsAsMailReceiver</a></span><small class='search_info'>MailEngine</small></li><ul><li><span class='object_link'><a href="MailEngine/ActsAsMailReceiver/ClassMethods.html" title="MailEngine::ActsAsMailReceiver::ClassMethods (module)">ClassMethods</a></span><small class='search_info'>MailEngine::ActsAsMailReceiver</small></li></ul><li><span class='object_link'><a href="MailEngine/Base.html" title="MailEngine::Base (class)">Base</a></span> &lt; Object<small class='search_info'>MailEngine</small></li><li><span class='object_link'><a href="MailEngine/Configuration.html" title="MailEngine::Configuration (class)">Configuration</a></span> &lt; Object<small class='search_info'>MailEngine</small></li><li><span class='object_link'><a href="MailEngine/CopyMigrations.html" title="MailEngine::CopyMigrations (class)">CopyMigrations</a></span> &lt; Base<small class='search_info'>MailEngine</small></li><li><span class='object_link'><a href="MailEngine/CopyResources.html" title="MailEngine::CopyResources (class)">CopyResources</a></span> &lt; Base<small class='search_info'>MailEngine</small></li><li><span class='object_link'><a href="MailEngine/CreateConfig.html" title="MailEngine::CreateConfig (class)">CreateConfig</a></span> &lt; Base<small class='search_info'>MailEngine</small></li><li><span class='object_link'><a href="MailEngine/Engine.html" title="MailEngine::Engine (class)">Engine</a></span> &lt; Engine<small class='search_info'>MailEngine</small></li><li><span class='object_link'><a href="MailEngine/HtmlDocumentAssetsReplacer.html" title="MailEngine::HtmlDocumentAssetsReplacer (class)">HtmlDocumentAssetsReplacer</a></span> &lt; Object<small class='search_info'>MailEngine</small></li><li><span class='object_link'><a href="MailEngine/Install.html" title="MailEngine::Install (class)">Install</a></span> &lt; Base<small class='search_info'>MailEngine</small></li><li><span class='object_link'><a href="MailEngine/MailLogSubscriber.html" title="MailEngine::MailLogSubscriber (class)">MailLogSubscriber</a></span> &lt; LogSubscriber<small class='search_info'>MailEngine</small></li><li><a class='toggle'></a> <span class='object_link'><a href="MailEngine/Sendgrid.html" title="MailEngine::Sendgrid (module)">Sendgrid</a></span><small class='search_info'>MailEngine</small></li><ul><li><a class='toggle'></a> <span class='object_link'><a href="MailEngine/Sendgrid/Base.html" title="MailEngine::Sendgrid::Base (module)">Base</a></span><small class='search_info'>MailEngine::Sendgrid</small></li><ul><li><span class='object_link'><a href="MailEngine/Sendgrid/Base/ClassMethods.html" title="MailEngine::Sendgrid::Base::ClassMethods (module)">ClassMethods</a></span><small class='search_info'>MailEngine::Sendgrid::Base</small></li><li><span class='object_link'><a href="MailEngine/Sendgrid/Base/InstanceMethods.html" title="MailEngine::Sendgrid::Base::InstanceMethods (module)">InstanceMethods</a></span><small class='search_info'>MailEngine::Sendgrid::Base</small></li></ul><li><span class='object_link'><a href="MailEngine/Sendgrid/FilterSetting.html" title="MailEngine::Sendgrid::FilterSetting (class)">FilterSetting</a></span> &lt; Object<small class='search_info'>MailEngine::Sendgrid</small></li><li><span class='object_link'><a href="MailEngine/Sendgrid/RestApi.html" title="MailEngine::Sendgrid::RestApi (class)">RestApi</a></span> &lt; Object<small class='search_info'>MailEngine::Sendgrid</small></li><li><span class='object_link'><a href="MailEngine/Sendgrid/RestApiError.html" title="MailEngine::Sendgrid::RestApiError (class)">RestApiError</a></span> &lt; StandardError<small class='search_info'>MailEngine::Sendgrid</small></li><li><span class='object_link'><a href="MailEngine/Sendgrid/SmtpApi.html" title="MailEngine::Sendgrid::SmtpApi (class)">SmtpApi</a></span> &lt; Object<small class='search_info'>MailEngine::Sendgrid</small></li></ul><li><span class='object_link'><a href="MailEngine/ZipProcessor.html" title="MailEngine::ZipProcessor (class)">ZipProcessor</a></span> &lt; Object<small class='search_info'>MailEngine</small></li></ul>
+<li><a class='toggle'></a> <span class='object_link'><a href="ActionMailer.html" title="ActionMailer (module)">ActionMailer</a></span><small class='search_info'>Top Level Namespace</small></li><ul><li><span class='object_link'><a href="ActionMailer/Base.html" title="ActionMailer::Base (class)">Base</a></span> &lt; Object<small class='search_info'>ActionMailer</small></li><li><span class='object_link'><a href="ActionMailer/Collector.html" title="ActionMailer::Collector (class)">Collector</a></span> &lt; Object<small class='search_info'>ActionMailer</small></li></ul><li><span class='object_link'><a href="LiquidView.html" title="LiquidView (class)">LiquidView</a></span> &lt; Object<small class='search_info'>Top Level Namespace</small></li><li><a class='toggle'></a> <span class='object_link'><a href="MailEngine.html" title="MailEngine (module)">MailEngine</a></span><small class='search_info'>Top Level Namespace</small></li><ul><li><a class='toggle'></a> <span class='object_link'><a href="MailEngine/ActsAsMailReceiver.html" title="MailEngine::ActsAsMailReceiver (module)">ActsAsMailReceiver</a></span><small class='search_info'>MailEngine</small></li><ul><li><span class='object_link'><a href="MailEngine/ActsAsMailReceiver/ClassMethods.html" title="MailEngine::ActsAsMailReceiver::ClassMethods (module)">ClassMethods</a></span><small class='search_info'>MailEngine::ActsAsMailReceiver</small></li></ul><li><span class='object_link'><a href="MailEngine/Base.html" title="MailEngine::Base (class)">Base</a></span> &lt; Object<small class='search_info'>MailEngine</small></li><li><span class='object_link'><a href="MailEngine/Configuration.html" title="MailEngine::Configuration (class)">Configuration</a></span> &lt; Object<small class='search_info'>MailEngine</small></li><li><span class='object_link'><a href="MailEngine/CopyMigrations.html" title="MailEngine::CopyMigrations (class)">CopyMigrations</a></span> &lt; Base<small class='search_info'>MailEngine</small></li><li><span class='object_link'><a href="MailEngine/CopyResources.html" title="MailEngine::CopyResources (class)">CopyResources</a></span> &lt; Base<small class='search_info'>MailEngine</small></li><li><span class='object_link'><a href="MailEngine/CreateConfig.html" title="MailEngine::CreateConfig (class)">CreateConfig</a></span> &lt; Base<small class='search_info'>MailEngine</small></li><li><span class='object_link'><a href="MailEngine/Engine.html" title="MailEngine::Engine (class)">Engine</a></span> &lt; Engine<small class='search_info'>MailEngine</small></li><li><span class='object_link'><a href="MailEngine/HtmlDocumentAssetsReplacer.html" title="MailEngine::HtmlDocumentAssetsReplacer (class)">HtmlDocumentAssetsReplacer</a></span> &lt; Object<small class='search_info'>MailEngine</small></li><li><span class='object_link'><a href="MailEngine/Install.html" title="MailEngine::Install (class)">Install</a></span> &lt; Base<small class='search_info'>MailEngine</small></li><li><span class='object_link'><a href="MailEngine/MailLogSubscriber.html" title="MailEngine::MailLogSubscriber (class)">MailLogSubscriber</a></span> &lt; LogSubscriber<small class='search_info'>MailEngine</small></li><li><span class='object_link'><a href="MailEngine/MailTemplateResolver.html" title="MailEngine::MailTemplateResolver (class)">MailTemplateResolver</a></span> &lt; Resolver<small class='search_info'>MailEngine</small></li><li><a class='toggle'></a> <span class='object_link'><a href="MailEngine/Sendgrid.html" title="MailEngine::Sendgrid (module)">Sendgrid</a></span><small class='search_info'>MailEngine</small></li><ul><li><a class='toggle'></a> <span class='object_link'><a href="MailEngine/Sendgrid/Base.html" title="MailEngine::Sendgrid::Base (module)">Base</a></span><small class='search_info'>MailEngine::Sendgrid</small></li><ul><li><span class='object_link'><a href="MailEngine/Sendgrid/Base/ClassMethods.html" title="MailEngine::Sendgrid::Base::ClassMethods (module)">ClassMethods</a></span><small class='search_info'>MailEngine::Sendgrid::Base</small></li><li><span class='object_link'><a href="MailEngine/Sendgrid/Base/InstanceMethods.html" title="MailEngine::Sendgrid::Base::InstanceMethods (module)">InstanceMethods</a></span><small class='search_info'>MailEngine::Sendgrid::Base</small></li></ul><li><span class='object_link'><a href="MailEngine/Sendgrid/FilterSetting.html" title="MailEngine::Sendgrid::FilterSetting (class)">FilterSetting</a></span> &lt; Object<small class='search_info'>MailEngine::Sendgrid</small></li><li><span class='object_link'><a href="MailEngine/Sendgrid/RestApi.html" title="MailEngine::Sendgrid::RestApi (class)">RestApi</a></span> &lt; Object<small class='search_info'>MailEngine::Sendgrid</small></li><li><span class='object_link'><a href="MailEngine/Sendgrid/RestApiError.html" title="MailEngine::Sendgrid::RestApiError (class)">RestApiError</a></span> &lt; StandardError<small class='search_info'>MailEngine::Sendgrid</small></li><li><span class='object_link'><a href="MailEngine/Sendgrid/SmtpApi.html" title="MailEngine::Sendgrid::SmtpApi (class)">SmtpApi</a></span> &lt; Object<small class='search_info'>MailEngine::Sendgrid</small></li></ul><li><span class='object_link'><a href="MailEngine/ZipProcessor.html" title="MailEngine::ZipProcessor (class)">ZipProcessor</a></span> &lt; Object<small class='search_info'>MailEngine</small></li></ul>
 
       </ul>
     </div>

data/doc/file.README.html

@@ -97,12 +97,73 @@ to fit our needs in real project:</p>
 
 <p><strong> Step 4: </strong></p>
 
+<p>Add acts<em>as</em>mail_receiver definition to "Your User" model.</p>
+
+<pre class="code"><span class='class class kw'>class</span> <span class='User constant id'>User</span> <span class='lt op'>&lt;</span> <span class='AR constant id'>AR</span>
+  <span class='acts_as_mail_receiver identifier id'>acts_as_mail_receiver</span> <span class='symbol val'>:payload_columns</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='dstring node'>%w{firstname lastname}</span><span class='comma token'>,</span>
+                        <span class='symbol val'>:groups</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='dstring node'>%w{all english_users chinese_users}</span>
+<span class='end end kw'>end</span>
+</pre>
+
+<ol>
+<li> User model must have 'email' and payload specified columns, or else you can delegate to other model.</li>
+<li> "acts<em>as</em>mail_receiver" statement has to place below the scope statements.</li>
+</ol>
+
+
+<p><strong> Step 5: </strong></p>
+
+<p>Add sendgrid smtp api configure:</p>
+
+<pre class="code"><span class='class class kw'>class</span> <span class='UserMailer constant id'>UserMailer</span> <span class='lt op'>&lt;</span> <span class='ActionMailer constant id'>ActionMailer</span><span class='colon2 op'>::</span><span class='Base constant id'>Base</span>
+  <span class='sendgrid_header identifier id'>sendgrid_header</span> <span class='do do kw'>do</span>
+    <span class='category identifier id'>category</span> <span class='string val'>&quot;xxx&quot;</span>
+
+    <span class='filters identifier id'>filters</span> <span class='lbrace token'>{</span>
+      <span class='opentrack identifier id'>opentrack</span> <span class='string val'>&quot;enable&quot;</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='integer val'>1</span>
+      <span class='clicktrack identifier id'>clicktrack</span> <span class='string val'>&quot;enable&quot;</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='integer val'>1</span>
+      <span class='subscriptiontrack identifier id'>subscriptiontrack</span> <span class='string val'>&quot;enable&quot;</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='integer val'>0</span>
+      <span class='template identifier id'>template</span> <span class='string val'>&quot;enable&quot;</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='integer val'>0</span>
+      <span class='footer identifier id'>footer</span> <span class='string val'>&quot;enable&quot;</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='integer val'>0</span>
+    <span class='rbrace token'>}</span>
+  <span class='end end kw'>end</span>
+<span class='end end kw'>end</span>
+</pre>
+
+<p>For the detail information please check sendgrid.com.</p>
+
+<p><strong> Step 6: </strong></p>
+
+<p>Add below line to production.rb or development.rb for specifing the host.
+it will used when generate resource url when upload zip file.</p>
+
+<pre class="code"><span class='config identifier id'>config</span><span class='dot token'>.</span><span class='action_mailer identifier id'>action_mailer</span><span class='dot token'>.</span><span class='default_url_options identifier id'>default_url_options</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span> <span class='symbol val'>:host</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='string val'>&quot;lvh.me:3000&quot;</span> <span class='rbrace token'>}</span>
+</pre>
+
+<p><strong> Step 7: </strong></p>
+
 <p>Add below line to the crontab list of your sever:</p>
 
 <pre class="code"><span class='comment val'>### check mail schedule for every 15 minutes ###</span>
 <span class='mult op'>*</span><span class='regexp val'>/4 * * * * sh -c &quot;cd /</span><span class='path identifier id'>path</span><span class='div op'>/</span><span class='to identifier id'>to</span><span class='div op'>/</span><span class='your identifier id'>your</span><span class='div op'>/</span><span class='system identifier id'>system</span> <span class='andop op'>&amp;&amp;</span> <span class='rake identifier id'>rake</span> <span class='mail_engine identifier id'>mail_engine</span><span class='symbol val'>:sendmail</span> <span class='RAILS_ENV constant id'>RAILS_ENV</span><span class='assign token'>=</span><span class='production identifier id'>production</span><span class='string val'>&quot;
 </span></pre>
 
+<h1>Configuration</h1>
+
+<p>Below is the config for development env.</p>
+
+<pre class="code"><span class='development identifier id'>development</span><span class='colon op'>:</span>
+  <span class='log_mail identifier id'>log_mail</span><span class='colon op'>:</span> <span class='false false kw'>false</span>                                 <span class='comment val'># if you want to enable the mail log, set true.</span>
+  <span class='user_class_name identifier id'>user_class_name</span><span class='colon op'>:</span> <span class='string val'>&quot;User&quot;</span>                         <span class='comment val'># Specify the User model in your system, which will used for mail schedule feature to find user groups and payloads.</span>
+  <span class='mount_at identifier id'>mount_at</span><span class='colon op'>:</span> <span class='string val'>&quot;/admin/mail_engine&quot;</span>                  <span class='comment val'># set the url path for mail engine.</span>
+  <span class='access_check_method identifier id'>access_check_method</span><span class='colon op'>:</span> <span class='string val'>&quot;logged_in?&quot;</span>               <span class='comment val'># set a method name which will execute before each page action in mail engine.</span>
+  <span class='replacement_email identifier id'>replacement_email</span><span class='colon op'>:</span> <span class='string val'>&quot;dev@youdomain.com&quot;</span>          <span class='comment val'># if you want to send all mail to one email, like on staging server or development environment, you can set this, or else don't set it.</span>
+  <span class='sendgrid identifier id'>sendgrid</span><span class='colon op'>:</span>                                       <span class='comment val'># Below you need to set the sendgrid account info.</span>
+    <span class='sendgrid_user identifier id'>sendgrid_user</span><span class='colon op'>:</span> <span class='string val'>&quot;you send grid username&quot;</span>       <span class='comment val'># </span>
+    <span class='sendgrid_key identifier id'>sendgrid_key</span><span class='colon op'>:</span> <span class='string val'>&quot;password&quot;</span>                      <span class='comment val'># </span>
+    <span class='sendgrid_category identifier id'>sendgrid_category</span><span class='colon op'>:</span> <span class='string val'>&quot;my sendgrid category&quot;</span>     <span class='comment val'># </span>
+</pre>
+
 <h1>Usage</h1>
 
 <p><strong> For System Mail: </strong></p>
@@ -143,6 +204,13 @@ MailEngine::MailDispatcher.marketing mail template name(:to => "Michael he <a hr
 
 <p>Currently only support above rails3.</p>
 
+<h1>Tips</h1>
+
+<p>Use below rake task, you can export local mail engine data, then import to production environment.</p>
+
+<pre class="code"><span class='rake identifier id'>rake</span> <span class='mail_engine identifier id'>mail_engine</span><span class='symbol val'>:export_mail_engine_database</span>
+</pre>
+
 <h1>Screenshots</h1>
 
 <h2>Dashboard</h2>
@@ -203,7 +271,7 @@ MailEngine::MailDispatcher.marketing mail template name(:to => "Michael he <a hr
 <li>Sending Period.</li>
 <li>Payloads which load from user model and send to template when sending.</li>
 <li>First send date time, this date will indicate when this mail will be send first time, and according to the seding period it will resend at the same time after one period.</li>
-<li>You can set requirements, which been predefined in the system, let the mail not been sent if the requirements is unreached.</li>
+<li>You can control if run the schedule or not.</li>
 </ol>
 
 
@@ -226,7 +294,7 @@ MailEngine::MailDispatcher.marketing mail template name(:to => "Michael he <a hr
 <p><img src="https://github.com/hlxwell/mail-engine/raw/master/screenshots/bounce_report.png" title="Bounce Report" alt="Bounce Report" /></p></div></div>
     
     <div id="footer">
-  Generated on Fri Mar  4 17:56:24 2011 by 
+  Generated on Mon Mar 14 22:31:43 2011 by 
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.6.4 (ruby-1.8.7).
 </div>

data/doc/index.html

@@ -97,12 +97,73 @@ to fit our needs in real project:</p>
 
 <p><strong> Step 4: </strong></p>
 
+<p>Add acts<em>as</em>mail_receiver definition to "Your User" model.</p>
+
+<pre class="code"><span class='class class kw'>class</span> <span class='User constant id'>User</span> <span class='lt op'>&lt;</span> <span class='AR constant id'>AR</span>
+  <span class='acts_as_mail_receiver identifier id'>acts_as_mail_receiver</span> <span class='symbol val'>:payload_columns</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='dstring node'>%w{firstname lastname}</span><span class='comma token'>,</span>
+                        <span class='symbol val'>:groups</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='dstring node'>%w{all english_users chinese_users}</span>
+<span class='end end kw'>end</span>
+</pre>
+
+<ol>
+<li> User model must have 'email' and payload specified columns, or else you can delegate to other model.</li>
+<li> "acts<em>as</em>mail_receiver" statement has to place below the scope statements.</li>
+</ol>
+
+
+<p><strong> Step 5: </strong></p>
+
+<p>Add sendgrid smtp api configure:</p>
+
+<pre class="code"><span class='class class kw'>class</span> <span class='UserMailer constant id'>UserMailer</span> <span class='lt op'>&lt;</span> <span class='ActionMailer constant id'>ActionMailer</span><span class='colon2 op'>::</span><span class='Base constant id'>Base</span>
+  <span class='sendgrid_header identifier id'>sendgrid_header</span> <span class='do do kw'>do</span>
+    <span class='category identifier id'>category</span> <span class='string val'>&quot;xxx&quot;</span>
+
+    <span class='filters identifier id'>filters</span> <span class='lbrace token'>{</span>
+      <span class='opentrack identifier id'>opentrack</span> <span class='string val'>&quot;enable&quot;</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='integer val'>1</span>
+      <span class='clicktrack identifier id'>clicktrack</span> <span class='string val'>&quot;enable&quot;</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='integer val'>1</span>
+      <span class='subscriptiontrack identifier id'>subscriptiontrack</span> <span class='string val'>&quot;enable&quot;</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='integer val'>0</span>
+      <span class='template identifier id'>template</span> <span class='string val'>&quot;enable&quot;</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='integer val'>0</span>
+      <span class='footer identifier id'>footer</span> <span class='string val'>&quot;enable&quot;</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='integer val'>0</span>
+    <span class='rbrace token'>}</span>
+  <span class='end end kw'>end</span>
+<span class='end end kw'>end</span>
+</pre>
+
+<p>For the detail information please check sendgrid.com.</p>
+
+<p><strong> Step 6: </strong></p>
+
+<p>Add below line to production.rb or development.rb for specifing the host.
+it will used when generate resource url when upload zip file.</p>
+
+<pre class="code"><span class='config identifier id'>config</span><span class='dot token'>.</span><span class='action_mailer identifier id'>action_mailer</span><span class='dot token'>.</span><span class='default_url_options identifier id'>default_url_options</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span> <span class='symbol val'>:host</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='string val'>&quot;lvh.me:3000&quot;</span> <span class='rbrace token'>}</span>
+</pre>
+
+<p><strong> Step 7: </strong></p>
+
 <p>Add below line to the crontab list of your sever:</p>
 
 <pre class="code"><span class='comment val'>### check mail schedule for every 15 minutes ###</span>
 <span class='mult op'>*</span><span class='regexp val'>/4 * * * * sh -c &quot;cd /</span><span class='path identifier id'>path</span><span class='div op'>/</span><span class='to identifier id'>to</span><span class='div op'>/</span><span class='your identifier id'>your</span><span class='div op'>/</span><span class='system identifier id'>system</span> <span class='andop op'>&amp;&amp;</span> <span class='rake identifier id'>rake</span> <span class='mail_engine identifier id'>mail_engine</span><span class='symbol val'>:sendmail</span> <span class='RAILS_ENV constant id'>RAILS_ENV</span><span class='assign token'>=</span><span class='production identifier id'>production</span><span class='string val'>&quot;
 </span></pre>
 
+<h1>Configuration</h1>
+
+<p>Below is the config for development env.</p>
+
+<pre class="code"><span class='development identifier id'>development</span><span class='colon op'>:</span>
+  <span class='log_mail identifier id'>log_mail</span><span class='colon op'>:</span> <span class='false false kw'>false</span>                                 <span class='comment val'># if you want to enable the mail log, set true.</span>
+  <span class='user_class_name identifier id'>user_class_name</span><span class='colon op'>:</span> <span class='string val'>&quot;User&quot;</span>                         <span class='comment val'># Specify the User model in your system, which will used for mail schedule feature to find user groups and payloads.</span>
+  <span class='mount_at identifier id'>mount_at</span><span class='colon op'>:</span> <span class='string val'>&quot;/admin/mail_engine&quot;</span>                  <span class='comment val'># set the url path for mail engine.</span>
+  <span class='access_check_method identifier id'>access_check_method</span><span class='colon op'>:</span> <span class='string val'>&quot;logged_in?&quot;</span>               <span class='comment val'># set a method name which will execute before each page action in mail engine.</span>
+  <span class='replacement_email identifier id'>replacement_email</span><span class='colon op'>:</span> <span class='string val'>&quot;dev@youdomain.com&quot;</span>          <span class='comment val'># if you want to send all mail to one email, like on staging server or development environment, you can set this, or else don't set it.</span>
+  <span class='sendgrid identifier id'>sendgrid</span><span class='colon op'>:</span>                                       <span class='comment val'># Below you need to set the sendgrid account info.</span>
+    <span class='sendgrid_user identifier id'>sendgrid_user</span><span class='colon op'>:</span> <span class='string val'>&quot;you send grid username&quot;</span>       <span class='comment val'># </span>
+    <span class='sendgrid_key identifier id'>sendgrid_key</span><span class='colon op'>:</span> <span class='string val'>&quot;password&quot;</span>                      <span class='comment val'># </span>
+    <span class='sendgrid_category identifier id'>sendgrid_category</span><span class='colon op'>:</span> <span class='string val'>&quot;my sendgrid category&quot;</span>     <span class='comment val'># </span>
+</pre>
+
 <h1>Usage</h1>
 
 <p><strong> For System Mail: </strong></p>
@@ -143,6 +204,13 @@ MailEngine::MailDispatcher.marketing mail template name(:to => "Michael he <a hr
 
 <p>Currently only support above rails3.</p>
 
+<h1>Tips</h1>
+
+<p>Use below rake task, you can export local mail engine data, then import to production environment.</p>
+
+<pre class="code"><span class='rake identifier id'>rake</span> <span class='mail_engine identifier id'>mail_engine</span><span class='symbol val'>:export_mail_engine_database</span>
+</pre>
+
 <h1>Screenshots</h1>
 
 <h2>Dashboard</h2>
@@ -203,7 +271,7 @@ MailEngine::MailDispatcher.marketing mail template name(:to => "Michael he <a hr
 <li>Sending Period.</li>
 <li>Payloads which load from user model and send to template when sending.</li>
 <li>First send date time, this date will indicate when this mail will be send first time, and according to the seding period it will resend at the same time after one period.</li>
-<li>You can set requirements, which been predefined in the system, let the mail not been sent if the requirements is unreached.</li>
+<li>You can control if run the schedule or not.</li>
 </ol>
 
 
@@ -226,7 +294,7 @@ MailEngine::MailDispatcher.marketing mail template name(:to => "Michael he <a hr
 <p><img src="https://github.com/hlxwell/mail-engine/raw/master/screenshots/bounce_report.png" title="Bounce Report" alt="Bounce Report" /></p></div></div>
     
     <div id="footer">
-  Generated on Fri Mar  4 17:56:24 2011 by 
+  Generated on Mon Mar 14 22:31:43 2011 by 
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.6.4 (ruby-1.8.7).
 </div>