You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Made the lib fully compatible with GetSparks.org by providing an autoload.php and the cURL library can now be installed as a Spark or in the normal way. Updated formatting docs too.
Copy file name to clipboardExpand all lines: README.md
+22-9
Original file line number
Diff line number
Diff line change
@@ -12,6 +12,10 @@ Requirements
12
12
4. Phil Sturgeon's CodeIgniter cURL library (http://github.com/philsturgeon/codeigniter-curl)
13
13
5. Amazon Web Services account (http://aws.amazon.com)
14
14
15
+
Spark
16
+
-------------
17
+
This library is also released as a Spark (GetSparks.org). If you use this library in any other way, **don't copy the autoload.php to your config directory**.
18
+
15
19
Documentation
16
20
-------------
17
21
@@ -20,38 +24,47 @@ This library expects a configuration file to function correctly. A template for
20
24
21
25
### Recipients
22
26
23
-
####$this->amazon_ses->to()
24
27
Set the "To" address(es) for a message.
25
28
26
-
####$this->amazon_ses->cc()
29
+
$this->amazon_ses->to('to1@example.com');
30
+
27
31
Set the "CC" address(es) (carbon copy) for a message.
Set the alternative message (plain-text) to be sent. When not specified, an alternative message is generated by using PHP's strip_tags() function.
44
52
45
-
####$this->amazon_ses->send()
53
+
$this->amazon_ses->message_alt('No HTML?!');
54
+
46
55
Sends the message. Returns true on success.
47
56
57
+
$this->amazon_ses->send();
58
+
48
59
###Misc
49
60
50
-
####$this->amazon_ses->debug()
51
61
Sends the message in debug mode. In debug mode, the send() methods returns the actual API response instead of a boolean. Call this method before calling the send method.
62
+
63
+
$this->amazon_ses->debug();
52
64
53
-
####$this->amazon_ses->destroy()
54
65
Preserves recipient after the message has been successfully send. When you call this method, all recipients will be preserved during the objects life. This makes it possible to sent an additional message without re-specifying the recipients.
0 commit comments