View
 

SOAP Web Service -  Using your returned test

If we were to inspect the emailTest object now, we'd see it's been filled by the Litmus Web Service with all kinds of information (we're going to ignore the Results collection for now and cover that in much greater detail later):

 

Subject

This will soon be the subject of your email, right now, it's empty because we haven't sent an email yet.

 

Html

Reserved. Please ignore.

 

ID

This is the most important property, it's the unique identifer for your test. You'll use this later to poll for updates for your test.

 

Source

Once you've sent an email, this will contain your email's raw source code. At this stage, it's empty.

 

ZipFile

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.

 

TestType

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

This property isn't used once you've ordered your test, please ignore it in returned responses (you may find it's null).

 

UserGuid

This property isn't used once you've ordered your test, please ignore it in returned responses (you may find it's null).

 

State

This will have a value of "waiting" at the moment. This means Litmus is waiting for your email to arrive. Once Litmus receives it, it'll change the State to "processing" and when all results have completed, it'll change to "complete".

 

InboxGUID

The InboxGuid will be used to construct the email address to send your test email to. To form your email address, simply append "@emailtests.com" to the InboxGUID value.