-
Notifications
You must be signed in to change notification settings - Fork 4
/
mailcore1.html
141 lines (107 loc) · 7.5 KB
/
mailcore1.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
<!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/mronge/MailCore"><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</h2>
<img src="images/logo.png" alt="logo" />
</div>
<div id="wrapper">
<h2 id="summary">Summary</h2>
<ul>
<li><a href="#whatis">What is MailCore?</a></li>
<li><a href="#example">Example</a></li>
<li><a href="#gettingcode">Getting the Code</a></li>
<li><a href="#iosadding">Adding MailCore to Your iOS Project</a></li>
<li><a href="#macadding">Adding MailCore to Your Mac Project</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="#consulting">Consulting</a></li>
<li><a href="#contact">Contact</a></li>
</ul>
<hr />
<h2 id="whatis">What is MailCore?</h2>
<p>MailCore is a Mac and iOS library designed to ease the pain of dealing with e-mail protocols. MailCore makes the process of sending e-mail easy by hiding the nasty details like MIME composition from you. Instead, there is a single method required to send a message. Checking e-mail on an IMAP server is a more complex beast, but MailCore makes the job much simpler by presenting everything as a set of objects like Messages, Folders and Accounts. </p>
<h2 id="example">Example</h2>
<p>This example shows how you can send email using MailCore.</p>
<script src="https://gist.github.com/3893098.js"> </script>
<h2 id="gettingcode">Getting the Code</h2>
<p>The best way to get MailCore is to clone directly from <a href="http://www.github.com/mronge/MailCore/">GitHub</a>. The master branch is under active development but it is still the recommended place to start. Eventually a stable version will be tagged 1.0, but for now work off master. </p>
<pre><code class="bash">git clone https://github.com/mronge/MailCore.git
cd MailCore/
git submodule update --init</code></pre>
<h2 id="iosadding">Adding MailCore to Your iOS Project</h2>
<ol>
<li>First checkout the latest code and make sure you get the required submodules</li>
<li>Locate MailCore.xcodeproj and add it to your project as a subproject. You can do this by dragging the Mailcore.xcodeproj file into your Xcode project.<br/>
<img src="images/subproject.png" alt="subproject" /></li>
<li>Navigate to your app’s target and switch to your app’s Build Phases. Once in Build Phases expand “Link Binary With Libraries” and click the + button. And add these libraries:</li>
</ol>
<pre><code class="text"> libmailcore.a
libssl.a
libsasl2.a
libcrypto.a
libiconv.dylib
CFNetwork.framework</code></pre>
<p><img src="images/libraries.png" alt="libraries" /><br/>
4. Add “MailCore iOS” under “Target Dependencies”<br/>
5. Under your app’s target, switch to Build Settings. Locate “Header Search Paths” in the Build Settings and add <code>"$(BUILT_PRODUCTS_DIR)/../../include"</code><br/>
6. You are now ready to use MailCore. To use MailCore add <code>#import <MailCore/MailCore.h></code> to the top of your Objective-C files. </p>
<h2 id="macadding">Adding MailCore to Your Mac Project</h2>
<ol>
<li>First checkout the latest code and make sure you get the required submodules</li>
<li>Locate MailCore.xcodeproj and add it to your project as a subproject. You can do this by dragging the Mailcore.xcodeproj file into your Xcode project.</li>
<li>Navigate to your app’s target and switch to your app’s Build Phases. Once in Build Phases expand “Link Binary With Libraries” and click the + button. From there add MailCore.framework.</li>
<li>While still under Build Phases click “Add Build Phase” in the lower right and select “Add Copy Files”. A new copy files phase will be added, make sure the destination is set to “Frameworks”. Now add MailCore.framework to that copy files phase by using the + button.</li>
<li>Add “MailCore” under “Target Dependencies”</li>
<li>You are now ready to use MailCore. To use MailCore add <code>#import <MailCore/MailCore.h></code> to the top of your Objective-C files.</li>
</ol>
<h2 id="docs">Documentation</h2>
<p>Begin with the <a href="gettingstarted.html">Getting Started Guide</a> and then take a look at the <a href="api/deprecated/index.html">API docs</a>. </p>
<p>For those of you coming from an older version of MailCore, take a look at the<a href="https://github.com/mronge/MailCore/wiki/Migrating-to-1.0">migration guide</a>.</p>
<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>
</ul>
<h2 id="apps">Apps Using MailCore</h2>
<p>If you’d like your app listed here, please get in touch.</p>
<ul>
<li>Quicksilver</li>
<li>Fileboard</li>
<li>CloudPull</li>
<li>Remail</li>
<li>Notify</li>
<li>FwdMail</li>
<li>eMailGanizer</li>
<li>OneMail</li>
<li>MailArchive</li>
<li>iPhoto2Gmail</li>
<li>BackUp Gmail</li>
</ul>
<h2 id="consulting">Consulting</h2>
<p>Consulting services are available via <a href="http://www.centralatomics.com">Central Atomics</a>. At Central Atomics we have over 10 years of experience developing for Apple platforms and 6 years of experience working with e-mail systems. If you need custom e-mail functionality developed, please get in touch via our website or e-mail Matt directly. </p>
<h2 id="contact">Contact</h2>
<p>If you have any questions please don’t hesitate to contact me.</p>
<p>Thanks, </p>
<p>Matt Ronge<br/>
<a href="mailto:mronge@mronge.com">mronge@mronge.com</a><br/>
<a href="http://www.twitter.com/mronge">@mronge</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 Matt Ronge. All Rights Reserved. </p>
</div>
</div>
</body>
</html>