dotmailer SDK: dotMailer.Sdk.Contacts.Importing.ImportContactOptions Class Reference

dotmailer SDK

dotmailer SDK
Tools to access and manage an account in the dotMailer system
dotMailer.Sdk.Contacts.Importing.ImportContactOptions Class Reference

Class the defines the options that can are used when adding contacts to an address book More...

Public Member Functions

 ImportContactOptions ()
 Default Constructor
 

Public Attributes

int MaxUploadRetryAttempts
 The maximum number of times to retry the upload
 

Properties

string SaveCsvPath [get, set]
 The path to save csv chunks to (for debugging)
 
bool SaveCsv [get, set]
 If true, the csv chucks are save to the 'SaveCsvPath'
 
int ConcurrentUploads [get, set]
 The maximum number of uploads to occur at any one time
 
int MaxContactsPerUpload [get, set]
 The maximum number of contacts per upload
 
bool UseBatches [get, set]
 If false - the contacts are added one at a time, for triggering purposes
 
int SingleContactAddLimit [get, set]
 if the 'UseBatches' is false, this is the max number of contacts that can be added in a single upload. This is to preserve the DM api limit
 
bool DontUpload [get, set]
 If set to true, then the import will not upload the contacts to the server - to be used in conjunction with the save csv options
 
SingleAddMode SingleAddMode [get, set]
 How to deal with contact data when adding contacts using single adds
 
TimeSpan ImportTimeout [get, set]
 Time out timespan for the whole import process
 
bool SortContacts [get, set]
 If set to true, the contacts are sorted into group of populated datafields.
 
bool UseV2 [get, set]
 Use the V2 API to import that contacts
 

Detailed Description

Class the defines the options that can are used when adding contacts to an address book

Constructor & Destructor Documentation

dotMailer.Sdk.Contacts.Importing.ImportContactOptions.ImportContactOptions ( )

Default Constructor

Member Data Documentation

int dotMailer.Sdk.Contacts.Importing.ImportContactOptions.MaxUploadRetryAttempts

The maximum number of times to retry the upload

Property Documentation

int dotMailer.Sdk.Contacts.Importing.ImportContactOptions.ConcurrentUploads
getset

The maximum number of uploads to occur at any one time

bool dotMailer.Sdk.Contacts.Importing.ImportContactOptions.DontUpload
getset

If set to true, then the import will not upload the contacts to the server - to be used in conjunction with the save csv options

Not supported in SingleAddMode

TimeSpan dotMailer.Sdk.Contacts.Importing.ImportContactOptions.ImportTimeout
getset

Time out timespan for the whole import process

int dotMailer.Sdk.Contacts.Importing.ImportContactOptions.MaxContactsPerUpload
getset

The maximum number of contacts per upload

bool dotMailer.Sdk.Contacts.Importing.ImportContactOptions.SaveCsv
getset

If true, the csv chucks are save to the 'SaveCsvPath'

string dotMailer.Sdk.Contacts.Importing.ImportContactOptions.SaveCsvPath
getset

The path to save csv chunks to (for debugging)

SingleAddMode dotMailer.Sdk.Contacts.Importing.ImportContactOptions.SingleAddMode
getset

How to deal with contact data when adding contacts using single adds

int dotMailer.Sdk.Contacts.Importing.ImportContactOptions.SingleContactAddLimit
getset

if the 'UseBatches' is false, this is the max number of contacts that can be added in a single upload. This is to preserve the DM api limit

bool dotMailer.Sdk.Contacts.Importing.ImportContactOptions.SortContacts
getset

If set to true, the contacts are sorted into group of populated datafields.

This prevents the import process overwriting populated datafields in the DM account, with blank data

bool dotMailer.Sdk.Contacts.Importing.ImportContactOptions.UseBatches
getset

If false - the contacts are added one at a time, for triggering purposes

bool dotMailer.Sdk.Contacts.Importing.ImportContactOptions.UseV2
getset

Use the V2 API to import that contacts

Generated by   doxygen 1.8.3