Use this method to send a preview email to a specific email address. You must specify the ID of the email you want to preview, and the email address of the recipient you want the system to send the preview to.
Your method must be structured as follows:
The following parameters are required for this method to work:
|$id||integer||The ID of the email to create a preview of.||yes|
|$recipient||string||The email address of the person to which the preview must be sent.||yes|
|boolean||If the preview was successful or not.|
$recipient = 'firstname.lastname@example.org';
$url = '(Your URL)/api/2.0/email_actions/email_preview/:email_id/' . $recipient;
$method = 'POST';
$cSession = curl_init();
$headers = array();
$auth = base64_encode($username . ':' . $apikey);
$headers = 'Authorization: Basic ' . $auth;
curl_setopt($cSession, CURLOPT_URL, $url);
curl_setopt($cSession, CURLOPT_RETURNTRANSFER, true);
curl_setopt($cSession, CURLOPT_HEADER, false);
curl_setopt($cSession, CURLOPT_CUSTOMREQUEST, strtoupper($method));
curl_setopt($cSession, CURLOPT_HTTPHEADER, $headers);
$result = curl_exec($cSession);
The rest of this document describes the example above, step-by-step.
In our Getting Started section we covered the four important components of an API request; URL, method, headers, and body.
Let's analyse the code sample above to determine where each line fits into this outline.
The following line of code sets the email of the recipient of the preview email in a parameter.
The following line of code tells the server which API URL to access for the request, as well as the email of the recipient defined in the $recipient parameter:
In this line of code, you tell the API which REST function to use:
cURL is a tool for sending and receiving files from a web server. This line of code initialises the cURL session.
This section of the code opens the headers section and passes the authentication (including your API key).
The first line uses the $url to get your specified url
The second line returns the string (text) of the return value.
The third line tells the server not to include the header in the ouput.
The fourth line calls the $method specified above.
Call the headers using the $headers method.