Skip to content

Commit

Permalink
Adding readme files again
Browse files Browse the repository at this point in the history
  • Loading branch information
Emiliano Angelini authored and Emiliano Angelini committed Apr 24, 2012
1 parent 6b6d767 commit 63b6247
Show file tree
Hide file tree
Showing 2 changed files with 158 additions and 0 deletions.
86 changes: 86 additions & 0 deletions MailSender/README.md
@@ -0,0 +1,86 @@
**Haxe NME MailSender extension**

This is a native extension for haxe NME which allows to call a native mail window.
(Currently iOS only)

**Usage**

Reference the extension in your .nmml:

<extension name="appleRemote" path="path/to/mailSender/Extension" />

Reference the following iOS framework in your .nmml:

<dependency name="MessageUI.framework" if="ios" />

Just call this static Method:

MailSender.sendMail("MailSender sendMail sample", "Howdy, partner\n", false, "youremail@gmail.com", "youremail@gmail.com", "youremail@gmail.com");

Parameters:
-----------
Subject:String
Body:String
isHTML:Boolean
to:String
cc:String
bcc:String


**Running the test application**

cd Project
nme build MailSenderSample.nmml ios

or
nme update MailSenderSample.nmml ios

For the flash target a mailto: URL call is being used.

**Recompiling the extension**

cd Extension/project
haxelib run hxcpp Build.xml

or

haxelib run hxcpp Build.xml -DHXCPP_M64
haxelib run hxcpp Build.xml -Diphoneos
haxelib run hxcpp Build.xml -Diphoneos -DHXCPP_ARMV7
haxelib run hxcpp Build.xml -Diphonesim
haxelib run hxcpp Build.xml -Dwebos
haxelib run hxcpp Build.xml -Dandroid
haxelib run hxcpp Build.xml -Dblackberry
(depending on your target)


**License:**

This extension and example license:

Unless indicated otherwise, this code was created by Emiliano Angelini and
provided under a MIT-style license.
Copyright (c) Emiliano Angelini. All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

The extension includes a copy of some classes from Apple's [MailComposer sample][1] (see license information in the relevant
files).

[1]: http://developer.apple.com/library/ios/#samplecode/MailComposer/Introduction/Intro.html
72 changes: 72 additions & 0 deletions README.md
@@ -0,0 +1,72 @@
**NME extensions Repo**

This is the place where I'll put all my NME extensions.

Usually I'll add 2 folders for each extension (based on Joshua Granick's structure):
- Extension: Source and perhaps some compiled ones.
- Project: A sample NME project to quickly test the extension.

**Usage**

Reference the extension in your .nmml:

<extension name="appleRemote" path="path/to/desired/Extension" />

Sometimes you'll have to also add a reference to some native framework in your .nmml. For instance:

<dependency name="MessageUI.framework" if="ios" />

Find specific APIs for each extension inside their folders.

**Running the test application**

Go to the Project folder and run a build nme command for your desired nmml file.

For instance:
cd Project
nme build MailSenderSample.nmml ios

or
nme update MailSenderSample.nmml ios

**Recompiling the extension**

cd Extension/project
haxelib run hxcpp Build.xml

or

haxelib run hxcpp Build.xml -DHXCPP_M64
haxelib run hxcpp Build.xml -Diphoneos
haxelib run hxcpp Build.xml -Diphoneos -DHXCPP_ARMV7
haxelib run hxcpp Build.xml -Diphonesim
haxelib run hxcpp Build.xml -Dwebos
haxelib run hxcpp Build.xml -Dandroid
haxelib run hxcpp Build.xml -Dblackberry
(depending on your target)

**License:**

This extension and example license:

Unless indicated otherwise, this code was created by Emiliano Angelini and
provided under a MIT-style license.
Copyright (c) Emiliano Angelini. All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

0 comments on commit 63b6247

Please sign in to comment.