Support and Documentation


Important!
This documentation has been deprecated. We are migrating Oempro help articles to our new help portal. Take a look at more detailed help articles on our new help portal.

Sections:

  1. Description
  2. Oempro Version
  3. Request Parameters
  4. Response Parameters
  5. Error Codes

Email.DesignPreview.Create

Description

Submits the email to design preview service. This service will show you how your email design looks like in various email clients such as Outlook, Outlook Express, Thunderbird, Gmail, Yahoo!, AOL, Lotus Notes, etc.

Oempro Version

4+

Request Parameters

SessionID = {string} (required)
Session ID which is needed to authenticate the access. It's optional and required for desktop applications only
Command = {Email.DesignPreview.Create} (required)
API Command
ResponseFormat = {JSON | XML} (required)
Response format
JSONPCallBack = {bool}
Send this parameter for cross-domain. More info about JSONP can be found here: http: //en.wikipedia.org/wiki/JSON#JSONP
EmailID = {integer} (required)
Email ID number

Response Parameters

Success = {true | false}
States if there is an error or not
ErrorCode = {integer}
If there is an error, error's code
JobID = {integer}
Internal design preview job ID
PreviewMyEmailJobID = {integer}
PreviewMyEmail.com job ID

Error Codes

1
Missing email ID
2
Invalid email ID
3
Connection error occurred
4
Your email couldn't be previewed. Please contact administrator. Error code: PME023
5
PreviewMyEmail.com account is out of credits.
99998
Authentication failure or session expired
99999
Not enough privileges

Stay connected!