-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
60 lines (47 loc) · 4.23 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
<!DOCTYPE html>
<html>
<head>
<meta charset='utf-8'>
<link rel="stylesheet" type="text/css" href="stylesheets/stylesheet.css" media="screen" />
<link rel="stylesheet" type="text/css" href="stylesheets/pygment_trac.css" media="screen" />
<link rel="stylesheet" type="text/css" href="stylesheets/print.css" media="print" />
<title>email + JS = ♡</title>
</head>
<body>
<header>
<div class="container">
<h1>email + JS = ♡</h1>
</div>
</header>
<div class="container">
<section id="main_content">
<h3><a name="what-is-it" class="anchor" href="#what-is-it"><span class="octicon octicon-link"></span></a>What is it?</h3>
<p>emailJS is a set of components that can be used to write email apps in pure JavaScript on the client in HTML5 or on the server in node.js. Components include:</p>
<ul>
<li><a href="https://github.com/emailjs/emailjs-imap-client">An IMAP client written with ES2015</a></li>
<li><a href="https://github.com/emailjs/emailjs-smtp-client">An SMTP client</a></li>
<li><a href="https://github.com/emailjs/emailjs-mime-builder">A simple low-level RFC 2822 MIME builder</a></li>
<li><a href="https://github.com/emailjs/emailjs-mime-parser">A non-opinionated no-magic-involved low-level RFC 2822 MIME parser</a></li>
</ul>
<p>Check out all of the modules in our <a href="https://github.com/emailjs">emailJS GitHub organization</a></p>
<h3><a name="features" class="anchor" href="#features"><span class="octicon octicon-link"></span></a>Features</h3>
<ul>
<li>Open Source under the MIT license</li>
<li>High test coverage, continuously tested on TravisCI</li>
<li>Plain Old Modern Vanilla Javascript (<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Typed_arrays">Typed Arrays</a>, <a href="http://www.w3.org/TR/2013/WD-raw-sockets-20130514/">Raw Sockets</a>, and <a href="http://encoding.spec.whatwg.org/">TextEncoder</a>)</li>
</ul>
<h3><a name="dependencies" class="anchor" href="#dependencies"><span class="octicon octicon-link"></span></a>Dependencies</h3>
<p>In order to communicate over TCP the IMAP and SMTP components require apis that are currently only supported natively by Firefox OS. For platforms like <a href="https://developer.chrome.com/apps/about_apps">Chrome Apps</a>, <a href="http://nodejs.org/">node.js</a> and <a href="http://electron.atom.io/">Electron</a>, and <a href="https://github.com/nwjs/nw.js/">NW.js</a> that use non-standard apis, the following shims are used:</p>
<ul>
<li><a href="https://github.com/emailjs/emailjs-tcp-socket">emailjs-tcp-socket</a></li>
<li><a href="https://github.com/emailjs/emailjs-stringencoding">emailjs-stringencoding</a></li>
</ul>
<h3><a name="support--mailing-list" class="anchor" href="#support--mailing-list"><span class="octicon octicon-link"></span></a>Getting involved</h3>
<p>For a list of all components and usage examples check out the <a href="https://github.com/emailjs">emailJS GitHub organization</a>. Components that belong to emailJS are MIT licensed.</p>
<p>If you need help getting started or would like to contribute, please checkout our mailing list: <a href="https://groups.google.com/forum/#!forum/emailjs">https://groups.google.com/forum/#!forum/emailjs</a></p>
<h3><a name="authors-and-contributors" class="anchor" href="#authors-and-contributors"><span class="octicon octicon-link"></span></a>Authors and Contributors</h3>
<p>The components were originally written by Andris Reinman (<a href="https://github.com/andris9" class="user-mention">@andris9</a>), the author of <a href="http://www.nodemailer.com/">Nodemailer</a>. They are maintained by him, Felix Hammerl (<a href="https://github.com/felixhammerl" class="user-mention">@felixhammerl</a>), and Andrew Sutherland (<a href="https://github.com/asutherland" class="user-mention">@asutherland</a>). Among others, <a href="http://www.mozilla.org/">Mozilla</a> also uses them in the stock email app for <a href="https://bugzilla.mozilla.org/show_bug.cgi?id=885110">Firefox OS 2.1</a>.</p>
</section>
</div>
</body>
</html>