If we were to inspect the emailTest object again at this stage, we'd see that the Litmus Web Service has set values for any properties related to the email you sent in to it.
For the rest of this guide, we'll pretend the email sent in was a marketing email from Litmus. An example of this email can be found here: http://litmusapp.com/resources/email-sample.html
Subject
Type: string
Capacity: 255 characters (do not truncate yourself, Litmus will handle this for you)
Value: "Litmus: Email and IM notifications, new email clients, and more - Preview"
This will now hold your subject as a string.
Html
Type: string
Capacity: 255 characters
Value: "" / string.Empty / null / nil / nothing
Reserved. Please ignore.
ID
Type: string (treat as an integer, this is to be corrected in future versions of our WSDL)
Capacity: 10 characters (theoretical maximum value is "2,147,483,647", it is safe to store this value as a 32-bit integer if you wish to)
Value: 226238
This is the most important property, it's the unique identifer for your test. You've already used this once to poll for an update after sending your email and will need to use it again shortly.
Source
Type: string
Capacity: 255 characters
Value: "s3.amazonaws.com/sitevista/7148b5de-fd57-472c-af11-d8eead9a1170"
This property now contains a link to your email's source. To make the link valid, you need to prepend a protocl to the uri. Litmus doesn't add the protocol for you because you may be linking to this (or embedding it in an iframe) in a page over SSL and this would lead to mixed content warnings in Internet Explorer. Here is the link above after adding "https://" to it:
https://s3.amazonaws.com/sitevista/7148b5de-fd57-472c-af11-d8eead9a1170
Give that a link to try to see what you should expect. It is entirely up to you to decide if you wish to use the raw source or not. Litmus displays this link to its users on the test overview page, as shown below:
If you don't intend to link to the raw source of your customer's emails, you can ignore this property.
ZipFile
Type: string
Capacity: 255 characters
Value: "http://zip.litmusapp.com/zip/results/?dba59b4cd5b0a9bb1ccce0613e53c7eb3c8e0ced"
The ZipFile link allows you to offer a link to your users to download a zip file of all of their result images. This saves you from having to download all of the images from our image hosts and zip them yourself. At this stage the link will return nothing because the start has only just started.
Note Due to a mistake, ZipFile contains a protocol (http), this is a mistake that is to be fixed in future versions of the Web Service. If you require an SSL url, please replace "http://" with "https://". We apologise for this error.
Note You must NOT use this link to retreive the images from Litmus and then deliver them to your users.You should instead use the Results collection to iterate through each of the results as shown later in this guide. The zip file download is only for delivering a zip file of results directly to a user, as a zip file.
TestType
Type: string
Capacity: 10 characters
Value: "Email"
This will be "Email", since you've created an email test. At time of writing, the only other possible value is "Page", for web page tests.
Sandbox
Type: boolean
Capacity: 1
Value: false / null / nil / nothing
This property isn't used once you've ordered your test, please ignore it in returned responses (you may find it's null).
UserGuid
Type: string
Capacity: 255 characters
Value: "" / string.Empty / null / nil / nothing
This property isn't used once you've ordered your test, please ignore it in returned responses (you may find it's null).
State
Type: string
Capacity: 20 characters
Value: "processing"
Now that Litmus has received your email, the State will now be "processing" and when all results have completed, it'll change to "complete".
InboxGUID
Type: string
Capacity: 10 characters
Value: "f597a73"
The InboxGuid was used to construct the email address to send your test email to.
Results
Type: Client[] / array
Capacity: Not applicable
Value: Client[2] / array(2) / {Client, Client} / [Client, Client]
A collection of results stored in Client objects (remember those from earlier? We used them to order a new test, specifiying which clients to test on). Working with the Results collection is covered next.
