sample-newsletter.php

<?php
/**
 * SendGrid Newsletter PHP API ...
 *
 * Copyright (C) 2011  Alon Ben David
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/gpl-3.0.txt>.
 *
 *
 * @author Alon Ben David - CoolGeex.com
 * 
 * All the methods returns an array of data or one string / int
 * If false returned you can run getLastResponseError() to see the error information
 * If error information == NULL then no error accrued (Ex: deleting a record returns 0 records deleted if no record found)
 *
 * methods that ends with _helper are not supported directly by sendgrid (they are help functions - Ex: newsletter_lists_email_edit_helper)
 * 
*/

require_once "sendgrid/newsletter.php";

$sg_user = 'YOUR_SEND_GRID_USER'; 
$sg_api_key = 'YOUR_SEND_GRID_PASSWORD';

//Creates a new SendGrid Newsletter API object to make calls with
/*
 * YOU CAN ALSO SET $debug to true for DEBUGGING and $curl_ssl_verify to false for disabling cert verification
 * ($user, $key , $debug = false , $curl_ssl_verify = true)
 *
*/ 
$sendgrid = new sendgridNewsletter($sg_user,$sg_api_key); 

$text = 'Newsletter text goes here';
$html = '<div>Newsletter html goes here</div>';


/**
 * Create a new Newsletter...
 * @param string $identity - The Identity that will be used for the Newsletter being created.
 * @param string $name - The name that will be used for the Newsletter being created.
 * @param string $subject - The subject that will be used for the Newsletter being created.
 * @param string $text - The text portion of the Newsletter being created.
 * @param string $html - The html portion of the Newsletter being created.
 */
$sendgrid->newsletter_add($identity, $name = 'Newsletter Using API' , $subject , $text , $html);

/**
 * Edit an existing Newsletter...
 * @param string $identity - The new Identity for the Newsletter being edited.
 * @param string $name	- The name of the Newsletter being updated.
 * @param string $newname - The new name for the Newsletter being edited.
 * @param string $subject -The new subject that will be used for the Newsletter being edited.
 * @param string $text - The new text portion of the Newsletter being edited.
 * @param string $html - The new html portion of the Newsletter being edited.
 */
$sendgrid->newsletter_edit($identity, $name , $newname = 'Newsletter Using API' , $subject , $text , $html);

/**
 * Retrieve the content of an existing Newsletter.
 * @param string $name	- Must be an existing Newsletter
 */
$sendgrid->newsletter_get($name);

/**
 * Retrieve a list of all existing Newsletter.
 * @param string $name	- Can be an existing Newsletter
 */
$sendgrid->newsletter_list($name = '');
//$r = $sendgrid->newsletter_list();
//print_r($r);

/**
 * Remove the Newsletter with this name..
 * @param string $name	- Must be an existing Newsletter
 */
$sendgrid->newsletter_delete($name);


/**
 * Create a new Recipient List...
 * @param string $list	- Create a Recipient List with this name.
 * @param string $name	- Specify the column name for the ‘name’ associated with email addresses..
 */
$sendgrid->newsletter_lists_add($list , $name = '');


/**
 * 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);

/**
 * 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 = '');

/**
 * Remove this Recipient List....
 * @param string $list	- Must be an existing Recipient List.
 */
$sendgrid->newsletter_lists_delete($list);

/**
 * Add an email to an existing Recipient List.
 * @param string $list	- The list which you are adding email addresses too.
 * @param array $data	- Specify the name, email address, and additional fields to add to the specified Recipient 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)
 */
$sendgrid->newsletter_lists_email_add($list , $data);


/**
 * Edit an email of an existing Recipient List. (Not Supported by SENDGRID)
 * @param string $list	- The list which you are editing the contact
 * @param string $email	- The Contact which you are editing
 * @param array $data	- Specify the name, email address, and additional fields to add to the specified Recipient 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)
 */
$sendgrid->newsletter_lists_email_edit_helper($list , $email , $data)


/**
 * Get the email addresses and associated fields for a Recipient List.
 * @param string $list	- The list you are searching.
 * @param string $email	- Optional email addresses to search for in the Recipient List.
 */
$sendgrid->newsletter_lists_email_get($list , $email = '');


/**
 * Remove one email from a Recipient List.
 * @param string $list	- The list which you are removing email addresses from..
 * @param string $email	- Specify the email address or email addresses you wish to remove from the specified Recipient List..
 */
$sendgrid->newsletter_lists_email_delete($list , $email);

/**
 * Create a new Identity.
 * @param string $identity	- Create an Identity named this.
 * @param string $name	- Specify the name to be used for this Identity.
 * @param string $email	- Specify the email address to be used for this Identity.
 * @param string $address	- Create an Identity named this.
 * @param string $city	- Specify the city to be used for this Identity.
 * @param string $state	- Specify the state code to be used for this Identity.
 * @param string $zip	- Specify the zip code to be used for this Identity.
 * @param string $country	- Specify the country code to be used for this Identity.
 */
$sendgrid->newsletter_identity_add($identity , $name , $email , $address , $city , $state , $zip , $country);

/**
 * Edit an existing Identity..
 * @param string $identity	- The Identity you wish to edit.
 * @param string $newidentity	- Specify the new name to be used for this Identity.
 * @param string $name	- Specify the name to be used for this Identity.
 * @param string $email	- Specify the email address to be used for this Identity.
 * @param string $address	- Create an Identity named this.
 * @param string $city	- Specify the city to be used for this Identity.
 * @param string $state	- Specify the state code to be used for this Identity.
 * @param string $zip	- Specify the zip code to be used for this Identity.
 * @param string $country	- Specify the country code to be used for this Identity.
 */
$sendgrid->newsletter_identity_edit($identity , $newidentity , $name , $email , $address , $city , $state , $zip , $country); 
/**
 * Retrieve information associated with a particular Identity.
 * @param string $identity	- Retrieve contents of the specified Identity.
 */
$sendgrid->newsletter_identity_get($identity); 

/**
 * List all Identities on your account, or check if a particular Identity exists.
 * @param string $identity	- Check for this particular Identity. (To list all Identities on your account exclude this parameter);
 */
$sendgrid->newsletter_identity_list($identity = '');
//$r = $sendgrid->newsletter_identity_list(); 
//print_r($r);
/**
 * Remove an Identity from your account.
 * @param string $identity	- Remove the specified Identity from your account.
 */
$sendgrid->newsletter_identity_delete($identity);

/**
 * Add one or more Recipient List to a Newsletter.
 * @param string $name	- This is the Newsletter to which you are adding Recipients Lists.
 * @param string $name	- This is the Recipient List that will be added to the Newsletter
 */
$sendgrid->newsletter_recipients_add($name , $list);

/**
 * Retrieve the Recipient Lists attached to an existing Newsletter.
 * @param string $name	- Retrieve the Recipient Lists of an existing Newsletter.
 */
$sendgrid->newsletter_recipients_get($name); 

/**
 * Add one or more Recipient List to a Newsletter.
 * @param string $name	- Newsletter to remove Recipient Lists from.
 * @param string $list	- Recipient Lists to remove.
 */
$sendgrid->newsletter_recipients_delete($name , $list); 

/**
 * Create a new schedule event.
 * @param string $name	- Newsletter to schedule delivery for. (If Newsletter should be sent now, include no additional parameters.);
 * @param string $at	- Date / Time to schedule newsletter Delivery.
 *	Date / Time must be provided in ISO 8601 format (YYYY-MM-DD HH:MM:SS +-HH:MM);
 * @param string $after	- Number of minutes until delivery should occur. Must be a positive integer.
 */
$sendgrid->newsletter_schedule_add($name , $at ='' , $after ='');

/**
 * Retrieve the scheduled delivery time for an existing Newsletter.
 * @param string $name	- Retrieve the delivery time scheduled for this Newsletter.
 */
$sendgrid->newsletter_schedule_get($name);

/**
 * Cancel a scheduled send for a Newsletter.
 * @param string $name	- Remove the scheduled delivery time from an existing Newsletter.
 */
$sendgrid->newsletter_schedule_delete($name);

?>