campaignSendTest – v1.1

 campaignSendTest(string apikey, string cid, array test_emails, string send_type)

Send a test of this campaign to the provided email address

Section
Campaign Related

Parameters
apikey	a valid API Key for your user account. Get by calling Get by visiting your API dashboard
cid	the id of the campaign to test
test_emails	an array of email address to receive the test message
send_type	optional - by default (null) both formats are sent - "html" or "text" send just that format

Returns
boolean	true on success

Examples (2)

download example code

[1] mcapi_campaignSendTest.php

<?php
/**
This Example shows how to send Campaign Tests via the MCAPI class.
 
Note that a max of 25 of these may be sent
**/
require_once 'inc/MCAPI.class.php';
require_once 'inc/config.inc.php'; //contains apikey
 
$api = new MCAPI($apikey);
 
$emails = array($my_email, $boss_man_email);
$retval = $api->campaignSendTest($campaignId, $emails);
 
if ($api->errorCode){
	echo "Unable to Send Test Campaign!";
	echo "\n\tCode=".$api->errorCode;
	echo "\n\tMsg=".$api->errorMessage."\n";
} else {
	echo "Campaign Tests Sent!\n";
}
 

[2] xml-rpc_campaignSendTest.php

<?php
/**
This Example shows how to immediately Send a Test message for a prepared Campaign 
using XML-RPC.
Note that a max of 25 of these may be sent
Note that we are using the PEAR XML-RPC client and recommend others do as well.
**/
require_once 'XML/RPC2/Client.php';
require_once 'inc/config.inc.php';
try {
    $client = XML_RPC2_Client::create($apiUrl);
 
    $emails = array($my_email, $boss_man_email);
	$result = $client->campaignSendTest($apikey, $campaignId, $emails);
	echo "SUCCESS! \n";
	echo "Returned: ".$result."\n";
 
} catch (XML_RPC2_FaultException $e){
	echo "ERROR!!!!\n";
	echo $e->getFaultCode()." : ".$e->getFaultString()."\n";
}
?>