PreviewMyEmail.com - Preview Your Email In Popular Email Clients With a Single Click

API

PreviewMyEmail allows you to access your account data through any third party application by using straight-forward PreviewMyEmail API methods.

In order to get benefit of this service, you will need to enable it through your control panel. After logging into your account, click "Manage Account" link on the top right menu and scroll down to API box.

You can activate your API access for only $25 USD per month. This great service will let you to do following;

Make your own application and integrate it into us. Charge your customers at higher fees and use our infrastructure. Your customers will never know us.
Make your own dashboard widgets
Integrate into your own projects
much more. There are hundreds of ways and ideas to use PreviewMyEmail in your business

PreviewMyEmail API accepts following connection methods:

GET
POST
XML

Connection Examples

Below, you can see a few example connections to PreviewMyEmail API:

POST Connection http://youraccount.previewmyemail.com/api/Command=RetrieveEmailClients&APIKey=xxxxxxxxxxxxxx
GET Connection http://youraccount.previewmyemail.com/api/Command=RetrieveEmailClients&APIKey=xxxxxxxxxxxxxx
XML Connection http://youraccount.previewmyemail.local/api/Mode=XML&XMLData=%3Cxml%3E%3CCommand%3ERetrieveEmailClients%3C/Command%3E%3CAPIKey%3Exxxxxxxxxxxxxx%3C/APIKey%3E%3C/xml%3E

API Commands

Retrieve Email Clients

This command returns you the list of email clients and services that are being monitored at the moment.

Required parameters:

Command=RetrieveEmailClients
APIKey=xxxxxxxxxx

Returned Data:

<?xml version="1.0"?>
<xml>
	<email_client>
		<client_code><![CDATA[AOL]]></client_code>
		<client_name><![CDATA[AOL Web]]></client_name>
	</email_client>
	<email_client>
		<client_code><![CDATA[GoogleStandard]]></client_code>
		<client_name><![CDATA[Gmail]]></client_name>
	</email_client>
	<email_client>
		<client_code><![CDATA[Hotmail]]></client_code>
		<client_name><![CDATA[Hotmail]]></client_name>
	</email_client>
	<email_client>
		<client_code><![CDATA[Outlook2003]]></client_code>
		<client_name><![CDATA[Outlook 2003]]></client_name>
	</email_client>
	<email_client>
		<client_code><![CDATA[Outlook2007]]></client_code>
		<client_name><![CDATA[Outlook 2007]]></client_name>
	</email_client>
	<email_client>
		<client_code><![CDATA[OutlookExpress]]></client_code>
		<client_name><![CDATA[Outlook Express]]></client_name>
	</email_client>
	<email_client>
		<client_code><![CDATA[Yahoo]]></client_code>
		<client_name><![CDATA[Yahoo! Mail]]></client_name>
	</email_client>
</xml>

Get Available Credits

This command returns you the available credits in your account. If you are subscribed to monthly unlimited plan, this command will return "unlimited" value instead of credit amount.

Required parameters:

Command=GetAvailableCredits
APIKey=xxxxxxxxxx

Returned Data:

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

Delete Preview Request

This command allows you to delete preview request in your account.

Required parameters:

Command=CreatePreview
APIKey=xxxxxxxxxx
JobID=xxxxxxxxxx

Returned Data:

If preview not found in your account:

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

If successful::

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

Create Preview Request

This command allows you to create a new design preview request.

Required parameters:

Command=CreatePreview
APIKey=xxxxxxxxxx
EmailSubject=xxxxxxxxxx
The value must be base64 and URL encoded
EmailBody=xxxxxxxxxx
The value must be base64 and URL encoded

Returned Data:

If there's no enough credits in your account:

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

If successful, it returns the Job ID:

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

Preview List

This command returns you the list of all previews you have performed in your account.

Required parameters:

Command=GetPreviewList
APIKey=xxxxxxxxxx

Returned Data:

<?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>
		<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>
	<preview>
		<subject><![CDATA[Product announcement email]]></subject>
		<job_id><![CDATA[66155]]></job_id>
		<submit_date><![CDATA[2008-06-12 15:50:40]]></submit_date>
		<complete_date><![CDATA[2008-06-12 17:08:27]]></complete_date>
		<job_status><![CDATA[Completed]]></job_status>
		<public_share><![CDATA[Enabled]]></public_share>
		<public_share_key><![CDATA[DgOiq]]></public_share_key>
	</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>
		<complete_date><![CDATA[2008-06-12 09:20:59]]></complete_date>
		<job_status><![CDATA[Completed]]></job_status>
		<public_share><![CDATA[Enabled]]></public_share>
		<public_share_key><![CDATA[JeaNk]]></public_share_key>
	</preview>
</xml>

Preview Details

This command returns you the details of a preview you have made before.

Required parameters:

Command=FetchPreview
APIKey=xxxxxxxxxx
JobID=xxxxxxxxxx

Returned Data:

<?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>

Help Topics

Questions?

For any questions, don't hesitate to contact us anytime.

Help Center

API

Connection Examples

API Commands

Help Topics

Questions?