dotmailer SDK: dotMailer.Sdk.DmService Class Reference

dotmailer SDK

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

dotMailer Management Service . More...

Inheritance diagram for dotMailer.Sdk.DmService:

Public Member Functions

DateTime GetServerUtcTime ()
 Gets the server time in UTC format
 
DmAccountInfo GetAccountInfo ()
 Gets a list of properties for the current dotMailer account
 
bool SendSingleSmsMessage (string mobileNumber, string message)
 Sends a SMS message to the specified number with the specified message
 
DmCustomFromAddressCollection GetCustomFromAddressList ()
 Returns a collection of available custom from addresses
 
DateTime MinDotMailerDate ()
 Returns the minimum time on the dotMailer server
 
bool IsMinDotMailerDate (DateTime value)
 Checks specified date is the minimum date on the server
 
DateTime ConvertToServerApiTime (DateTime value)
 Coverts a local time to server time
 
void Dispose ()
 Dispose webservice client
 

Properties

int CurrentApiUsageCount [get]
 Gets the api count used, from the service provider
 
int ApiCountUsageSinceCreation [get]
 get the number of api calls used at creation of the library
 
DmLocale AccountLocale [get]
 Gets the account locale
 
ServiceCalls ServiceCalls [get]
 returns the list of service calls made
 
AddressBookFactory AddressBookFactory [get]
 Gets the address book factory - creates it if needed
 
ContactFactory ContactFactory [get]
 Gets the contact factory - creates it if needed
 
CampaignFactory CampaignFactory [get]
 Gets the campaign factory - creates it if needed
 
SerialisationFactory SerialisationFactory [get]
 Gets the Serialisation Factory - creates it if needed
 
DocumentFactory DocumentFactory [get]
 Gets the Document Factory - creates it if needed
 
TemplateFactory TemplateFactory [get]
 Gets the Template Factory - creates it if needed
 
ImageFactory ImageFactory [get]
 Gets the Image Factory - creates it if needed
 
AddressBookFactory AddressBooks [get]
 Gets the address book factory - creates it if needed
 
ContactFactory Contacts [get]
 Gets the contact factory - creates it if needed
 
CampaignFactory Campaigns [get]
 Gets the campaign factory - creates it if needed
 
SerialisationFactory Serialisation [get]
 Gets the Serialisation Factory - creates it if needed
 
DocumentFactory Documents [get]
 Gets the Document Factory - creates it if needed
 
TemplateFactory Templates [get]
 Gets the Template Factory - creates it if needed
 
ImageFactory Images [get]
 Gets the Image Factory - creates it if needed
 

Detailed Description

dotMailer Management Service .

Provides access to contacts, campaigns and address books. Provides ability to import contacts to address books, and send campaigns to contacts and address books.

Member Function Documentation

DateTime dotMailer.Sdk.DmService.ConvertToServerApiTime ( DateTime  value)

Coverts a local time to server time

Parameters
valueDateTime to convert
Returns
DateTime of the input time as on the server
void dotMailer.Sdk.DmService.Dispose ( )

Dispose webservice client

DmAccountInfo dotMailer.Sdk.DmService.GetAccountInfo ( )

Gets a list of properties for the current dotMailer account

Returns
DmAccountInfo
DmCustomFromAddressCollection dotMailer.Sdk.DmService.GetCustomFromAddressList ( )

Returns a collection of available custom from addresses

Returns
DateTime dotMailer.Sdk.DmService.GetServerUtcTime ( )

Gets the server time in UTC format

Returns
DateTime value

See http://en.wikipedia.org/wiki/UTC

bool dotMailer.Sdk.DmService.IsMinDotMailerDate ( DateTime  value)

Checks specified date is the minimum date on the server

Parameters
valueDateTime value to check
Returns
true if date is minimum value
DateTime dotMailer.Sdk.DmService.MinDotMailerDate ( )

Returns the minimum time on the dotMailer server

Returns
bool dotMailer.Sdk.DmService.SendSingleSmsMessage ( string  mobileNumber,
string  message 
)

Sends a SMS message to the specified number with the specified message

Parameters
mobileNumber
message
Returns

Property Documentation

DmLocale dotMailer.Sdk.DmService.AccountLocale
get

Gets the account locale

AddressBookFactory dotMailer.Sdk.DmService.AddressBookFactory
get

Gets the address book factory - creates it if needed

AddressBookFactory dotMailer.Sdk.DmService.AddressBooks
get

Gets the address book factory - creates it if needed

int dotMailer.Sdk.DmService.ApiCountUsageSinceCreation
get

get the number of api calls used at creation of the library

CampaignFactory dotMailer.Sdk.DmService.CampaignFactory
get

Gets the campaign factory - creates it if needed

CampaignFactory dotMailer.Sdk.DmService.Campaigns
get

Gets the campaign factory - creates it if needed

ContactFactory dotMailer.Sdk.DmService.ContactFactory
get

Gets the contact factory - creates it if needed

ContactFactory dotMailer.Sdk.DmService.Contacts
get

Gets the contact factory - creates it if needed

int dotMailer.Sdk.DmService.CurrentApiUsageCount
get

Gets the api count used, from the service provider

DocumentFactory dotMailer.Sdk.DmService.DocumentFactory
get

Gets the Document Factory - creates it if needed

DocumentFactory dotMailer.Sdk.DmService.Documents
get

Gets the Document Factory - creates it if needed

ImageFactory dotMailer.Sdk.DmService.ImageFactory
get

Gets the Image Factory - creates it if needed

ImageFactory dotMailer.Sdk.DmService.Images
get

Gets the Image Factory - creates it if needed

SerialisationFactory dotMailer.Sdk.DmService.Serialisation
get

Gets the Serialisation Factory - creates it if needed

SerialisationFactory dotMailer.Sdk.DmService.SerialisationFactory
get

Gets the Serialisation Factory - creates it if needed

ServiceCalls dotMailer.Sdk.DmService.ServiceCalls
get

returns the list of service calls made

TemplateFactory dotMailer.Sdk.DmService.TemplateFactory
get

Gets the Template Factory - creates it if needed

TemplateFactory dotMailer.Sdk.DmService.Templates
get

Gets the Template Factory - creates it if needed

Generated by   doxygen 1.8.3