MA-946 #time 10h Updated examples and tested. Updated Documentation. Setup composer inclusion testing.

10 files changed, 274 insertions, 0 deletions

diff --git a/examples/bootstrap.php b/examples/bootstrap.php
new file mode 100644
index 0000000..8a5f839
--- /dev/null
+++ b/examples/bootstrap.php
@@ -0,0 +1,3 @@
+<?php
+	require_once dirname(__FILE__).'/../vendor/autoload.php';
+?>
\ No newline at end of file
diff --git a/examples/transmission/configuration_based.php b/examples/transmission/configuration_based.php
new file mode 100644
index 0000000..374f446
--- /dev/null
+++ b/examples/transmission/configuration_based.php
@@ -0,0 +1,31 @@
+<?php
+namespace Examples\Transmisson;	
+	require_once (dirname(__FILE__).'/../bootstrap.php');
+
+	use SparkPost\SparkPost;
+
+	$key = 'YOURAPIKEY'; 
+	$sdk = new SparkPost(['key'=>$key]);
+	
+	$transmission = $sdk->Transmission([
+		"return_path"=>"return@example.com",
+		"from"=>"From Envelope <from@example.com>",
+  		"html"=>"<p>Hello World!</p>",
+  		"text"=>"Hello World!",
+  		"subject"=>"Example Email",
+  		"recipients"=>[
+    		[
+    			"address"=>[
+        			"email"=>"john.doe@sample.com"
+    			]
+      		]
+    	]		
+	]);
+	
+	try {
+		$results = $transmission->send();
+		echo 'Congrats you can use your SDK!';
+	} catch (\Exception $exception) {
+		echo $exception->getMessage();
+	}
+?>
\ No newline at end of file
diff --git a/examples/transmission/get_all_transmissions.php b/examples/transmission/get_all_transmissions.php
new file mode 100644
index 0000000..9ffc2fd
--- /dev/null
+++ b/examples/transmission/get_all_transmissions.php
@@ -0,0 +1,18 @@
+<?php
+namespace Examples\Transmisson;
+	require_once (dirname(__FILE__).'/../bootstrap.php');
+	
+	use SparkPost\SparkPost;
+	
+	$key = 'YOURAPIKEY';
+	$sdk = new SparkPost(['key'=>$key]);
+	
+	$transmission = $sdk->Transmission();
+	
+	try {
+		$results = $transmission->all();
+		echo 'Congrats you can use your SDK!';
+	} catch (\Exception $exception) {
+		echo $exception->getMessage();
+	}
+?>
\ No newline at end of file
diff --git a/examples/transmission/get_transmission.php b/examples/transmission/get_transmission.php
new file mode 100644
index 0000000..86e9f0f
--- /dev/null
+++ b/examples/transmission/get_transmission.php
@@ -0,0 +1,17 @@
+<?php
+namespace Examples\Transmisson;
+require_once (dirname(__FILE__).'/../bootstrap.php');
+use SparkPost\SparkPost;
+
+$key = 'YOURAPIKEY';
+$sdk = new SparkPost(['key'=>$key]);
+
+$transmission = $sdk->Transmission();
+
+try {
+	$results = $transmission->find('11860038888980495');
+	echo 'Congrats you can use your SDK!';
+} catch (\Exception $exception) {
+	echo $exception->getMessage();
+}
+?>
\ No newline at end of file
diff --git a/examples/transmission/mime_parts.php b/examples/transmission/mime_parts.php
new file mode 100644
index 0000000..2b68b46
--- /dev/null
+++ b/examples/transmission/mime_parts.php
@@ -0,0 +1,29 @@
+<?php
+namespace Examples\Transmisson;
+require_once (dirname(__FILE__).'/../bootstrap.php');
+use SparkPost\SparkPost;
+
+$key = 'YOURAPIKEY';
+$sdk = new SparkPost(['key'=>$key]);
+
+$transmission = $sdk->Transmission();
+
+$transmission->setReturnPath('return@example.com')
+	->setFrom('From Envelope <from@example.com>')
+	->addRecipient([
+			'address'=> [
+			'email'=> 'john.doe@sample.com'
+			]
+		])
+	->setSubject('Example Email')
+	->setHTMLContent('<p>Hello World!</p>')
+	->setTextContent('Hello World!');
+
+
+try {
+	$results = $transmission->send();
+	echo 'Congrats you can use your SDK!';
+} catch (\Exception $exception) {
+	echo $exception->getMessage();
+}
+?>
\ No newline at end of file
diff --git a/examples/transmission/rfc822.php b/examples/transmission/rfc822.php
new file mode 100644
index 0000000..58c62cc
--- /dev/null
+++ b/examples/transmission/rfc822.php
@@ -0,0 +1,28 @@
+<?php
+namespace Examples\Transmisson;
+require_once (dirname(__FILE__).'/../bootstrap.php');
+use SparkPost\SparkPost;
+
+$key = 'YOURAPIKEY';
+$sdk = new SparkPost(['key'=>$key]);
+
+
+
+$transmission = $sdk->Transmission();
+
+$transmission->setReturnPath('return@example.com')
+  ->addRecipient([
+      'address'=>[
+        'email'=>'john.doe@sample.com'
+      ]
+  ])
+  ->setRfc822Content("Content-Type: text/plain\nFrom: From Envelope <from@example.com>\nSubject: Example Email\n\nHello World");
+
+
+try {
+	$results = $transmission->send();
+	echo 'Congrats you can use your SDK!';
+} catch (\Exception $exception) {
+	echo $exception->getMessage();
+}
+?>
\ No newline at end of file
diff --git a/examples/transmission/send_transmission_all_fields.php b/examples/transmission/send_transmission_all_fields.php
new file mode 100644
index 0000000..5aec6b8
--- /dev/null
+++ b/examples/transmission/send_transmission_all_fields.php
@@ -0,0 +1,47 @@
+<?php
+namespace Examples\Transmisson;
+require_once (dirname(__FILE__).'/../bootstrap.php');
+use SparkPost\SparkPost;
+
+$key = 'YOURAPIKEY';
+$sdk = new SparkPost(['key'=>$key]);
+
+
+
+$transmission = $sdk->Transmission([
+  "campaign"=>"my-campaign",
+  "metadata"=>[
+   "sample_campaign"=>true,
+   "type"=>"these are custom fields"
+  ],
+  "substitutionData"=>[
+    "name"=>"Test Name"
+  ],
+  "description"=>"my description",
+  "return_path"=>"return@example.com",
+  "replyTo"=>"reply@test.com",
+  "headers"=>[
+    "X-Custom-Header"=>"Sample Custom Header"
+  ],
+  "openTracking"=>false,
+  "clickTracking"=>false,
+  "from"=>"From Envelope <from@example.com>",
+  "html"=>"<p>Hello World! Your name is: {{name}}</p>",
+  "text"=>"Hello World!",
+  "subject"=>"Example Email: {{name}}",
+  "recipients"=>[
+    [
+      "address"=>[
+        "email"=>"john.doe@sample.com"
+      ]
+    ]
+  ]
+]);
+
+try {
+	$results = $transmission->send();
+	echo 'Congrats you can use your SDK!';
+} catch (\Exception $exception) {
+	echo $exception->getMessage();
+}
+?>
\ No newline at end of file
diff --git a/examples/transmission/send_transmission_all_fields_method_based.php b/examples/transmission/send_transmission_all_fields_method_based.php
new file mode 100644
index 0000000..0f3314b
--- /dev/null
+++ b/examples/transmission/send_transmission_all_fields_method_based.php
@@ -0,0 +1,45 @@
+<?php
+namespace Examples\Transmisson;
+require_once (dirname(__FILE__).'/../bootstrap.php');
+use SparkPost\SparkPost;
+
+$key = 'YOURAPIKEY';
+$sdk = new SparkPost(['key'=>$key]);
+
+
+
+$transmission = $sdk->Transmission();
+
+$transmission->setCampaign('my campaign')
+	->setMetadata([
+		"sample_campaign"=>"true",
+		"type"=>"test type meta data"
+	])
+	->setSubstitutionData([
+		"name"=>"Test Name"
+	])
+	->setDescription('My Description')
+	->setReturnPath('return@example.com')
+	->setReplyTo('reply@test.com')
+	->setContentHeaders([
+		"X-Custom-Header"=>"Sample Custom Header"
+	])
+	->disableOpenTracking()
+	->disableClickTracking()
+	->setFrom('From Envelope <from@example.com>')
+	->addRecipient([
+		"address"=> [
+			"email"=>"john.doe@sample.com"
+		]
+	])
+	->setSubject('Example Email: {{name}}')
+	->setHTMLContent('<p>Hello World! Your name is: {{name}}</p>')
+	->setTextContent('Hello World!');
+
+
+try {
+	$results = $transmission->send();
+	echo 'Congrats you can use your SDK!';
+} catch (\Exception $exception) {
+	echo $exception->getMessage();
+}
\ No newline at end of file
diff --git a/examples/transmission/stored_recipients_inline_content.php b/examples/transmission/stored_recipients_inline_content.php
new file mode 100644
index 0000000..8dccdda
--- /dev/null
+++ b/examples/transmission/stored_recipients_inline_content.php
@@ -0,0 +1,27 @@
+<?php
+namespace Examples\Transmisson;
+require_once (dirname(__FILE__).'/../bootstrap.php');
+use SparkPost\SparkPost;
+
+$key = 'YOURAPIKEY';
+$sdk = new SparkPost(['key'=>$key]);
+
+
+
+$transmission = $sdk->Transmission();
+
+$transmission->setCampaign('my campaign')
+	->setReturnPath('return@example.com')
+	->setFrom('From Envelope <from@example.com>')
+	->useRecipientList('Example List')
+	->setSubject('Example Email')
+  	->setHTMLContent('<p>Hello World!</p>')
+  	->setTextContent('Hello World!');
+
+try {
+	$results = $transmission->send();
+	echo 'Congrats you can use your SDK!';
+} catch (\Exception $exception) {
+	echo $exception->getMessage();
+}
+?>
\ No newline at end of file
diff --git a/examples/transmission/stored_template_send.php b/examples/transmission/stored_template_send.php
new file mode 100644
index 0000000..7a0e784
--- /dev/null
+++ b/examples/transmission/stored_template_send.php
@@ -0,0 +1,29 @@
+<?php
+namespace Examples\Transmisson;
+require_once (dirname(__FILE__).'/../bootstrap.php');
+use SparkPost\SparkPost;
+
+
+$key = 'YOURAPIKEY';
+$sdk = new SparkPost(['key'=>$key]);
+
+
+
+$transmission = $sdk->Transmission();
+
+$transmission->setReturnPath('return@example.com')
+  ->setFrom('From Envelope <from@example.com>')
+  ->addRecipient([
+      "address"=>[
+        "email"=>"john.doe@sample.com"
+      ]
+  ])
+  ->useStoredTemplate('my-template');
+
+try {
+	$results = $transmission->send();
+	echo 'Congrats you can use your SDK!';
+} catch (\Exception $exception) {
+	echo $exception->getMessage();
+}
+?>
\ No newline at end of file