summaryrefslogtreecommitdiffstats
path: root/examples/transmission
diff options
context:
space:
mode:
authornornholdj <nornholdj@gmail.com>2014-10-31 15:10:06 -0400
committernornholdj <nornholdj@gmail.com>2014-10-31 15:10:06 -0400
commit68a7e8ec33f205a71107d924e0d244f5edac97a6 (patch)
tree7e47e9d41a8a3304e32eb0da6219c523f3e9c126 /examples/transmission
parentde407ac8bf029e85278eaeb683e6f86c6a11c097 (diff)
downloadphp-sparkpost-68a7e8ec33f205a71107d924e0d244f5edac97a6.zip
php-sparkpost-68a7e8ec33f205a71107d924e0d244f5edac97a6.tar.gz
php-sparkpost-68a7e8ec33f205a71107d924e0d244f5edac97a6.tar.bz2
MA-946 #time 3h 30m Revamped Transmission object to be stateless,
updated tests and examples.
Diffstat (limited to 'examples/transmission')
-rw-r--r--examples/transmission/configuration_based.php37
-rw-r--r--examples/transmission/get_all_transmissions.php11
-rw-r--r--examples/transmission/get_transmission.php13
-rw-r--r--examples/transmission/mime_parts.php29
-rw-r--r--examples/transmission/rfc822.php33
-rw-r--r--examples/transmission/send_transmission_all_fields.php68
-rw-r--r--examples/transmission/send_transmission_all_fields_method_based.php45
-rw-r--r--examples/transmission/stored_recipients_inline_content.php30
-rw-r--r--examples/transmission/stored_template_send.php35
9 files changed, 108 insertions, 193 deletions
diff --git a/examples/transmission/configuration_based.php b/examples/transmission/configuration_based.php
index 374f446..366434f 100644
--- a/examples/transmission/configuration_based.php
+++ b/examples/transmission/configuration_based.php
@@ -2,29 +2,30 @@
namespace Examples\Transmisson;
require_once (dirname(__FILE__).'/../bootstrap.php');
- use SparkPost\SparkPost;
+ use MessageSystems\SparkPost;
+ use MessageSystems\Transmission;
$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"
- ]
- ]
- ]
- ]);
+ SparkPost::setConfig(['key'=>$key]);
try {
- $results = $transmission->send();
+ $results = Transmission::send([
+ "returnPath"=>"return@example.com",
+ "from"=>"From Envelope <from@example.com>",
+ "html"=>"<p>Hello World!</p>",
+ "text"=>"Hello World!",
+ "subject"=>"Example Email",
+ "recipients"=>[
+ [
+ "address"=>[
+ "email"=>"jordan.nornhold@rackspace.messagesystems.com"
+ ]
+ ]
+ ]
+ ]);
echo 'Congrats you can use your SDK!';
+
+ var_dump(Transmission::$structure);
} catch (\Exception $exception) {
echo $exception->getMessage();
}
diff --git a/examples/transmission/get_all_transmissions.php b/examples/transmission/get_all_transmissions.php
index 9ffc2fd..1425e65 100644
--- a/examples/transmission/get_all_transmissions.php
+++ b/examples/transmission/get_all_transmissions.php
@@ -2,15 +2,14 @@
namespace Examples\Transmisson;
require_once (dirname(__FILE__).'/../bootstrap.php');
- use SparkPost\SparkPost;
+ use MessageSystems\SparkPost;
+ use MessageSystems\Transmission;
- $key = 'YOURAPIKEY';
- $sdk = new SparkPost(['key'=>$key]);
-
- $transmission = $sdk->Transmission();
+ $key = 'YOURAPIKEY';
+ SparkPost::setConfig(['key'=>$key]);
try {
- $results = $transmission->all();
+ $results = Transmission::all();
echo 'Congrats you can use your SDK!';
} catch (\Exception $exception) {
echo $exception->getMessage();
diff --git a/examples/transmission/get_transmission.php b/examples/transmission/get_transmission.php
index 86e9f0f..55cfe79 100644
--- a/examples/transmission/get_transmission.php
+++ b/examples/transmission/get_transmission.php
@@ -1,15 +1,14 @@
<?php
namespace Examples\Transmisson;
require_once (dirname(__FILE__).'/../bootstrap.php');
-use SparkPost\SparkPost;
-
-$key = 'YOURAPIKEY';
-$sdk = new SparkPost(['key'=>$key]);
-
-$transmission = $sdk->Transmission();
+ use MessageSystems\SparkPost;
+ use MessageSystems\Transmission;
+
+ $key = 'YOURAPIKEY';
+ SparkPost::setConfig(['key'=>$key]);
try {
- $results = $transmission->find('11860038888980495');
+ $results = Transmission::find('Your Transmission Id');
echo 'Congrats you can use your SDK!';
} catch (\Exception $exception) {
echo $exception->getMessage();
diff --git a/examples/transmission/mime_parts.php b/examples/transmission/mime_parts.php
deleted file mode 100644
index 2b68b46..0000000
--- a/examples/transmission/mime_parts.php
+++ /dev/null
@@ -1,29 +0,0 @@
-<?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
index 58c62cc..e2b7353 100644
--- a/examples/transmission/rfc822.php
+++ b/examples/transmission/rfc822.php
@@ -1,26 +1,23 @@
<?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");
-
+ use MessageSystems\SparkPost;
+ use MessageSystems\Transmission;
+
+ $key = 'YOURAPIKEY';
+ SparkPost::setConfig(['key'=>$key]);
try {
- $results = $transmission->send();
+ $results = Transmission::send([
+ 'recipients'=>[
+ [
+ 'address'=>[
+ 'email'=>'john.doe@sample.com'
+ ]
+ ]
+ ],
+ 'rfc822Part'=>"Content-Type: text/plain\nFrom: From Envelope <from@example.com>\nSubject: Example Email\n\nHello World"
+ ]);
echo 'Congrats you can use your SDK!';
} catch (\Exception $exception) {
echo $exception->getMessage();
diff --git a/examples/transmission/send_transmission_all_fields.php b/examples/transmission/send_transmission_all_fields.php
index 5aec6b8..6064e67 100644
--- a/examples/transmission/send_transmission_all_fields.php
+++ b/examples/transmission/send_transmission_all_fields.php
@@ -1,45 +1,41 @@
<?php
namespace Examples\Transmisson;
require_once (dirname(__FILE__).'/../bootstrap.php');
-use SparkPost\SparkPost;
+use MessageSystems\SparkPost;
+use MessageSystems\Transmission;
$key = 'YOURAPIKEY';
-$sdk = new SparkPost(['key'=>$key]);
+SparkPost::setConfig(['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();
+try{
+ $results = Transmission::send([
+ "campaign"=>"my-campaign",
+ "metadata"=>[
+ "sample_campaign"=>true,
+ "type"=>"these are custom fields"
+ ],
+ "substitutionData"=>[
+ "name"=>"Test Name"
+ ],
+ "description"=>"my description",
+ "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"
+ ]
+ ]
+ ]
+ ]);
echo 'Congrats you can use your SDK!';
} catch (\Exception $exception) {
echo $exception->getMessage();
diff --git a/examples/transmission/send_transmission_all_fields_method_based.php b/examples/transmission/send_transmission_all_fields_method_based.php
deleted file mode 100644
index 0f3314b..0000000
--- a/examples/transmission/send_transmission_all_fields_method_based.php
+++ /dev/null
@@ -1,45 +0,0 @@
-<?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
index 8dccdda..a545122 100644
--- a/examples/transmission/stored_recipients_inline_content.php
+++ b/examples/transmission/stored_recipients_inline_content.php
@@ -1,25 +1,25 @@
<?php
namespace Examples\Transmisson;
require_once (dirname(__FILE__).'/../bootstrap.php');
-use SparkPost\SparkPost;
+ use MessageSystems\SparkPost;
+ use MessageSystems\Transmission;
+
+ $key = 'YOURAPIKEY';
+ SparkPost::setConfig(['key'=>$key]);
+
-$key = 'YOURAPIKEY';
-$sdk = new SparkPost(['key'=>$key]);
+try {
+ $results = Transmission::send([
+ "campaign"=>"my-campaign",
+ "from"=>"From Envelope <from@example.com>",
+ "html"=>"<p>Hello World! Your name is: {{name}}</p>",
+ "text"=>"Hello World!",
+ "subject"=>"Example Email: {{name}}",
+ "recipientList"=>'Example List'
+ ]);
-$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();
diff --git a/examples/transmission/stored_template_send.php b/examples/transmission/stored_template_send.php
index 7a0e784..4d58c70 100644
--- a/examples/transmission/stored_template_send.php
+++ b/examples/transmission/stored_template_send.php
@@ -1,27 +1,24 @@
<?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');
+ use MessageSystems\SparkPost;
+ use MessageSystems\Transmission;
+
+ $key = 'YOURAPIKEY';
+ SparkPost::setConfig(['key'=>$key]);
try {
- $results = $transmission->send();
+ $results = Transmission::send([
+ "from"=>"From Envelope <from@example.com>",
+ "recipients"=>[
+ [
+ "address"=>[
+ "email"=>"john.doe@sample.com"
+ ]
+ ]
+ ],
+ "template"=>"my-template"
+ ]);
echo 'Congrats you can use your SDK!';
} catch (\Exception $exception) {
echo $exception->getMessage();