Help > API | PreviewMyEmail.com

What is API?

API (Application Programming Interface) allows you to integrate third party applications with PreviewMyEmail easily. PreviewMyEmail uses basic HTTP POST and GET methods to communicate. This makes integration even easier.

By using PreviewMyEmail's API feature, you can integrate it into your own services, websites or softwares as a re-branded service.

How To Use API

It's quite easy to use PreviewMyEmail's API and it can be accessed with any programming language and scripts. It simply uses basic HTTP POST/GET connection method to accept your data and returns the output in XML format.

How To Execute API

API can be reached through your PreviewMyEmail account:

http://youraccount.previewmyemail.com/api/

Example API Connection

The following API connection returns the number of available credits in your PreviewMyEmail account:

http://youraccount.previewmyemail.com/api/APIKey=4398033iuwew9823292329823298ej&Command=GetAvailableCredits

The return of this API call will be:

<?xml version="1.0"?>
<xml>
	<available_credits><![CDATA[24]]></available_credits>
</xml>

API Command Reference

CreatePreview
Creates a new preview request.
DeletePreview
Deletes the preview request.
FetchPreview
Returns the screen shots of the requested preview
RetryEmailClient
Retries an email client of a preview request.
GetAvailableCredits
Returns the number of available preview credits you have in your account.
GetPreviewList
Returns the preview requests you have made so far.
RetrieveEmailClients
Returns the list of online email applications and online services that are being monitored.
GetInboxMonitoringResults
Returns inbox delivery report of your email activities
SystemStatus
Returns the system status of our servers and email clients

CreatePreview

Creates a preview request based on the email content that is submitted with the command.

Input Parameters:

Command
CreatePreview
APIKey
{enter your API key which can be found in your account profile page}
EmailSubject
{enter the subject of your email}
EmailBody
{enter the body of your email with base64 and URL encoded formatted}
TargetEmailApps
{Provide the list of email apps you wish to test. Email application list can be retrieved with RetrieveEmailClients API command. Email app list must be set as array. Example: TargetEmailApps[]=5&TargetEmailApps[]=6}

Example:

http://youraccount.previewmyemail.com/api/APIKey=<your_api_key_here>&Command=CreatePreview&EmailSubject=<url_and_base64_encoded_subject>&EmailBody=<url_and_base64_encoded_email_body>&TargetEmailApps[]=5&TargetEmailApps[]=6

Output:

On error;

<?xml version="1.0"?>
<xml>
	<result><![CDATA[false]]></false>
	<reason><![CDATA[Not enough credits]]></reason>
</xml>

On success;

<?xml version="1.0"?>
<xml>
	<result><![CDATA[true]]></false>
	<jobid><![CDATA[239043049]]></jobid>
</xml>

{jobid} value is the key for accessing your preview later on.

DeletePreview

Deletes a preview request

Example:

http://youraccount.previewmyemail.com/api/APIKey=<your_api_key_here>&Command=DeletePreview&JobID=<job_id>

Input Parameters:

Command
FetchPreview
APIKey
{enter your API key which can be found in your account profile page}
JobID
{enter the job ID of your preview request to fetch and retrieve}

Output:

On error;

<?xml version="1.0"?>
	<result><![CDATA[false]]></false>
	<reason><![CDATA[Preview not found]]></reason>
</xml>

On success;

<?xml version="1.0"?>
	<result><![CDATA[true]]></false>
	<reason><![CDATA[]]></reason>
</xml>

FetchPreview

Returns the details and preview results of a specific preview request in your account.

Example:

http://youraccount.previewmyemail.com/api/APIKey=<your_api_key_here>&Command=FetchPreview&JobID=<job_id>

Input Parameters:

Command
FetchPreview
APIKey
{enter your API key which can be found in your account profile page}
JobID
{enter the job ID of your preview request to fetch and retrieve}

Output:

On error;

<?xml version="1.0"?>
	<result><![CDATA[false]]></false>
	<reason><![CDATA[Preview not found]]></reason>
</xml>

On success;

<?xml version="1.0"?>
<xml>
	<preview_details>
		<subject><![CDATA[Monthly newsletter preview]]></subject>
		<job_id><![CDATA[47747]]></job_id>
		<submit_date><![CDATA[2008-06-12 17:08:11]]></submit_date>
		<complete_date><![CDATA[2008-06-12 17:10:58]]></complete_date>
		<job_status><![CDATA[Completed]]></job_status>
		<public_share><![CDATA[Disabled]]></public_share>
		<public_share_key></public_share_key>
		<preview_results>
			<result>
				<client_code>AOL</client_code>
				<image_url_imageson><![CDATA[http://media.previewmyemail.com/previews/example/AOL_ImagesOn.jpg]]></image_url_imageson>
				<image_url_imagesoff><![CDATA[http://media.previewmyemail.com/previews/example/AOL_ImagesOff.jpg]]></image_url_imagesoff>
				<image_url_thumbnail><![CDATA[http://media.previewmyemail.com/previews/example/AOL_Tmb.jpg]]></image_url_thumbnail>
			</result>
			<result>
				<client_code>GoogleStandard</client_code>
				<image_url_imageson><![CDATA[http://media.previewmyemail.com/previews/example/GoogleStandard_ImagesOn.jpg]]></image_url_imageson>
				<image_url_imagesoff><![CDATA[http://media.previewmyemail.com/previews/example/GoogleStandard_ImagesOff.jpg]]></image_url_imagesoff>
				<image_url_thumbnail><![CDATA[http://media.previewmyemail.com/previews/example/GoogleStandard_Tmb.jpg]]></image_url_thumbnail>
			</result>
			<result>
				<client_code>Hotmail</client_code>
				<image_url_imageson><![CDATA[http://media.previewmyemail.com/previews/example/Hotmail_ImagesOn.jpg]]></image_url_imageson>
				<image_url_imagesoff><![CDATA[http://media.previewmyemail.com/previews/example/Hotmail_ImagesOff.jpg]]></image_url_imagesoff>
				<image_url_thumbnail><![CDATA[http://media.previewmyemail.com/previews/example/Hotmail_Tmb.jpg]]></image_url_thumbnail>
			</result>
			<result>
				<client_code>Outlook2003</client_code>
				<image_url_imageson><![CDATA[http://media.previewmyemail.com/previews/example/Outlook2003_ImagesOn.jpg]]></image_url_imageson>
				<image_url_imagesoff><![CDATA[http://media.previewmyemail.com/previews/example/Outlook2003_ImagesOff.jpg]]></image_url_imagesoff>
				<image_url_thumbnail><![CDATA[http://media.previewmyemail.com/previews/example/Outlook2003_Tmb.jpg]]></image_url_thumbnail>
			</result>
			<result>
				<client_code><![CDATA[Outlook2007]]></client_code>
				<image_url_imageson><![CDATA[N/A]]></image_url_imageson>
				<image_url_imagesoff><![CDATA[N/A]]></image_url_imagesoff>
				<image_url_thumbnail><![CDATA[N/A]]></image_url_thumbnail>
			</result>
			<result>
				<client_code>OutlookExpress</client_code>
				<image_url_imageson><![CDATA[http://media.previewmyemail.com/previews/example/OutlookExpress_ImagesOn.jpg]]></image_url_imageson>
				<image_url_imagesoff><![CDATA[http://media.previewmyemail.com/previews/example/OutlookExpress_ImagesOff.jpg]]></image_url_imagesoff>
				<image_url_thumbnail><![CDATA[http://media.previewmyemail.com/previews/example/OutlookExpress_Tmb.jpg]]></image_url_thumbnail>
			</result>
			<result>
				<client_code>Yahoo</client_code>
				<image_url_imageson><![CDATA[http://media.previewmyemail.com/previews/example/Yahoo_ImagesOn.jpg]]></image_url_imageson>
				<image_url_imagesoff><![CDATA[http://media.previewmyemail.com/previews/example/Yahoo_ImagesOff.jpg]]></image_url_imagesoff>
				<image_url_thumbnail><![CDATA[http://media.previewmyemail.com/previews/example/Yahoo_Tmb.jpg]]></image_url_thumbnail>
			</result>
		</preview_results>
	</preview_details>
</xml>

RetryEmailClient

Retries the email client preview result of a preview again. This command is useful if PreviewMyEmail has failed to preview the email on any email client.

Example:

http://youraccount.previewmyemail.com/api/APIKey=<your_api_key_here>&Command=RetryEmailClient&JobID=<job_id>&ClientCode=AOL

Input Parameters:

Command
RetryEmailClient
APIKey
{enter your API key which can be found in your account profile page}
JobID
{enter the job ID of your preview request to fetch and retrieve}
ClientCode
{enter the client code (Ex: AOL) of your preview to retry}

Output:

On error;

<?xml version="1.0"?>
	<result><![CDATA[false]]></false>
	<reason><![CDATA[Preview not found]]></reason>
</xml>

On success;

<?xml version="1.0"?>
	<result><![CDATA[true]]></false>
	<reason><![CDATA[]]></reason>
</xml>

GetAvailableCredits

Returns the number of available preview credits on your account.

Example:

http://youraccount.previewmyemail.com/api/APIKey=<your_api_key_here>&Command=GetAvailableCredits

Input Parameters:

Command
GetAvailableCredits
APIKey
{enter your API key which can be found in your account profile page}

Output:

On success;

<?xml version="1.0"?>
<xml>
	<available_credits><![CDATA[47]]></available_credits>
</xml>

GetPreviewList

Returns the list of all preview requests you have submitted so far.

Example:

http://youraccount.previewmyemail.com/api/APIKey=<your_api_key_here>&Command=GetPreviewList&JobID=<job_id>

Input Parameters:

Command
GetPreviewList
APIKey
{enter your API key which can be found in your account profile page}

Output:

On success;

<?xml version="1.0"?>
<xml>
	<preview>
		<subject><![CDATA[Monthly newsletter preview]]></subject>
		<job_id><![CDATA[47747]]></job_id>
		<submit_date><![CDATA[2008-06-12 17:08:11]]></submit_date>
		<job_status><![CDATA[Completed]]></job_status>
		<public_share><![CDATA[Disabled]]></public_share>
		<public_share_link></public_share_link>
	</preview>
	<preview>
		<subject><![CDATA[Product announcement email]]></subject>
		<job_id><![CDATA[66155]]></job_id>
		<submit_date><![CDATA[2008-06-12 15:50:40]]></submit_date>
		<job_status><![CDATA[Completed]]></job_status>
		<public_share><![CDATA[Enabled]]></public_share>
		<public_share_link></public_share_link>
	</preview>
	<preview>
		<subject><![CDATA[Service update email]]></subject>
		<job_id><![CDATA[23878]]></job_id>
		<submit_date><![CDATA[2008-06-12 09:18:27]]></submit_date>
		<job_status><![CDATA[Completed]]></job_status>
		<public_share><![CDATA[Enabled]]></public_share>
		<public_share_link></public_share_link>
	</preview>
</xml>

RetrieveEmailClients

Returns the list of available email desktop applications and online services in PreviewMyEmail.com service.

Example:

http://youraccount.previewmyemail.com/api/APIKey=<your_api_key_here>&Command=RetrieveEmailClients

Input Parameters:

Command
RetrieveEmailClients
APIKey
{enter your API key which can be found in your account profile page}

Output:

On success;

<?xml version="1.0"?>
<xml>
	<email_client>
		<client_id><![CDATA[5]]></client_id>
		<client_code><![CDATA[AOL]]></client_code>
		<client_name><![CDATA[AOL Web]]></client_name>
	</email_client>
	<email_client>
		<client_id><![CDATA[6]]></client_id>
		<client_code><![CDATA[GoogleStandard]]></client_code>
		<client_name><![CDATA[Gmail]]></client_name>
	</email_client>
	<email_client>
		<client_id><![CDATA[8]]></client_id>
		<client_code><![CDATA[Hotmail]]></client_code>
		<client_name><![CDATA[Hotmail]]></client_name>
	</email_client>
	<email_client>
		<client_id><![CDATA[7]]></client_id>
		<client_code><![CDATA[Outlook2003]]></client_code>
		<client_name><![CDATA[Outlook 2003]]></client_name>
	</email_client>
	<email_client>
		<client_id><![CDATA[10]]></client_id>
		<client_code><![CDATA[Outlook2007]]></client_code>
		<client_name><![CDATA[Outlook 2007]]></client_name>
	</email_client>
	<email_client>
		<client_id><![CDATA[21]]></client_id>
		<client_code><![CDATA[OutlookExpress]]></client_code>
		<client_name><![CDATA[Outlook Express]]></client_name>
	</email_client>
	<email_client>
		<client_id><![CDATA[22]]></client_id>
		<client_code><![CDATA[Yahoo]]></client_code>
		<client_name><![CDATA[Yahoo! Mail]]></client_name>
	</email_client>
</xml>

GetInboxMonitoringResults

Returns inbox delivery report of your email activities.

Example:

http://youraccount.previewmyemail.com/api/APIKey=<your_api_key_here>&Command=GetInboxMonitoringResults

Input Parameters:

Command
GetInboxMonitoringResults
APIKey
{enter your API key which can be found in your account profile page}

Output:

On success;

<?xml version="1.0"?>
<xml>
	<inbox_results>
		<result>
			<FromEmail><![CDATA[test@test.com]]></FromEmail>
			<EmailSubject><![CDATA[This is a test email]]></EmailSubject>
			<MessageID><![CDATA[<2309239203923akl@test.com>]]></MessageID>
			<JobSubmitDate><![CDATA[2009-12-10 10:00:00]]></JobSubmitDate>
			<HotmailCom><![CDATA[Inbox]]></HotmailCom>
			<DetectionTime_HotmailCom><![CDATA[2009-12-10 10:00:15]]></DetectionTime_HotmailCom>
			<YahooCom><![CDATA[Inbox]]></YahooCom>
			<DetectionTime_YahooCom><![CDATA[2009-12-10 10:00:12]]></DetectionTime_YahooCom>
			<AOLCom><![CDATA[Spam]]></AOLCom>
			<DetectionTime_AOLCom><![CDATA[2009-12-10 10:01:00]]></DetectionTime_AOLCom>
			<GmailCom><![CDATA[N/A]]></GmailCom>
			<DetectionTime_GmailCom><![CDATA[2009-12-10 10:00:30]]></DetectionTime_GmailCom>
			<MeCom><![CDATA[Inbox]]></MeCom>
			<DetectionTime_MeCom><![CDATA[2009-12-10 10:00:20]]></DetectionTime_MeCom>
			<MailCom><![CDATA[N/A]]></MailCom>
			<DetectionTime_MailCom><![CDATA[2009-12-10 10:00:22]]></DetectionTime_MailCom>
		</result>
		<result>
			<FromEmail><![CDATA[test1@test.com]]></FromEmail>
			<EmailSubject><![CDATA[This is a test email #2]]></EmailSubject>
			<MessageID><![CDATA[<2309239201289383akl@test.com>]]></MessageID>
			<JobSubmitDate><![CDATA[2009-12-11 10:00:00]]></JobSubmitDate>
			<HotmailCom><![CDATA[Inbox]]></HotmailCom>
			<DetectionTime_HotmailCom><![CDATA[2009-12-11 10:00:15]]></DetectionTime_HotmailCom>
			<YahooCom><![CDATA[Inbox]]></YahooCom>
			<DetectionTime_YahooCom><![CDATA[2009-12-11 10:00:12]]></DetectionTime_YahooCom>
			<AOLCom><![CDATA[Spam]]></AOLCom>
			<DetectionTime_AOLCom><![CDATA[2009-12-11 10:01:00]]></DetectionTime_AOLCom>
			<GmailCom><![CDATA[N/A]]></GmailCom>
			<DetectionTime_GmailCom><![CDATA[2009-12-11 10:00:30]]></DetectionTime_GmailCom>
			<MeCom><![CDATA[Inbox]]></MeCom>
			<DetectionTime_MeCom><![CDATA[2009-12-11 10:00:20]]></DetectionTime_MeCom>
			<MailCom><![CDATA[N/A]]></MailCom>
			<DetectionTime_MailCom><![CDATA[2009-12-11 10:00:22]]></DetectionTime_MailCom>
		</result>
	</inbox_results>
</xml>

SystemStatus

Returns the system status of our servers and email clients.

Example:

http://youraccount.previewmyemail.com/api/APIKey=<your_api_key_here>&Command=SystemStatus

Input Parameters:

Command
SystemStatus
APIKey
{enter your API key which can be found in your account profile page}

Output:

On success;

<?xml version="1.0"?>
<xml>
	<email_client>
		<client_id><![CDATA[17]]></client_id>
		<client_code><![CDATA[AOLDesktop10]]></client_code>
		<client_name><![CDATA[AOL Desktop 10]]></client_name>
		<status><![CDATA[Online]]></status>
	</email_client>
	<email_client>
		<client_id><![CDATA[4]]></client_id>
		<client_code><![CDATA[AOL]]></client_code>
		<client_name><![CDATA[AOL Web (Basic)]]></client_name>
		<status><![CDATA[Online]]></status>
	</email_client>
	<email_client>
		<client_id><![CDATA[28]]></client_id>
		<client_code><![CDATA[AOLStandard]]></client_code>
		<client_name><![CDATA[AOL Web (Standard)]]></client_name>
		<status><![CDATA[Online]]></status>
	</email_client>
	<email_client>
		<client_id><![CDATA[20]]></client_id>
		<client_code><![CDATA[AppleMail]]></client_code>
		<client_name><![CDATA[Apple Mail]]></client_name>
		<status><![CDATA[Online]]></status>
	</email_client>
	<email_client>
		<client_id><![CDATA[21]]></client_id>
		<client_code><![CDATA[Entourage]]></client_code>
		<client_name><![CDATA[Entourage 2008]]></client_name>
		<status><![CDATA[Online]]></status>
	</email_client>
	<email_client>
		<client_id><![CDATA[10]]></client_id>
		<client_code><![CDATA[Gmail]]></client_code>
		<client_name><![CDATA[Gmail]]></client_name>
		<status><![CDATA[Online]]></status>
	</email_client>
	<email_client>
		<client_id><![CDATA[29]]></client_id>
		<client_code><![CDATA[gmx]]></client_code>
		<client_name><![CDATA[GMX]]></client_name>
		<status><![CDATA[Temporary Offline]]></status>
	</email_client>
	<email_client>
		<client_id><![CDATA[3]]></client_id>
		<client_code><![CDATA[Hotmail]]></client_code>
		<client_name><![CDATA[Hotmail]]></client_name>
		<status><![CDATA[Online]]></status>
	</email_client>
	<email_client>
		<client_id><![CDATA[30]]></client_id>
		<client_code><![CDATA[iphone3]]></client_code>
		<client_name><![CDATA[iPhone]]></client_name>
		<status><![CDATA[Online]]></status>
	</email_client>
	<email_client>
		<client_id><![CDATA[16]]></client_id>
		<client_code><![CDATA[Lotus8]]></client_code>
		<client_name><![CDATA[Lotus Notes 8]]></client_name>
		<status><![CDATA[Online]]></status>
	</email_client>
	<email_client>
		<client_id><![CDATA[19]]></client_id>
		<client_code><![CDATA[MailCom]]></client_code>
		<client_name><![CDATA[Mail.com]]></client_name>
		<status><![CDATA[Online]]></status>
	</email_client>
	<email_client>
		<client_id><![CDATA[18]]></client_id>
		<client_code><![CDATA[MobileMe]]></client_code>
		<client_name><![CDATA[MobileMe]]></client_name>
		<status><![CDATA[Online]]></status>
	</email_client>
	<email_client>
		<client_id><![CDATA[9]]></client_id>
		<client_code><![CDATA[Thunderbird]]></client_code>
		<client_name><![CDATA[Mozilla Thunderbird]]></client_name>
		<status><![CDATA[Online]]></status>
	</email_client>
	<email_client>
		<client_id><![CDATA[26]]></client_id>
		<client_code><![CDATA[Thunderbirdv3]]></client_code>
		<client_name><![CDATA[Mozilla Thunderbird v3]]></client_name>
		<status><![CDATA[Online]]></status>
	</email_client>
	<email_client>
		<client_id><![CDATA[7]]></client_id>
		<client_code><![CDATA[Outlook2003]]></client_code>
		<client_name><![CDATA[Outlook 2003]]></client_name>
		<status><![CDATA[Online]]></status>
	</email_client>
	<email_client>
		<client_id><![CDATA[8]]></client_id>
		<client_code><![CDATA[Outlook2007]]></client_code>
		<client_name><![CDATA[Outlook 2007]]></client_name>
		<status><![CDATA[Online]]></status>
	</email_client>
	<email_client>
		<client_id><![CDATA[27]]></client_id>
		<client_code><![CDATA[Outlook2010]]></client_code>
		<client_name><![CDATA[Outlook 2010 Beta]]></client_name>
		<status><![CDATA[Online]]></status>
	</email_client>
	<email_client>
		<client_id><![CDATA[6]]></client_id>
		<client_code><![CDATA[OutlookXP]]></client_code>
		<client_name><![CDATA[Outlook Express]]></client_name>
		<status><![CDATA[Online]]></status>
	</email_client>
	<email_client>
		<client_id><![CDATA[23]]></client_id>
		<client_code><![CDATA[WindowsLiveMail]]></client_code>
		<client_name><![CDATA[Windows Live Mail]]></client_name>
		<status><![CDATA[Online]]></status>
	</email_client>
	<email_client>
		<client_id><![CDATA[25]]></client_id>
		<client_code><![CDATA[WM61]]></client_code>
		<client_name><![CDATA[Windows Mobile 6.1]]></client_name>
		<status><![CDATA[Online]]></status>
	</email_client>
	<email_client>
		<client_id><![CDATA[24]]></client_id>
		<client_code><![CDATA[YahooStandard]]></client_code>
		<client_name><![CDATA[Yahoo! Mail]]></client_name>
		<status><![CDATA[Online]]></status>
	</email_client>
	<email_client>
		<client_id><![CDATA[2]]></client_id>
		<client_code><![CDATA[Yahoo]]></client_code>
		<client_name><![CDATA[Yahoo! Mail (Classic)]]></client_name>
		<status><![CDATA[Online]]></status>
	</email_client>
</xml>

Any questions? Don't hesitate to contact us anytime.

What is API?

How To Use API

How To Execute API

Example API Connection

API Command Reference

CreatePreview

DeletePreview

FetchPreview

RetryEmailClient

GetAvailableCredits

GetPreviewList

RetrieveEmailClients

GetInboxMonitoringResults

SystemStatus

Get Notified About Latest Updates

Contact Us