diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 44 |
1 files changed, 34 insertions, 10 deletions
@@ -13,7 +13,7 @@ curl -sS https://getcomposer.org/installer | php ``` Next, run the Composer command to install the SparkPost PHP SDK: ``` -composer require messagesystems/php-sdk +composer require sparkpost/php-sparkpost ``` After installing, you need to require Composer's autoloader: ``` @@ -26,14 +26,14 @@ SparkPost::setConfig(["key"=>"YOUR API KEY"]); try { // Build your email and send it! - Transmission::send(['campaign'=>'first-mailing', + Transmission::send(array('campaign'=>'first-mailing', 'from'=>'you@your-company.com', 'subject'=>'First SDK Mailing', 'html'=>'<html><body><h1>Congratulations, {{name}}!</h1><p>You just sent your very first mailing!</p></body></html>', 'text'=>'Congratulations, {{name}}!! You just sent your very first mailing!', - 'substitutionData'=>['name'=>'YOUR FIRST NAME'], - 'recipients'=>[['address'=>['name'=>'YOUR FULL NAME', 'email'=>'YOUR EMAIL ADDRESS' ]]] - ]); + 'substitutionData'=>array('name'=>'YOUR FIRST NAME'), + 'recipients'=>array(array('address'=>array('name'=>'YOUR FULL NAME', 'email'=>'YOUR EMAIL ADDRESS' ))) + )); echo 'Woohoo! You just sent your first mailing!'; } catch (Exception $err) { @@ -44,9 +44,33 @@ try { ## Learn More * For more detailed examples, check our examples: - * [Transmissions](https://github.com/MessageSystems/php-sdk/tree/master/examples/transmission/) + * [Transmissions](https://github.com/SparkPost/php-sparkpost/tree/master/examples/transmission) * Read our REST API documentation - <http://www.sparkpost.com/docs/introduction> +## Field Descriptions +### Transmissions +| Field Name | Required? | Description | Data Type | +| ------------ | ----------- | ------------- | ----------- | +| description | no | Field for describing what this transmission is for the user | String | +| campaign | no | Field for assigning a given transmission to a specific campaign, which is a logical container for similar transmissions | String | +| metadata | no | Field for adding arbitrary key/value pairs which will be included in open/click tracking | Object (Simple) | +| substitutionData | no | Field for adding transmission level substitution data, which can be used in a variety of fields and in content | Object (Complex) | +| trackOpens | no | Field for enabling/disabling transmission level open tracking (default: true) | Boolean | +| trackClicks | no | Field for enabling/disabling transmission level click tracking (default: true) | Boolean | +| useDraftTemplate | no | Field for allowing the sending of a transmission using a draft of a stored template (default: false) | Boolean | +| replyTo | no | Field for specifying the email address that should be used when a recipient hits the reply button | String | +| subject | yes | Field for setting the subject line of a given transmission | String | +| from | yes | Field for setting the from line of a given transmission | String or Object | +| html | yes** | Field for setting the HTML content of a given transmission | String | +| text | yes** | Field for setting the Plain Text content of a given transmission | String | +| rfc822 | no** | Field for setting the RFC-822 encoded content of a given transmission | String | +| template | no** | Field for specifying the Template ID of a stored template to be used when sending a given transmission | String | +| customHeaders | no | Field for specifying additional headers to be applied to a given transmission (other than Subject, From, To, and Reply-To) | Object (Simple) | +| recipients | yes** | Field for specifying who a given transmission should be sent to | Array of Objects | +| recipientList | no** | Field for specifying a stored recipient list ID to be used for a given transmission | String | + +** - If using inline content then html or text are required. If using RFC-822 Inline Content, then rfc822 is required. If using a stored recipient list, then recipientList is required. If using a stored template, then template is required. + ## Tips and Tricks ### General * You _must_ provide at least an API key when instantiating the SparkPost Library - `[ 'key'=>'184ac5480cfdd2bb2859e4476d2e5b1d2bad079bf' ]` @@ -63,12 +87,12 @@ try { ## Development ### Setup -We use [Robo](http://robo.li/) for our task runner. - -Run `composer install` inside the directory to install dependecies and development tools including Robo. +Run `composer install` inside the directory to install dependecies and development tools. ### Testing -Once all the dependencies are installed, you can execute the unit tests using `vendor\bin\robo test` +Once all the dependencies are installed, you can execute the unit tests using `vendor/bin/phpunit --bootstrap test/unit/bootstrap.php ./test/unit`. + +If you're interested in code coverage, you can add the `--coverage` flag for phpunit like so: ```phpunit --coverage-html test/output/report --bootstrap test/unit/bootstrap.php ./test/unit``` ### Contributing Guidelines for adding issues |