Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

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>
		<ScheduleTimeZone>6</ScheduleTimeZone>
        <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.

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

 

Transactional Mailing can't be scheduled, so this configuration will be ignored if SendType is transactional.

ScheduleTimeZone

StringN6The time zone schedulation will occur for.
Please see the time zone reference at the bottom of this section.

if unspecified it will be used western european standard time zone as default. ( GMT+ 1 ). 38 will be used as default when this values has not been specified.

It also takes into consideration Daylight saving time for each area.

 

Transactional Mailing can't be scheduled, so this configuration will be ignored if SendType is transactional.

 

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..

 

Time Zones 

 Click here to see supported time zones
Id ( the value to type in to settings.xml )Standard NameUTC Offset
1Dateline Standard Time(UTC-12:00) International Date Line West
2UTC-11(UTC-11:00) Coordinated Universal Time-11
3Hawaiian Standard Time(UTC-10:00) Hawaii
4Alaskan Standard Time(UTC-09:00) Alaska
5Pacific Standard Time (Mexico)(UTC-08:00) Baja California
6Pacific Standard Time(UTC-08:00) Pacific Time (US & Canada)
7US Mountain Standard Time(UTC-07:00) Arizona
8Mountain Standard Time (Mexico)(UTC-07:00) Chihuahua, La Paz, Mazatlan
9Mountain Standard Time(UTC-07:00) Mountain Time (US & Canada)
10Central America Standard Time(UTC-06:00) Central America
11Central Standard Time(UTC-06:00) Central Time (US & Canada)
12Central Standard Time (Mexico)(UTC-06:00) Guadalajara, Mexico City, Monterrey
13Canada Central Standard Time(UTC-06:00) Saskatchewan
14SA Pacific Standard Time(UTC-05:00) Bogota, Lima, Quito, Rio Branco
15Eastern Standard Time(UTC-05:00) Eastern Time (US & Canada)
16US Eastern Standard Time(UTC-05:00) Indiana (East)
17Venezuela Standard Time(UTC-04:30) Caracas
18Paraguay Standard Time(UTC-04:00) Asuncion
19Atlantic Standard Time(UTC-04:00) Atlantic Time (Canada)
20Central Brazilian Standard Time(UTC-04:00) Cuiaba
21SA Western Standard Time(UTC-04:00) Georgetown, La Paz, Manaus, San Juan
22Pacific SA Standard Time(UTC-04:00) Santiago
23Newfoundland Standard Time(UTC-03:30) Newfoundland
24E. South America Standard Time(UTC-03:00) Brasilia
25Argentina Standard Time(UTC-03:00) Buenos Aires
26SA Eastern Standard Time(UTC-03:00) Cayenne, Fortaleza
27Greenland Standard Time(UTC-03:00) Greenland
28Montevideo Standard Time(UTC-03:00) Montevideo
29Bahia Standard Time(UTC-03:00) Salvador
30UTC-02(UTC-02:00) Coordinated Universal Time-02
31Mid-Atlantic Standard Time(UTC-02:00) Mid-Atlantic - Old
32Azores Standard Time(UTC-01:00) Azores
33Cape Verde Standard Time(UTC-01:00) Cape Verde Is.
34Morocco Standard Time(UTC) Casablanca
35UTCUTC
36GMT Standard Time(UTC) Dublin, Edinburgh, Lisbon, London
37Greenwich Standard Time(UTC) Monrovia, Reykjavik
38W. Europe Standard Time(UTC+01:00) Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna
39Central Europe Standard Time(UTC+01:00) Belgrade, Bratislava, Budapest, Ljubljana, Prague
40Romance Standard Time(UTC+01:00) Brussels, Copenhagen, Madrid, Paris
41Central European Standard Time(UTC+01:00) Sarajevo, Skopje, Warsaw, Zagreb
42W. Central Africa Standard Time(UTC+01:00) West Central Africa
43Namibia Standard Time(UTC+01:00) Windhoek
44Jordan Standard Time(UTC+02:00) Amman
45GTB Standard Time(UTC+02:00) Athens, Bucharest
46Middle East Standard Time(UTC+02:00) Beirut
47Egypt Standard Time(UTC+02:00) Cairo
48Syria Standard Time(UTC+02:00) Damascus
49E. Europe Standard Time(UTC+02:00) E. Europe
50South Africa Standard Time(UTC+02:00) Harare, Pretoria
51FLE Standard Time(UTC+02:00) Helsinki, Kyiv, Riga, Sofia, Tallinn, Vilnius
52Turkey Standard Time(UTC+02:00) Istanbul
53Jerusalem Standard Time(UTC+02:00) Jerusalem
54Libya Standard Time(UTC+02:00) Tripoli
55Arabic Standard Time(UTC+03:00) Baghdad
56Kaliningrad Standard Time(UTC+03:00) Kaliningrad, Minsk
57Arab Standard Time(UTC+03:00) Kuwait, Riyadh
58E. Africa Standard Time(UTC+03:00) Nairobi
59Iran Standard Time(UTC+03:30) Tehran
60Arabian Standard Time(UTC+04:00) Abu Dhabi, Muscat
61Azerbaijan Standard Time(UTC+04:00) Baku
62Russian Standard Time(UTC+04:00) Moscow, St. Petersburg, Volgograd
63Mauritius Standard Time(UTC+04:00) Port Louis
64Georgian Standard Time(UTC+04:00) Tbilisi
65Caucasus Standard Time(UTC+04:00) Yerevan
66Afghanistan Standard Time(UTC+04:30) Kabul
67West Asia Standard Time(UTC+05:00) Ashgabat, Tashkent
68Pakistan Standard Time(UTC+05:00) Islamabad, Karachi
69India Standard Time(UTC+05:30) Chennai, Kolkata, Mumbai, New Delhi
70Sri Lanka Standard Time(UTC+05:30) Sri Jayawardenepura
71Nepal Standard Time(UTC+05:45) Kathmandu
72Central Asia Standard Time(UTC+06:00) Astana
73Bangladesh Standard Time(UTC+06:00) Dhaka
74Ekaterinburg Standard Time(UTC+06:00) Ekaterinburg
75Myanmar Standard Time(UTC+06:30) Yangon (Rangoon)
76SE Asia Standard Time(UTC+07:00) Bangkok, Hanoi, Jakarta
77N. Central Asia Standard Time(UTC+07:00) Novosibirsk
78China Standard Time(UTC+08:00) Beijing, Chongqing, Hong Kong, Urumqi
79North Asia Standard Time(UTC+08:00) Krasnoyarsk
80Malay Peninsula Standard Time(UTC+08:00) Kuala Lumpur, Singapore
81W. Australia Standard Time(UTC+08:00) Perth
82Taipei Standard Time(UTC+08:00) Taipei
83Ulaanbaatar Standard Time(UTC+08:00) Ulaanbaatar
84North Asia East Standard Time(UTC+09:00) Irkutsk
85Tokyo Standard Time(UTC+09:00) Osaka, Sapporo, Tokyo
86Korea Standard Time(UTC+09:00) Seoul
87Cen. Australia Standard Time(UTC+09:30) Adelaide
88AUS Central Standard Time(UTC+09:30) Darwin
89E. Australia Standard Time(UTC+10:00) Brisbane
90AUS Eastern Standard Time(UTC+10:00) Canberra, Melbourne, Sydney
91West Pacific Standard Time(UTC+10:00) Guam, Port Moresby
92Tasmania Standard Time(UTC+10:00) Hobart
93Yakutsk Standard Time(UTC+10:00) Yakutsk
94Central Pacific Standard Time(UTC+11:00) Solomon Is., New Caledonia
95Vladivostok Standard Time(UTC+11:00) Vladivostok
96New Zealand Standard Time(UTC+12:00) Auckland, Wellington
97UTC+12(UTC+12:00) Coordinated Universal Time+12
98Fiji Standard Time(UTC+12:00) Fiji
99Magadan Standard Time(UTC+12:00) Magadan
100Kamchatka Standard Time(UTC+12:00) Petropavlovsk-Kamchatsky - Old
101Tonga Standard Time(UTC+13:00) Nuku'alofa
102Samoa Standard Time(UTC+13:00) Samoa
103Line Islands Standard Time(UTC+14:00) Kiritimati Island
  • No labels