DREAMmail 4.7.1
Programming
Guide
November 21, 2006 | www.epsiloninteractive.com
Copyright 2006, Epsilon Interactive All Rights Reserved
Copyrights
This documentation and related technology are governed by a user agreement and shall remain the sole and exclusive property of Epsilon
Interactive No part of this documentation or related technology may be used, reproduced, translated, displayed, distributed, disclosed, stored
in a retrieval system or transmitted in any form or by any means without the written permission of Epsilon Interactive, unless otherwise stated
in the user agreement. The information contained in this documentation is confidential and proprietary to Epsilon Interactive
Disclaimer
Epsilon Interactive does not warrant, guarantee or make any representations or otherwise concerning the contents of this documentation or the
applicability thereof. Epsilon Interactive reserves the right to change the contents of this document at any time without prior notification of
such updates.
Trademarks
DREAMmail is a registered service mark of Epsilon Interactive
Epsilon Interactive DREAMmail Last Modified November21, 2006 iii
TABLE OF CONTENTS
Preface to the DREAMmail Programming Guide ..................vi
Introduction to the Programming Guide.................................1
Writing DMConnect Requests..................................................2
Review of XML Document Structure .....................................3
Special Characters and Non-English Text............................4
Language Support and Character Sets ................................7
DMConnect Document Type Definition ..............................11
Recommendations for Writing Requests ...........................19
Implementing DMConnect......................................................21
Overview of the Implementing DMConnect........................22
Using DMConnect With Other Products.............................23
Syntax of DMConnect Requests and Responses ................24
DMConnect Requests, Organized by Type.........................26
Responses Returned by DMConnect Requests.................28
Summary of DMConnect Requests and Responses .........29
Parameters Accepted in DMConnect Report Requests ....32
FromDate and EndDate Parameters....................................33
AddProfileFields Request ....................................................34
ChangeRTMMailingStatus....................................................37
ClearList Request .................................................................38
CreateCampaign Request ....................................................40
CreateContent Request........................................................43
CreateDuplicateMailing Request.........................................46
CreateList Request ...............................................................48
CreateMailing Request .........................................................50
CreateMailingFromTemplate Request ................................57
CreateRTMMailing.................................................................60
ExportReport Request..........................................................61
Programming Guide Table of Contents
Epsilon Interactive DREAMmail Last Modified November21, 2006 iv
GetAllExportNames Request...............................................63
GetExportedReport Request................................................64
GetExportReportStatus Request.........................................66
GetFtpImportStatus Request...............................................68
GetFtpImportStatusRs Response .......................................70
GetHygieneRuleNames Request .........................................72
GetHygieneRuleNamesRs Response..................................73
GetJobStatus Request .........................................................74
GetListNames Request.........................................................76
GetListNamesRs Response.................................................78
GetMailingContent Request.................................................79
GetMailingContentRs Response .........................................80
GetMailingStatus Request ...................................................82
GetMailingStatusRs Response............................................84
GetMessageSize Request ....................................................88
GetMessageSizeRs Response.............................................90
GetObjectNames Request....................................................92
GetObjectNamesRs Response ............................................95
GetProfileFields Request .....................................................98
GetProfileFieldsRs Response............................................100
GetTemplateVariables Request.........................................103
GetTemplatevariablesRs Response..................................105
GetTestMailingStatus Request..........................................106
GetTestMailingStatusRs Response ..................................108
ImportList Request .............................................................111
SendMailingForApproval Request ....................................114
StartMailing Request ..........................................................116
TestMailing Request...........................................................118
TriggerFtpImport Request..................................................120
TriggerMailingToEmailAddresses Request......................125
TriggerMailingToList Request ...........................................130
Unsubscribe Request.........................................................134
UpdateContent Request.....................................................137
UpdateMailing Request ......................................................141
UpdateProfile Request .......................................................149
UpdateRTMMailing..............................................................152
Generating Standard Reports With DMConnect ................153
DeliveryResponse Report Request...................................154
Bouncebacks Report Request...........................................157
Clickthroughs Report Request..........................................160
ListActivity Report Request...............................................163
EmailAddressChanges Report Request...........................167
ProfileChanges Report Request........................................169
Programming Guide Table of Contents
Epsilon Interactive DREAMmail Last Modified November21, 2006 v
RTMDelivered Report Request ..........................................172
RTMNotDelivered Report Request ....................................173
RTMClicks Report Request................................................175
RTMHTMLOpens Report Request .....................................177
RTMSpotlight Report Request...........................................178
Posting DMConnect Requests.............................................180
Request Form Parameters .................................................181
Sending Requests through HTTP Posts...........................186
Responses to DMConnect Requests ..................................197
Notification Response Message........................................198
DMConnect Messages and Response Codes ..................199
GetJobStatus and GetExportReportStatus Responses..216
Using Spotlight......................................................................218
About Spotlight...................................................................219
Description of Spotlight Tags............................................223
Creating Spotlight Tags .....................................................226
Generating Random Numbers in Spotlight Tags.............236
Using the Automated Content Submission Tool ...............238
The Automated Content Submission Process.................239
Automated Content Submission Requests......................241
Automated Content Submission Document Type
Declaration.......................................................................242
CreateMailing Request .......................................................244
CreateOrUpdateContent Request......................................251
Posting and Retrieving Files..............................................256
Appendix - ASCII Escape Codes .........................................258
Index.......................................................................................261
