RubyGems - mail_engine - Versions diffs - 0.0.1 → 0.1.0 - Mend

mail_engine 0.0.1 → 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (452) hide show

data/doc/index.html ADDED Viewed

@@ -0,0 +1,231 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta name="Content-Type" content="text/html; charset=utf-8" />
+<title>Documentation by YARD 0.6.4</title>
+<link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
+<link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  relpath = '';
+  if (relpath != '') relpath += '/';
+</script>
+<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+  </head>
+  <body>
+    <script type="text/javascript" charset="utf-8">
+      if (window.top.frames.main) document.body.className = 'frames';
+    </script>
+    <div id="header">
+      <div id="menu">
+    <a href="_index.html" title="Index">Index</a> &raquo;
+    <span class="title">File: README</span>
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+      <div id="search">
+  <a id="class_list_link" href="#">Class List</a>
+  <a id="method_list_link" href="#">Method List</a>
+  <a id ="file_list_link" href="#">File List</a>
+</div>
+      <div class="clear"></div>
+    </div>
+    <iframe id="search_frame"></iframe>
+    <div id="content"><div id='filecontents'><h1>Why Mail Engine</h1>
+<ol>
+<li>Don't need to export and import your system data to any other mail systems(like mailchimp, mad_mimi).</li>
+<li>Allow user to edit all email templates directly in system admin, save the time of developer to participate in.</li>
+<li>Allow user to add mail sending schedule directly in system admin, don't need developer to add
+them into code or deploy crontab at server each time when client have new request.</li>
+<li>Fully take advantage of the convenience of loading any system data to mail template. In the past,
+like using mailchimp, you have to store everything into user list, then you are able to load that into
+mail template, it increased the complexity of maintaining information in another system.</li>
+<li>If you want to trace your mail, like open rate, click rate and unsubscribe rate, we provide Sendgrid
+integration configuration to take advantage that system. (More information at http://sendgrid.com)</li>
+<li>Allow logging all sent mails, you can check which mail been sent to which user.</li>
+<li>You can know send the email to the active users, so that you don't need to waste your credits of sendgrid or amazon.</li>
+</ol>
+<h1>Problem when using third party mail system</h1>
+<p>We are using mailchimp mostly for the newsletter solution, but it's has many problems that we have to make a new mail engine
+to fit our needs in real project:</p>
+<ol>
+<li>It is only one newsletter or marketing mail solution, so for system mail, it can do nothing, so for system mail we still go the original way (put them in the rails project.)</li>
+<li>Mailchimp don't support other encode for mail, when sending japanese or chinese mail it will be failed.</li>
+<li>It doesn't support localization, so different language is different campaign, you need to set a lot config for each of them.</li>
+<li>Manage user list is awkward, it even can't create list by API, so you have to create list one by one by hand.</li>
+<li>It can't load other user personal or customized data from system into mail, like latest unchecked news or messages, it's very limited to load info from user list record.</li>
+<li>It doesn't support reusable partials, which like you hope to put a fixed content of footer or header.</li>
+<li>It doesn't support recurring mail sending.</li>
+</ol>
+<h1>Installation</h1>
+<p><strong> Step 1: </strong></p>
+<pre class="code"><span class='gem identifier id'>gem</span> <span class='install identifier id'>install</span> <span class='mail_engine identifier id'>mail_engine</span>
+</pre>
+<p><strong> Step 2: </strong></p>
+<p>Add management page needed javascript lib and css files, migration files and mail<em>engine</em>config.yml under config directory.</p>
+<pre class="code"><span class='rails identifier id'>rails</span> <span class='g identifier id'>g</span> <span class='mail_engine identifier id'>mail_engine</span><span class='symbol val'>:install</span>
+</pre>
+<p><strong> Step 3: </strong></p>
+<p>Run migration.</p>
+<pre class="code"><span class='rake identifier id'>rake</span> <span class='db identifier id'>db</span><span class='symbol val'>:migrate</span>
+</pre>
+<p><strong> Step 4: </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>Usage</h1>
+<p><strong> For System Mail: </strong></p>
+<p>Due to the sender of system mail is ActionMailer, so you just need to set template physical store path (e.g. user_mailer/notify)
+as the mailer template load path, system will load it from database. (Notice, database template will
+override your file template.)</p>
+<p>Mail Engine use Liquid template engine, so you can read the Liquid Reference at http://www.liquidmarkup.org/</p>
+<p>Steps:</p>
+<ol>
+<li>Create a template in mail engine.</li>
+</ol>
+<p><strong> For Marketing Mail: </strong></p>
+<p>For normal marketing mails are quite simple in logic, so don't need logic code in the mail template.
+So we provide a mail dispatcher which allows user can send marketing mail only by providing the template and
+select the data pre-defined in system to the mail template, don't need developer to do anything like adding mailer file.</p>
+<p>Steps:</p>
+<ol>
+<li>Create a mail tempate in mail engine.</li>
+<li>Create a sending schedule record. (You can specify the users to receive this mail, total sending count,
+sending period, when start to deliver the first mail and load which data into this template, You also can set
+condition for the scheduler, like if no specified data in collection, don't send the mail.)</li>
+</ol>
+<p>You also can send mail in your program by using:
+MailEngine::MailDispatcher.marketing mail template name(:to => "Michael he <a href="&#x6d;&#97;&#x69;&#x6c;&#x74;&#x6f;&#58;&#104;&#x6c;&#x78;&#119;&#x65;&#108;&#x6c;&#x40;&#103;&#109;&#97;&#105;&#108;&#x2e;&#99;&#x6f;&#x6d;">&#104;&#108;&#120;&#x77;&#x65;&#x6c;&#x6c;&#64;&#103;&#109;&#x61;&#x69;&#x6c;&#46;&#x63;&#111;&#x6d;</a>", :values => => "Michael He").deliver</p>
+<h1>Screenshots</h1>
+<h2>Dashboard</h2>
+<p>Shows the latest report.</p>
+<p><img src="https://github.com/hlxwell/mail-engine/raw/master/screenshots/dashboard.png" title="Dashboard" alt="Dashboard" /></p>
+<h2>Template Management</h2>
+<p>You can manage the template used in your system, including:</p>
+<ol>
+<li>System mail, has it's own action mailer file.</li>
+<li>Marketing mail, simple logic and without it's own action mailer.</li>
+<li>Partials, you can reused it in any other templates.</li>
+</ol>
+<p><img src="https://github.com/hlxwell/mail-engine/raw/master/screenshots/templates.png" title="Template Management" alt="Template Management" /></p>
+<h2>Template editing Page</h2>
+<p>You can see here are many details you can change:</p>
+<ol>
+<li>Template Path, system action mailer can find it when lookup mail template.</li>
+<li>Locale</li>
+<li>Format</li>
+<li>Layout</li>
+<li>Files will used in the template.</li>
+<li>Zip File when you used at creating this template.</li>
+<li>Preview template in time.</li>
+</ol>
+<p><img src="https://github.com/hlxwell/mail-engine/raw/master/screenshots/editing_mail_template.png" title="Template editing Preview" alt="Template editing Preview" /></p>
+<h2>Upload html template with image in a zip file</h2>
+<p>You can create a template by uplaoding a zip file including one html and other images or css files.</p>
+<p><img src="https://github.com/hlxwell/mail-engine/raw/master/screenshots/new_by_upload.png" title="Upload html template with image in a zip file." alt="Upload html template with image in a zip file.&quot;)" /></p>
+<h2>Partial and Layout selection</h2>
+<p><img src="https://github.com/hlxwell/mail-engine/raw/master/screenshots/select_layout_partial.png" title="Partial and Layout selection" alt="Partial and Layout selection" /></p>
+<h2>Mail Schedule</h2>
+<p>You can set a mail sending schedule, here are some useful setting items:</p>
+<ol>
+<li>Marketing Mail Template.</li>
+<li>User Group will be received this mail.</li>
+<li>Total send count.</li>
+<li>Already send count.</li>
+<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>
+</ol>
+<p><img src="https://github.com/hlxwell/mail-engine/raw/master/screenshots/schedule.png" title="Mail Schedule" alt="Mail Schedule" /></p>
+<h2>Mail Logs</h2>
+<p>It will log all mails' content been sent, you can turn it off in config file.</p>
+<p><img src="https://github.com/hlxwell/mail-engine/raw/master/screenshots/logs.png" title="Mail Logs" alt="Mail Logs" /></p>
+<h2>Report</h2>
+<p>Shows detail chart and data list of mail sending stats.</p>
+<p><img src="https://github.com/hlxwell/mail-engine/raw/master/screenshots/reports.png" title="Report" alt="Report" /></p>
+<h2>Bounce Report</h2>
+<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 00:23:18 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>
+  </body>
+</html>

data/doc/method_list.html CHANGED Viewed

@@ -85,17 +85,49 @@
   <li class="r2 ">
-    <span class='object_link'><a href="MailEngine/CreateConfig.html#create_config_file-instance_method" title="MailEngine::CreateConfig#create_config_file (method)">#create_config_file</a></span>
+    <span class='object_link'><a href="MailEngine/CopyMigrations.html#copy_migrations-instance_method" title="MailEngine::CopyMigrations#copy_migrations (method)">#copy_migrations</a></span>
-      <small>MailEngine::CreateConfig</small>
+      <small>MailEngine::CopyMigrations</small>
   </li>
   <li class="r1 ">
-    <span class='object_link'><a href="MailEngine/CreateMigration.html#create_migrations-instance_method" title="MailEngine::CreateMigration#create_migrations (method)">#create_migrations</a></span>
+    <span class='object_link'><a href="MailEngine/Install.html#copy_migrations-instance_method" title="MailEngine::Install#copy_migrations (method)">#copy_migrations</a></span>
-      <small>MailEngine::CreateMigration</small>
+      <small>MailEngine::Install</small>
+  </li>
+  <li class="r2 ">
+    <span class='object_link'><a href="MailEngine/CopyResources.html#copy_resources-instance_method" title="MailEngine::CopyResources#copy_resources (method)">#copy_resources</a></span>
+      <small>MailEngine::CopyResources</small>
+  </li>
+  <li class="r1 ">
+    <span class='object_link'><a href="MailEngine/Install.html#copy_resources-instance_method" title="MailEngine::Install#copy_resources (method)">#copy_resources</a></span>
+      <small>MailEngine::Install</small>
+  </li>
+  <li class="r2 ">
+    <span class='object_link'><a href="MailEngine/Install.html#create_config-instance_method" title="MailEngine::Install#create_config (method)">#create_config</a></span>
+      <small>MailEngine::Install</small>
+  </li>
+  <li class="r1 ">
+    <span class='object_link'><a href="MailEngine/CreateConfig.html#create_config_file-instance_method" title="MailEngine::CreateConfig#create_config_file (method)">#create_config_file</a></span>
+      <small>MailEngine::CreateConfig</small>
   </li>
@@ -197,7 +229,7 @@
   <li class="r2 ">
-    <span class='object_link'><a href="MailEngine/HtmlDocumentAssetsReplacer.html#replace_resource_filename_in_html-class_method" title="MailEngine::HtmlDocumentAssetsReplacer.replace_resource_filename_in_html (method)">replace_resource_filename_in_html</a></span>
+    <span class='object_link'><a href="MailEngine/HtmlDocumentAssetsReplacer.html#replace_resource_in_html-class_method" title="MailEngine::HtmlDocumentAssetsReplacer.replace_resource_in_html (method)">replace_resource_in_html</a></span>
       <small>MailEngine::HtmlDocumentAssetsReplacer</small>
@@ -205,22 +237,14 @@
   <li class="r1 ">
-    <span class='object_link'><a href="MailEngine/HtmlDocumentAssetsReplacer.html#replace_resource_url_in_html-class_method" title="MailEngine::HtmlDocumentAssetsReplacer.replace_resource_url_in_html (method)">replace_resource_url_in_html</a></span>
-      <small>MailEngine::HtmlDocumentAssetsReplacer</small>
-  </li>
-  <li class="r2 ">
-    <span class='object_link'><a href="MailEngine/Base.html#send_mail-class_method" title="MailEngine::Base.send_mail (method)">send_mail</a></span>
+    <span class='object_link'><a href="MailEngine/Base.html#send_marketing_mail-class_method" title="MailEngine::Base.send_marketing_mail (method)">send_marketing_mail</a></span>
       <small>MailEngine::Base</small>
   </li>
-  <li class="r1 ">
+  <li class="r2 ">
     <span class='object_link'><a href="MailEngine/Sendgrid/Base/ClassMethods.html#sendgrid_header-instance_method" title="MailEngine::Sendgrid::Base::ClassMethods#sendgrid_header (method)">#sendgrid_header</a></span>
       <small>MailEngine::Sendgrid::Base::ClassMethods</small>
@@ -228,7 +252,7 @@
   </li>
-  <li class="r2 ">
+  <li class="r1 ">
     <span class='object_link'><a href="MailEngine/Sendgrid/SmtpApi.html#set_unique_args-instance_method" title="MailEngine::Sendgrid::SmtpApi#set_unique_args (method)">#set_unique_args</a></span>
       <small>MailEngine::Sendgrid::SmtpApi</small>
@@ -236,7 +260,7 @@
   </li>
-  <li class="r1 ">
+  <li class="r2 ">
     <span class='object_link'><a href="MailEngine/Sendgrid/RestApi.html#spamreports-class_method" title="MailEngine::Sendgrid::RestApi.spamreports (method)">spamreports</a></span>
       <small>MailEngine::Sendgrid::RestApi</small>
@@ -244,7 +268,7 @@
   </li>
-  <li class="r2 ">
+  <li class="r1 ">
     <span class='object_link'><a href="MailEngine/Sendgrid/RestApi.html#stats-class_method" title="MailEngine::Sendgrid::RestApi.stats (method)">stats</a></span>
       <small>MailEngine::Sendgrid::RestApi</small>
@@ -252,7 +276,7 @@
   </li>
-  <li class="r1 ">
+  <li class="r2 ">
     <span class='object_link'><a href="MailEngine/Sendgrid/SmtpApi.html#to_hash-instance_method" title="MailEngine::Sendgrid::SmtpApi#to_hash (method)">#to_hash</a></span>
       <small>MailEngine::Sendgrid::SmtpApi</small>
@@ -260,7 +284,7 @@
   </li>
-  <li class="r2 ">
+  <li class="r1 ">
     <span class='object_link'><a href="MailEngine/Sendgrid/SmtpApi.html#to_json-instance_method" title="MailEngine::Sendgrid::SmtpApi#to_json (method)">#to_json</a></span>
       <small>MailEngine::Sendgrid::SmtpApi</small>
@@ -268,7 +292,7 @@
   </li>
-  <li class="r1 ">
+  <li class="r2 ">
     <span class='object_link'><a href="MailEngine/Sendgrid/SmtpApi.html#to_s-instance_method" title="MailEngine::Sendgrid::SmtpApi#to_s (method)">#to_s</a></span>
       <small>MailEngine::Sendgrid::SmtpApi</small>

data/doc/top-level-namespace.html ADDED Viewed

@@ -0,0 +1,88 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta name="Content-Type" content="text/html; charset=utf-8" />
+<title>Top Level Namespace</title>
+<link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
+<link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  relpath = '';
+  if (relpath != '') relpath += '/';
+</script>
+<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+  </head>
+  <body>
+    <script type="text/javascript" charset="utf-8">
+      if (window.top.frames.main) document.body.className = 'frames';
+    </script>
+    <div id="header">
+      <div id="menu">
+    <a href="_index.html">Index</a> &raquo;
+    <span class="title">Top Level Namespace</span>
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+      <div id="search">
+  <a id="class_list_link" href="#">Class List</a>
+  <a id="method_list_link" href="#">Method List</a>
+  <a id ="file_list_link" href="#">File List</a>
+</div>
+      <div class="clear"></div>
+    </div>
+    <iframe id="search_frame"></iframe>
+    <div id="content"><h1>Top Level Namespace
+</h1>
+<dl class="box">
+</dl>
+<div class="clear"></div>
+<h2>Defined Under Namespace</h2>
+<p class="children">
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="ActionMailer.html" title="ActionMailer (module)">ActionMailer</a></span>, <span class='object_link'><a href="MailEngine.html" title="MailEngine (module)">MailEngine</a></span>
+</p>
+</div>
+    <div id="footer">
+  Generated on Fri Mar  4 00:23:20 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>
+  </body>
+</html>