Note: As of 2015 the SOAP API is a deprecated API we recommend using the Reseller REST API which can be found here: https://litmus.com/partners/api/documentation

Web page testing via the SOAP API is straightforward, but the process for email tests is a little different. We’ve outlined a typical process below.
 
  1. Create an empty EmailTest object, this allows you to set EmailTest#Sandbox to true or add testing applications if you wish to.
  2. Optional  If you are creating a test for a user with an ‘unlimited’ subscription plan, before invoking the CreateEmailTest method, prepare your EmailTest struct instance and assign its "UserGuid" property the user's GUID. For more on user GUIDs, see Generating user GUIDs.
  3. Call the Web Service's CreateEmailTest method, passing in your api key and pass phrase, and your new EmailTest object.
  4. CreateEmailTest returns your EmailTest object with some additional information filled in. 
  5. The most important property is "InboxGUID" - this is the unique inbox you'll be sending your test email to. You can construct the email address to send to by concatenating InboxGuid and the literal "@emailtests.com". So, for example, if InboxGUID was set to "J72S28H", your email address to send to would be J72S28H@emailtests.com.
  6. If you're running a spam test, fetch the spam seed addresses using the GetSpamSeedAddresses method and send an email to each of them.
  7. After sending the email, periodically call GetEmailTest, passing your EmailTest object's ID property as the third parameter, after your key and pass phrase.
  8. With each call to GetEmailTest, check your EmailTest object's "State" property, once it equals "processing" (and not "waiting"), your email has been received and is being processed.
  9. To view the available results of your test so far, simply check your EmailTest object's "Results" property. It contains an array of Client objects.
  10. Each client has a "Completed" property that, when true, indicates that the test has finished processing and is ready to be shown to the user.
  11. In addition to the "Completed" property, you'll also find a "ResultType" property. For email tests, this is either "email" or "spam". 
  12. For a Client with ResultType "email", you'll find URLs for each applicable result image within the various "Image..." and "ImageThumb..." properties.
  13. For a Client with ResultType "spam", the "FoundInSpam", "SpamScore" and "SpamHeaders" properties contain everything you need to display the results of passing your email through that particular spam filter. For more on this, see Interpreting and displaying the spam header data.