Skip to content

Commit

Permalink
Fixes documentation text for few methods
Browse files Browse the repository at this point in the history
Better documentation for few methods
  • Loading branch information
alonbendavid committed Sep 7, 2011
1 parent 9768769 commit a3750ff
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 4 deletions.
6 changes: 6 additions & 0 deletions .gitignore
@@ -0,0 +1,6 @@

sendgrid/core/.DS_Store

sendgrid/.DS_Store

.DS_Store
7 changes: 5 additions & 2 deletions sample-newsletter.php
Expand Up @@ -89,14 +89,14 @@


/**
* Create a new Recipient List...
* Edit (Rename) an Existing Recipient List...
* @param string $list - This is the name of the Recipient List to be renamed..
* @param string $newlist - Specify the new name for the Recipient List.
*/
//$sendgrid->newsletter_lists_edit($list , $newlist);

/**
* Create a new Recipient List...
* Get an Existing Recipient List...
* @param string $list - Check for this particular list. (To list all Recipient Lists on your account exclude this parameter);
*/
//$sendgrid->newsletter_lists_get($list = '');
Expand All @@ -114,7 +114,10 @@
* EX: $data = array(
* 'email' => 'test1@test.com',
* 'name' => 'John Doe',
* 'Address' => '1234 Cool St',
* 'Zip Code' => '90210',
* );
* must use email and name fields (other fileds are optional)
*/
//$sendgrid->newsletter_lists_email_add($list , $data);

Expand Down
7 changes: 5 additions & 2 deletions sendgrid/newsletter.php
Expand Up @@ -142,7 +142,7 @@ public function newsletter_lists_add($list , $name = '') {
}

/**
* Create a new Recipient List...
* Edit an Existing Recipient List...
* @param string $list - This is the name of the Recipient List to be renamed..
* @param string $newlist - Specify the new name for the Recipient List.
*/
Expand All @@ -158,7 +158,7 @@ public function newsletter_lists_edit($list , $newlist) {
}

/**
* Create a new Recipient List...
* Get an Existing Recipient List...
* @param string $list - Check for this particular list. (To list all Recipient Lists on your account exclude this parameter)
*/
public function newsletter_lists_get($list = '') {
Expand Down Expand Up @@ -192,7 +192,10 @@ public function newsletter_lists_delete($list) {
* EX: $data = array(
* 'email' => 'test1@test.com',
* 'name' => 'John Doe',
* 'Address' => '1234 Cool St',
* 'Zip Code' => '90210',
* );
* must use email and name fields (other fileds are optional)
*/
public function newsletter_lists_email_add($list , $data) {
$url = "newsletter/lists/email/add";
Expand Down

0 comments on commit a3750ff

Please sign in to comment.