alphamail 1.0.3 → 1.0.4.pre

data/README.rdoc

@@ -0,0 +1,82 @@
+= The official AlphaMail Ruby gem
+
+== Description
+
+This gem is the official client library for sending transactional emails with the cloud service AlphaMail.
+To use this service you need an account. You can sign up for an free account on our website (http://www.comfirm.se). 
+
+This is not an service for sending SPAM, news letter or bulk emails of any kind. This is for transactional emails exclusive. Read more about transactional emails on http://www.comfirm.se.
+
+== Installation
+
+This gem requires json:
+
+  # gem install json
+
+Now, install alphamail:
+
+  # gem install alphamail
+
+== Usage
+
+First you need to require alphamail:
+  require 'rubygems'
+  require 'alphamail'
+
+Create the payload:
+  myPayload = AlphaMailEmailMessagePayload.new
+  
+Now, set the fields:
+  # Set payload fields
+  myPayload.project_id = 139
+  myPayload.receiver_id = 1
+  myPayload.sender.name = 'Jack Sender'
+  myPayload.sender.email = 'jack@example.com'
+  myPayload.receiver.name = 'John Doe'
+  myPayload.receiver.email = 'john.doe@example.com'
+  myPayload.body = myMember
+
+Where myPayload.body is the object that will be insertet into the email template. Make sure that the class has implemented the to_json method.
+
+Setup the service:
+  myService = AlphaMailEmailService.new 'http://api.am1.comfirm.se/v1', 'YOUR-TOKEN-HERE'
+  
+Replace YOUR-TOKEN-HERE with a valid token. You can crate new tokens at the dashboard under settings.
+
+Now it's time for magic:
+  am_res = myService.queue(myPayload)
+  
+Send the payload by calling queue. The respond object will be stored in am_res as showed above.
+
+== Error codes
+
+The respond will be returned as an AplhaMailError object.
+The AlphaMailError class contains following fields:
+  error_code
+  message
+
+Possible values for error_code:
+
+* 0	OK
+* -1	Something when wrong
+* -2	Something else
+
+== Author
+
+Jack Engqvist Johansson <mailto:jack.johansson@comfirm.se>
+
+== License
+
+Ruby License, see the COPYING file included in the source distribution. The
+Ruby License includes the GNU General Public License (GPL), Version 2, so see
+the file GPL as well.
+
+== Download
+
+The latest version of this library can be downloaded at
+
+* http://rubygems.org/gems/alphamail
+
+Online Documentation should be located at
+
+* http://docs.comfirm.se/ruby

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification 
 name: alphamail
 version: !ruby/object:Gem::Version 
-  hash: 17
-  prerelease: false
+  hash: 961915972
+  prerelease: true
   segments: 
   - 1
   - 0
-  - 3
-  version: 1.0.3
+  - 4
+  - pre
+  version: 1.0.4.pre
 platform: ruby
 authors: 
 - Jack Engqvist Johansson
@@ -46,10 +47,10 @@ extra_rdoc_files: []
 
 files: 
 - lib/alphamail.rb
-- README
 - Rakefile
 - LICENSE
 - CHANGELOG
+- README.rdoc
 - spec/alphamail_test.rb
 has_rdoc: true
 homepage: http://www.comfirm.se