Building a campaign with XMLDelivery

A campaign is defined by the XML instructions file that you create. Regardless of how your campaign is configured, the XML instructions file must be fully validated against the schema, if it is to be parsed correctly by XMLDelivery. See XML instructions file for more details.

Click the appropriate link below for a description of each main section or element of the XML instructions file:

Note:

The order of the following list is also the order in which the main sections and elements may appear in the XML instructions file. See the relevant topic for more about the children of each section or element. If there is no link for a child, see the parent section or element.

Also see:

Note:

The XML examples shown in the above topics only include the use of the relevant children. See Working examples for more about a complete XML instructions file.

XML instructions file conceptual structure

The following example demonstrates the general conceptual structure of an instructions file. It is for illustration purposes only.

Note:

This example is NOT intended to be an XML file and should not be used in a real-life configuration. The actual structure of your XML instructions file will change according to the options that you choose to use.

    <?xml version="1.0" encoding="utf-8"?>
    <contactlab>
        <auth>
            <suid>...</suid>
            <key>...</key>
        </auth>
        <campaign>
            <generic campaign type, for example, <email><sms> or <push>>
                <newsletter>...</newsletter>
                <recipients>
                    <retry />
                    <new_recipients>
                        <recipient>
                            <field1>field1 content</field1>
                            <field2>field2 content</field2>
                        </recipient>
                        <recipient>
                            ...
                        </recipient>
 
                        <!-- or: --!>
                        <csv_file>file.csv</csv_file>
                    </new_recipients>
                    <test_recipients>
                        <test_recipient>
                            <field1>field1 content</field1>
                            <field2>field2 content</field2>
                        </test_recipient>
                        <test_recipient>
                            ...
                        </test_recipient>
 
                        <!-- or: --!>
                        <csv_file>file.csv</csv_file>
                    </test_recipients>
                </recipients>
 
                <!-- or: --!>
                <recipients>
                    <retry />
                    <filter>
                        <test rendering="true">1</test>
                        <normal>2</normal>
                    </filter>
                </recipients>
 
                <delivery method="manual">
                    <remove_duplicates/>
                </delivery>
 
                <!-- or: --!>
                <delivery method="auto">
                    <remove_duplicates/>
                    <transactional/>
                </delivery>
 
                <!-- or: --!>
                <delivery method="auto">
                        <schedule>2016-06-30T02:03:51</schedule>
                    <remove_duplicates/>
                </delivery>
 
                <!-- Email campaign type only: --!>
                <notes>
                    <note>
                        <label>note_1</label>
                        <value>first note</value>
                    </note>
                    <note>
                        <label>note_2</label>
                        <value>second note</value>
                    </note>
                </notes>
 
                <!-- The contents of the <message> section depend upon
                the generic campaign type. --!>
                <!-- SMS: --!>
                <message>
                    <subject>...</subject>
                    <body><![CDATA[ text ]]></body>
                    <from>...</from>
                </message>
 
                <!-- or Email: --!>
                <message>
                    <encoding>utf-8</encoding>
                    <headers>
                        <subject>...</subject>
                        <mail_from>
                            <name>...</name>
                            <address>...</address>
                        </mail_from>
                        <reply_to>...</reply_to>
                    </headers>
                    <publish_on_web ovveridetaf="true">
                        <taffilename>name</taffilename>
                        <taftemplate>template</taftemplate>
                    </publish_on_web>
                    <preferred_content>both</preferred_content>
                    <body>
                        <html>
                            <content>
                                <embed><![CDATA[body (html <a track="yes"
                                href="http://www.example.com">Description</a>
                                )]]></embed>
                            </content>
                            <preferences>
                                <stats>
                                    <links>parse</links>
                                </stats>
                            </preferences>
                        </html>
                        <text>
                            <content>
                                <uri>http://www.example.com/myuri.htm</uri>
                            </content>
                        </text>
                    </body>
                </message>
 
                <!-- or Push: --!>
                <message>
                    <subject>...</subject>
                    <push_template_envelope><![CDATA[{"pushTemplates":..}]}]]></push_template_envelope>
                </message>
 
            </generic campaign type, for example, </email>, </sms> or </push>>
        </campaign>
    </contactlab>

Next page:

Contactlab section