-
Notifications
You must be signed in to change notification settings - Fork 4
/
index.html
190 lines (142 loc) · 8.73 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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>MailCore</title>
<link href="mailcore.css" media="screen" rel="stylesheet" type="text/css" />
</head>
<body class="normal">
<p><a href="https://github.com/MailCore/MailCore2"><img style="position: absolute; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub"/></a></p>
<div id="main">
<div id="title-header">
<h1>MailCore</h1>
<h2>An e-mail library for Mac, iOS, Linux & Windows</h2>
<img src="images/logo.png" alt="logo" />
</div>
<div id="wrapper">
<p>MailCore is a library designed to ease the pain of working with e-mail protocols. Its runs on iOS, OS X, Android, Windows and Linux. MailCore is batteries included with support for SMTP, IMAP, POP3, RFC822, MIME and rendering of HTML messages.</p>
<hr />
<ul>
<li><a href="#example">Getting Started</a></li>
<li><a href="#gettingcode">Getting the Code</a></li>
<li><a href="#docs">Documentation</a></li>
<li><a href="#mailinglist">Mailing List</a></li>
<li><a href="#apps">Apps Using MailCore</a></li>
<li><a href="#faq">FAQ</a></li>
<li><a href="#consulting">Consulting</a></li>
<li><a href="#authors">Authors</a></li>
</ul>
<h2 id="announcing">Announcing MailCore 2!</h2>
<p>From the authors of Sparrow and MailCore 1.0 comes the new and improved MailCore 2! MailCore has been completely redesigned from the ground up with a new blocks based API. It features:</p>
<ul>
<li><b>POP</b>, <b>IMAP</b>, and <b>SMTP</b> support</li>
<li><b><a href="http://www.ietf.org/rfc/rfc0822.txt">RFC822</a></b> parser and generator</li>
<li><b>UI widgets</b> for rendering HTML messages</li>
<li><b>Asynchronous</b> APIs with Objective-C blocks</li>
<li><b>iOS</b>, <b>Mac</b>, <b>Windows</b> and <b>Linux</b> support</li>
<li><b>Portable</b> core engine in C++</li>
</ul>
<h2 id="example">Getting Started</h2>
<h3>Fetching Messages</h3>
<p>This example shows how to use IMAP to fetch messages from the GMail servers.</p>
<script src="https://gist.github.com/mronge/5581549.js"></script>
<h3>Sending a Message</h3>
<p>This example shows how you can send email using MailCore.</p>
<script src="https://gist.github.com/mronge/5694886.js"></script>
<h3>More examples...</h3>
<p>Check out more examples on the project <a href="https://github.com/MailCore/mailcore2/wiki#examples">wiki</a>.</p>
<h2 id="gettingcode">Getting the Code</h2>
<p>Checkout the code directly from git:</p>
<pre><code class="bash">git clone https://github.com/MailCore/MailCore2.git
</code></pre>
<p>From there follow the <a href="https://github.com/MailCore/mailcore2#installation">installation instructions</a>.</p>
<h2 id="docs">Documentation</h2>
<h3>Guides</h3>
<ul>
<li><a href="https://github.com/MailCore/mailcore2#basic-imap-usage">Getting Started</a></li>
</ul>
<h3>Reference</h3>
<ul>
<li><a href="api/objc/index.html">Objective-C API docs</a></li>
<li><a href="api/java/index.html">Java API docs</a></li>
</ul>
<h3>Sample Code</h3>
<ul>
<li>Sample code is included with the project on Github <a href="https://github.com/MailCore/mailcore2/tree/master/example">here</a>.</li>
</ul>
<h3>Migrating</h3>
<ul>
<li><a href="https://github.com/MailCore/mailcore2/wiki/Changes-From-The-Original-MailCore">Migrating from MailCore 1.0</a></li>
</ul>
<h2 id="mailinglist">Mailing List</h2>
<p>There is a low traffic mailing list hosted on <a href="http://librelist.com/">Librelist</a>.</p>
<ul>
<li>To join send an email to <a href="mailto:mailcore@librelist.com">mailcore@librelist.com</a> and reply to the confirmation e-mail. To unsubscribe at anytime send an e-mail to <a href="mailto:mailcore-unsubscribe@librelist.com">mailcore-unsubscribe@librelist.com</a>.</li>
<li>Mailing list archives are <a href="http://librelist.com/browser/mailcore/">available.</a></li>
<li>For contributors we have a dev mailing list, send an email to this address to subscribe: <a href='mailto:ma%69%6Cc%6Fr%65dev@l%69br%65%6Ci%73t.com'>mailcoredev@librelist.com</a></li>
</ul>
<h2 id="apps">Cool Apps Using MailCore</h2>
<ul>
<li><a href="https://www.relateiq.com/">RelateIQ</a></li>
<li><a href="http://mailtime.com/">MailTime</a></li>
<li><a href="http://www.dispatchapp.net/">Dispatch</a></li>
<li><a href="http://mailsteward.com/">MailSteward</a></li>
<li><a href="http://getpebble.com/">Pebble</a></li>
<li><a href="http://airmailapp.com/">Airmail</a></li>
<li><a href="http://www.birdseyemail.com/">birdseye</a></li>
<li><a href="http://qsapp.com/">Quicksilver</a></li>
<li><a href="http://www.triage.cc/">Triage</a></li>
<li><a href="http://www.goldenhillsoftware.com/">CloudPull</a></li>
<li><a href="http://mailcallapp.com/">Mail Call</a></li>
<li><a href="http://getboxer.com/">Boxer</a></li>
<li><a href="http://www.inboxruler.com/">InboxRuler</a></li>
<li><a href="http://www.fileboard.com/">Fileboard</a></li>
<li><a href="https://code.google.com/p/remail-iphone/">Remail</a></li>
<li><a href="http://handyapp.com/fwdmail/">FwdMail</a></li>
<li><a href="http://www.emailganizer.com/">eMailGanizer</a></li>
<li><a href="http://www.prioritiz.com/">Prioritiz</a></li>
<li><a href="http://www.enotifyapp.com/">eNotify</a></li>
<li><a href="https://itunes.apple.com/us/app/mail-pilot/id616785421?mt=8">Mail Pilot</a></li>
<li><a href="https://itunes.apple.com/us/app/offline-mail-email-gmail-imap/id470659075?mt=8">Offline Mail</a></li>
<li><a href="https://itunes.apple.com/us/app/walnut/id574848194?mt=8">WALNUT</a></li>
<li><a href="https://www.grocrm.com/product/features/email/">Gro CRM</a></li>
<li><a href="https://getmailspring.com/">Mailspring</a></li>
<li>BackUp Gmail</li>
<li>OneMail</li>
<li>Notify</li>
</ul>
<h2 id="faq">FAQ</h2>
<h3>Q: What happened to MailCore 1.0?</h3>
<p>A: <a href="https://www.github.com/mailcore/mailcore">MailCore 1.0</a> will continue to be maintained. Under the hood both libraries use the same C library <a href="https://github.com/dinhviethoa/libetpan">libEtPan</a>. There is a synchronous C++ interface in MailCore 2.0 that would be a suitable replacement for the MailCore 1.0 API. Unfortunately to create a more flexible and asynchronous API we had to start over.</p>
<h3>Q: What platforms does MailCore support?</h3>
<p>A: Out of the box iOS, Mac OS X, Linux and Windows are supported. However the core engine is portable C/C++ and could be ported to Android, which we are hoping to do. We'd love to see more language bindings against the engine, perhaps Node.js, Python, Ruby?</p>
<h3>Q: Can I use MailCore in my commercial app?</h3>
<p>A: Absolutely! MailCore is BSD licensed and all dependencies have licenses that are compatible with commercial software</p>
<h3>Q: Can I help out?</h3>
<p>Yes, please do! Fork the repo on GitHub and get started hacking or writing docs! Contributions are done using GitHub pull requests. Check the <a href="https://github.com/MailCore/mailcore2/blob/master/TODO.md">TODO file</a> for items to work on. </p>
<h3>More...</h3>
<p>More FAQs are available on the GitHub <a href="https://github.com/MailCore/mailcore2/wiki/FAQ">wiki</a>.</p>
<h2 id="consulting">Consulting</h2>
<p>Consulting services are available via <a href="http://www.astro-hq.com">Astro HQ</a>. At Astro HQ we have years of experience working on email apps. If you need custom e-mail functionality developed, please get in touch via our website. </p>
<h2 id="authors">Authors</h2>
<p>Thanks from the MailCore team. </p>
<p>Matt Ronge<br/>
<a href="http://www.twitter.com/mronge">@mronge</a>
</p>
<p>Hoà V. Dinh<br/>
<a href="http://www.twitter.com/dinhvh">@dinhvh</a>
</p>
<p>Robert Widmann<br/>
<a href="http://www.twitter.com/codafi_">@codafi_</a>
</p>
<p>Jonathan Willing<br/>
<a href="http://www.twitter.com/j_willing">@j_willing</a>
</p>
</div>
<div id="addendum">
<p>Logo designed by <a href="http://www.twitter.com/adanperez">Adan Perez</a>. The logo is a modified version of the <a href="http://thenounproject.com/noun/mail/#icon-No91">Mail icon</a> by <a href="http://thenounproject.com">The Noun Project</a>, used under a CC BY license.<br/>
© 2012-2014 Matt Ronge. All Rights Reserved. </p>
</div>
</div>
</body>
</html>