Child pages
  • Batch FTPZIP - Massive - Settings.xml
Skip to end of metadata
Go to start of metadata

Overview

Settings.xml is the only mandatory content of the ZIP Archive.

The XML structure is divided in three main nodes:

  • Header: General data regarding FTPZIP operations
  • Content: Data about the Mailing that will be executed and the Newsletter that will be created.
  • AdvancedSettings: Data about message creation, Kind of Mailing, CSV File features.

 Follow an example of all nodes includes in settings XML

Settings.xml all nodes
<?xml version="1.0" encoding="UTF-8"?>
<FtpZip>
    <Header>
        <ActionType>full</ActionType>  
		<CampaignCode>Campaign0009</CampaignCode>   
		<FormatVersion>0.1</FormatVersion>
		<NotifyEmail>peter@example.com</NotifyEmail>
    </Header>
    <Content>
        <ListId>1</ListId>
		<ListGUID>08c6348c-1e6b-4ae7-b44c-156fc4a7f012</ListGUID>
        <SenderName>John Doe</SenderName>
        <SenderEmail>john@doe.com</SenderEmail>
        <ReplyToEmail>jane@doe.com</ReplyToEmail>
		<EmailSubject>Campaign0009</EmailSubject>
		<ScheduleDateTime>2014-11-04T11:20:00.000</ScheduleDateTime>
        <Notes>Notes for campaign 00009</Notes>
    </Content>
    <AdvancedSettings>
        <Separator>;</Separator>   
		<Attachments>false</Attachments> 
		<DynamicFields>true</DynamicFields>
		<EmbeddedImages>false</EmbeddedImages>
		<LinkTracking>true</LinkTracking>
		<HttpLinkTracking>true</HttpLinkTracking>
		<HttpsLinkTracking>true</HttpsLinkTracking>    
		<MailToTracking>false</MailToTracking>
		<FtpTracking>true</FtpTracking>
		<NewsTracking>true</NewsTracking>
		<QueryStringAdditionalParams></QueryStringAdditionalParams>
        <ContentOverride>
            <MessageId>1136</MessageId>
            <CloneMessage>true</CloneMessage>
        </ContentOverride>       
    </AdvancedSettings>
</FtpZip>

Input fields detail

Following meanings of each node of settings.xml divided by main node. 

Node <Header> 

Name

Type

Requires value?

Sample values

Meaning

Notes

ActionType

string

Y

One between "save", "full" or "send"

The kind of action FTPZIP will take with regard to the submitted ZIP archive.  When set to save, FTPZIP will only create an email message without importing any recipient or scheduling any mailings.

ActionType is a very important field as its value drives a big shift in the executed tasks.

CampaignCode

string

Y

Any

This is a unique identifier for the campaign. FTPZIP will read this value at each session to prevent users from uploading the same campaign twice by mistake.

 

FormatVersion

string

Y

< 0.1 | 0.2 >

This value indicates the kind of xml validation FTPZIP wil run. Current implemented format is 0.1, and it will run xml validation againts its xsd schema definition file.

 

NotifyEmailStringNpeter@example.comAn email report containing the process result (success/failure) is sent to the specified address.Recommended, it is the only way to receive an automated notification in case of errors

 

Node <Content> 

Name

Type

Requires value?

Sample values

Meaning

Notes

ListId

int

Y

< 1 | 2 | 3 >

The numeric identifier for the List in the MailUp account in which the various tasks will be executed (creation of the message, import of recipients, etc.). This is unique within a MailUp account, but not across MailUp accounts.

To locate your lists id’s please see: http://help.mailup.com/display/mailupapi/Codes+Table+and+List+GUID

ListGUID

String

Y

b947d468-2751-40a7-83bf-1ecca0bbd6a1

The unique identifier for each List across all MailUp accounts. ListID and ListGUID must refer to the same List.

To locate your lists Guid’s, please see: http://help.mailup.com/display/mailupapi/Codes+Table+and+List+GUID

SenderName

String

N

 

The display name for the sender in the campaign being created/sent

If empty, the default value for the List will be used.

SenderEmail

String

N

 

The email address that the campaign will be sent from

If empty, the default value for the List will be used.

Mind that this is not an arbitrary field, the sender Email has to be approved withing your admin account to prevent any kind spam like activities.

ReplyToEmailStringNexample@email.comThe email address used when the subscriber reply to the received campaign.If empty, the default value for the List will be used.
EmailSubject

String

N

 

The email message subject

 

Notes

String

N

This is a note

The email message note

 

ScheduleDateTime

String

N

 

The date/time at which the campaign will be sent.
If time is too close to current time, or already in past, or left empty, campaign will be sent out immediately.

The date/time have to be written using the ISO 8601 format.
The time zone mailing will occur for must to be specified in the ScheduleDateTime value as foreseen for the ISO 8601 format.

(see https://www.w3.org/TR/NOTE-datetime)

If you upload many ZIP files with the same scheduled date and time, mailing will run in parallel.

If you upload many ZIP files without a scheduled date, mailing will run sequentially, according to the file detection order.

If the scheduled date and time is earlier than the actual processing time, the scheduled date&time will be ignored and mailing will be sequential.

if time zone isn't specified it will be used western European standard time zone as default. ( GMT+ 1 )

 

Node <AdvancedSettings> 

Name

Type

Requires value?

Sample values

Meaning

Notes

Separator

String

Y if ActionType set to Full, N if set to Newslettter

;

The column delimiter used in the Recipients.csv file.

 

Attachments

Bool (string)

Y

< true  | false >

Attach files to current mailer campaign

If set to true FTPZIP will expect the folder attachments to be included in the submitted ZIP archive

DynamicFields

Bool (string)

Y

< true  | false >

Toggles dynamic fields

 

EmbeddedImages

Bool (string)

Y

< true  | false >

Toggles use of embedded images

 

LinkTracking

Bool (string)

Y

< true  | false >

Toggles link tracking

 

HttpLinkTracking

Bool (string)

Y

< true  | false >

Toggles plain http link tracking

 

HttpsLinkTracking

Bool (string)

Y

< true  | false >

Toggles https link tracking

 

MailToTracking

Bool (string)

Y

< true  | false >

Toggles Mailto tracking

 

FtpTracking

Bool (string)

Y

< true  | false >

Toggles FTP tracking

 

NewsTracking

Bool (string)

Y

< true  | false >

Toggles News Tracking

 

QueryStringAdditionalParams

String

N

utm_medium=email&utm_campaign=Nov14+offers

Appends a querystring to all included links

Suitable for third party campaign tracking systems such as Google Analytics

PreHeaderStringNThis is a preheaderString that will be added to the email message head as preheader. 
ContentOverride/MessageIdIntN25MessageId is the newsletterID to be used for the outgoing campaigns; it will be taken into consideration only for ActionType "send"Suitable when you send the same message repeatedly and don't need to create each time a fresh new one.
ContentOverride/CloneMessageBool
(string)
N< true  | false >

Create a copy of the newsletter described in MessageID Fields.
The copy will be sent.

Suitable when you send the same message repeatedly but wan't see separated statistics in the MailUp Web Application..
  • No labels