Updated documentation and associated scripts

Resources/GETTING_STARTED.txt

@@ -0,0 +1,24 @@
+GETTING STARTED
+
+The best way to start learning MailCore is by reading through
+documentation intro (in index.html) and the the included example
+projects. To run the example projects:
+
+1. Copy MailCore.framework to your ~/Library/Frameworks folder.
+2. In each example project, add ~/Library/Frameworks/MailCore.framework
+   to the list of Linked Frameworks.
+3. Build it!
+
+The documentation isn't as detailed as I'd like. Sorry about that! If
+something isn't clear try reading the source included or contact me.
+
+CONTACT INFO
+
+MailCore by Matt Ronge
+http://www.mronge.com
+mronge@mronge.com
+
+LICENSE
+
+Licensed under BSD, see LICENSE.txt for more information.
+Based on LibEtPan and work done by Dinh Viet Hoa.

Resources/LICENSE.txt

@@ -1,7 +1,7 @@
 NEW BSD LICENSE
 
 MailCore
-Copyright (c) 2006, Matt Ronge
+Copyright (c) 2006 - 2009, Matt Ronge
 All rights reserved.
 
 LibEtPan!
@@ -16,4 +16,4 @@ Redistribution and use in source and binary forms, with or without modification,
 
 *   Neither the name of the <ORGANIZATION> nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
 
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Resources/RELEASE_NOTES.txt

@@ -1,39 +1,50 @@
---------------
 RELEASE NOTES
---------------
+
+Version 0.2.7
+- Fixed a memory leak found by Stefano Barbato where mime structures
+  weren't autoreleased when returned
+- Added a new method to CTCoreMessage that can be used to init from a string
+- Added proper decoding of unicode characters, w/ test (patch from
+  Julián Romero)
+- Updated the examples to work with the latest API
+- Fixed a issue with CTCoreMessage where fields were being freed twice
 
 Version 0.2.6
---------------
 - Updated to LibEtPan 0.49
-- Built an entirely new MIME parsing component. Eventually I will expose this so others can build up or parse complex MIME structures if necessary.
-- Improved fetching of body text for messages, there are still a few edge cases that aren't taken care of, but it's much better, see README.txt for more information.
-- SMTP has been reworked internally, and now it is possible to enable/disable authentication.
-- A slew of unit tests have been written. If you have tests that you have written, please send them my way!
-- A few random convenient methods, like isEqual: for CTCoreAddress, have been added,
+- Built an entirely new MIME parsing component. Eventually I will
+  expose this so others can build up or parse complex MIME structures
+  if necessary.
+- Improved fetching of body text for messages, there are still a few
+  edge cases that aren't taken care of, but it's much better, see
+  README.txt for more information.
+- SMTP has been reworked internally, and now it is possible to
+  enable/disable authentication.
+- A slew of unit tests have been written. If you have tests that you
+  have written, please send them my way!
+- A few random convenient methods, like isEqual: for CTCoreAddress,
+  have been added,
 - Memory leaks fixes
-- @executable_path/../Frameworks/ IS once again the default for the installation location. This makes it a snap to put into your apps framework folder.
+- @executable_path/../Frameworks/ IS once again the default for the
+  installation location. This makes it a snap to put into your apps
+  framework folder.
 
 
 Version 0.2.5
---------------
 - SMTP now works properly with servers that require StartTLS
 
 
 Version 0.2.4
---------------
 - Message flags now work
 
 
 Version 0.2.3
---------------
-- The CTCoreMessage object now has a flag attribute, it holds flags like unread, forwarded, new..etc.
+- The CTCoreMessage object now has a flag attribute, it holds flags
+  like unread, forwarded, new..etc.
 - More documentation has been added. I added a small section on sending e-mail.
 - MailCore has now been released under the BSD license
-- @executable_path/../Frameworks/ is no longer the default for the installation location. If you are going to be placing MailCore inside your application bundle you will need to run the install_name_tool on the library, please look at the man page for more information.
 
 
 Version 0.2
--------------
 - I fixed a memory smasher where a copy of the string wasn't been made properly
 - I fixed SMTP so it sends properly
 - I have updated Libetpan and libsasl so they they are universal binaries

Resources/documentation.css

@@ -45,8 +45,6 @@ div {
 	background-color: white;
 	padding: 30px;
 	margin-top: 2px;
-
-	width: 600px;
 }
 
 a { 

Resources/introduction.html

@@ -54,10 +54,10 @@ <h2>Working with IMAP</h2>
   CTCoreFolder *inbox = [account folderWithPath:@"INBOX"];<br/>
 </blockquote>
 
-<p>Now that we have a connection to a folder we can start to do more interesting things, like we can get a set of the messages in the particular folder, or we can delete the folder, or remove the folder from the subscribed list, check the <a href="interfaceCTCoreFolder.html">CTCoreFolder</a> for more information. For this particular example I am going to get a list of the messages in the INBOX.</p>
+<p>Now that we have a connection to a folder we can start to do more interesting things, like we can get a set of the messages in the particular folder, or we can delete the folder, or remove the folder from the subscribed list, check the <a href="interfaceCTCoreFolder.html">CTCoreFolder</a> for more information. For this particular example I am going to get a list of the messages in the INBOX (0 as the end index indicates that the entire inbox should be loaded).</p>
 
 <blockquote>
-  NSSet *messageList = [inbox messageListFromIndex:nil];<br/>
+  NSSet *messageList = [inbox messageListFromIndex:1 toIndex:0];<br/>
 </blockquote>
 
 <p>Like the with folders, what is returned is a set of NSString's containing unique message identifiers (UID).</p>

Resources/transform.xsl

@@ -30,8 +30,8 @@
 				<xsl:apply-templates />
 
 				<div class="horizontal-rule copyright">
-                    Copyright &#169; Matt Ronge, <a href="http://www.theronge.com">http://www.theronge.com</a>,
-                    mronge at theronge dot com.<br/>
+                    Copyright &#169; Matt Ronge, <a href="http://www.mronge.com">http://www.mronge.com</a>
+                    <br/>
 					Documentation generated by <a href="http://www.doxygen.org">doxygen</a>, 
 					Custom XSL and CSS thanks to Theo Hultberg / Iconara, 
 					<a href="http://developer.iconara.net">http://developer.iconara.net</a><br/>

Scripts/BuildScripts/buildrelease.sh

@@ -1,23 +1,23 @@
 #! /usr/bin/sh
 
 # Run this from the root of the MailCore project
+# Pass in as an arg the tag name for the release
 
-mkdir ../../build/MailCore
-cp -R ../../build/Release/MailCore.framework ../../build/MailCore
-cp -R Documentation/ ../../build/MailCore/Documentation
+mkdir -p build/MailCore
+xcodebuild -configuration Release
+cp -R build/Release/MailCore.framework build/MailCore
+cp -R Documentation/ build/MailCore/Documentation
 cd Examples/InboxLister
 xcodebuild clean
 cd ../MessageSender
 xcodebuild clean
 cd ../..
-xcodebuild -configuration Release
-cp -R Examples ../../build/MailCore
-cp Resources/README.txt ../../build/MailCore
-cp Resources/LICENSE.txt ../../build/MailCore
-cp Resources/RELEASE_NOTES.txt ../../build/MailCore
-cd ../../build/MailCore
+cp -R Examples build/MailCore
+cp Resources/GETTING_STARTED.txt build/MailCore
+cp Resources/LICENSE.txt build/MailCore
+cp Resources/RELEASE_NOTES.txt build/MailCore
+cd build/MailCore
 ln -s Documentation/index.html index.html
-cd ../..
-#hdiutil create -srcfolder build/MailCore build/MailCore.dmg
-cd build
+hg clone -r $1 https://bitbucket.org/mronge/mailcore/ src
+cd ..
 tar czf MailCore.tar.gz MailCore

Scripts/BuildScripts/publish.sh

@@ -1,10 +1,8 @@
 #! /usr/bin/sh
 
 # Run this from the root of the MailCore project
+# Arg 1 is the tag name
 
-scp -r Documentation theronge.com:/var/www/theronge.com/docs/MailCore/
-cd ../../build/
-name="MailCore-$1.tar.gz"
-echo $name
-mv MailCore.tar.gz $name
-scp $name theronge.com:/var/www/theronge.com/docs/MailCore
+cp -r Documentation API
+scp -r API mronge.com:/var/www/mronge/m/MailCore/API
+scp build/MailCore.tar.gz mronge.com:/var/www/mronge/m/MailCore/MailCore-$1.tar.gz