emailGet
public static array emailGet(string token, string filter, integer pageNumber, integer pageSize, string orderBy, string sortOrder)
Get the list of emails using the filter and paging limits, order by the name or date of the email.
Section
Email Campaign Related Methods

Parameters
string tokenA valid token for your account. To generate a token, use the login method.
string filterShow emails where the email name starts with the filter
string statusFetch emails matching a status(-1 = All, 0 = Draft, 1 = Scheduled, 2 = Sent)
integer pageNumberFetch results from the given page number.
integer pageSizeNumber of results per page.
string orderBySort the results based on "name" or "date".
string sortOrderSort the results in the "asc"ending or "desc"ending order.

Returns
arrayReturns an array with the results.

Return Structure
integer sequenceThe sequence number of the record
string idThe ID of the email campaign. To get the details of this campaign, use the emailGetDetail method.
string emailNameName of the email campaign
string fromNameThe from name that appears in the recipients inbox
string subjectThe subject line of the email
integer toListIDThe ID of the target contact list
string toListNameThe name of the target contact list
string statusThe status of the email. Can be 'Draft', 'Scheduled', 'Sent', 'Incomplete'
string createdDateThe date on which the list was created
string modifiedDateThe date on which the list was last updated


Examples
download example code
xmlrpc_emailGet.php


  1. <?php
  2. /**
  3. This Example shows how to authenticate a user using XML-RPC.
  4. Note that we are using the PEAR XML-RPC client and recommend others do as well.
  5. **/
  6. require_once 'XML/RPC2/Client.php';
  7. require_once 'inc/config.php';
  8. $client = XML_RPC2_Client::create($apiURL);
  9. $token = $client->login($apiLogin, $apiPassword);
  10. $emailLists = $client->emailGet($token, "", "", 1, 100, "", "");
  11.  
  12. foreach($emailLists as $rec) {
  13.     echo $rec['sequence'] . "] Email Name: " . $rec['emailName'] . "(" . $rec['id'] . ")";
  14.     echo "\t To List:" . $rec['toListName'] . "(" . $rec['toListID'] . ")";
  15.     echo "\t Subject:" . $rec['subject'] ;
  16.     echo "\t Status:" . $rec['status'] ;
  17.     echo "\t Created Date: " . $rec['createdDate'] ;
  18.     echo "\t Updated Date: " . $rec['modifiedDate'];
  19.     echo "<br />";
  20. }
  21.  
  22. ?>