dotMailer.Sdk.Campaigns.DmCampaign Class Reference

Represents a dotMailer campaign More...

Inheritance diagram for dotMailer.Sdk.Campaigns.DmCampaign:

Public Member Functions
void	DetachDocument (int documentId)
	Removes the specified attachment from the campaign.
void	DetachDocument (IDmDocument document)
	Removes the specified attachment from the campaign.
void	AttachDocument (int documentId)
	Attaches the specified document to the campaign.
void	AttachDocument (IDmDocument document)
	Attaches the specified document to the campaign. The document must have been uploaded prior to attachment.
bool	UpdateCampaignContent (string html, string plaintext)
	Updates and saves the campaign content
bool	IsValid ()
	Checks to make sure that a campaign is valid
override bool	Equals (object obj)
	Checks to is if the specified object is the same campaign
override int	GetHashCode ()
	Returns object has code
DmCampaign	Copy ()
	Duplicates an existing campaign in your dotMailer account including the campaign's dynamic content.

Properties
int	Id [get, set]
	The system Id of the campaign
int	AccountId [get, set]
	Returns the dotMailer account Id for this address book
string	Name [get, set]
	The name of the campaign.
string	FromName [get, set]
	The name the email will be set to be from.
CampaignReplyActions	ReplyAction [get, set]
	See CampaignReplyActions
string	ReplyToEmailAddress [get, set]
	The email address replies should be forwarded to.
string	Subject [get, set]
	The subject line of the email.
CampaignStatus	Status [get, set]
	See CampaignStatus
string	UserTag1 [get, set]
	User Tag
string	UserTag2 [get, set]
	User Tag
string	UserTag3 [get, set]
	User Tag
string	HtmlContent [get, set]
	Gets/Sets the html content - Lazy Loaded
string	PlainContent [get, set]
	Gets/Sets the plain text content - Lazy Loaded
DmCampaignSummary	Summary [get, set]
	Returns a DmCampaignSummary. Lazy Loaded - will call web service on first use
DmCampaignOpenerCollection	ContactOpeners [get, set]
	Returns a collection of DmCampaignOpenerCollection. Lazy Loaded - will call web service on first use
DmCampaignContactStatsCollection	ContactStats [get, set]
	Returns a collection of DmCampaignContactStats. Lazy Loaded - will call web service on first use
bool	IsSplitTest [get, set]
	Is this campaign a split-test campaign
bool	IsDirty [get]
	Returns true if the object has changed
string	ObjectType [get, set]
	Returns the type name of the class Used by the serialisation process
string	ExternalId [get]
	Gets/Sets the generated Id that uniquely identifies this record
Properties inherited from dotMailer.Sdk.Interfaces.IDmCampaign
int	Id [get]
	The Id of the campaign
string	Name [get]
	the name of the campaign
string	FromName [get]
	The name of the person sending the campaign
CampaignReplyActions	ReplyAction [get]
	The reply action
string	ReplyToEmailAddress [get]
	The reply to email address
string	Subject [get]
	The email subject of the campaign
CampaignStatus	Status [get]
	The status of the campaign
string	HtmlContent [get]
	The html content of the campaign
string	PlainContent [get]
	The plain text content of the campaign
Properties inherited from dotMailer.Sdk.Interfaces.IDmObject
int	AccountId [get]
	The DotMailer account Id for this object
string	ExternalId [get]
	A key that represents this object, used for synching with external applications
bool	IsDirty [get]
	has the data of the object changed

Detailed Description

Represents a dotMailer campaign

Member Function Documentation

void dotMailer.Sdk.Campaigns.DmCampaign.AttachDocument

(

int

documentId

)

Attaches the specified document to the campaign.

Parameters

documentId

The ID of the document to attach.

void dotMailer.Sdk.Campaigns.DmCampaign.AttachDocument

(

IDmDocument

document

)

Attaches the specified document to the campaign. The document must have been uploaded prior to attachment.

Parameters

document

The document to attach.

DmCampaign dotMailer.Sdk.Campaigns.DmCampaign.Copy

(

)

Duplicates an existing campaign in your dotMailer account including the campaign's dynamic content.

Returns

void dotMailer.Sdk.Campaigns.DmCampaign.DetachDocument

(

int

documentId

)

Removes the specified attachment from the campaign.

Parameters

documentId

The ID of the document to detach.

void dotMailer.Sdk.Campaigns.DmCampaign.DetachDocument

(

IDmDocument

document

)

Removes the specified attachment from the campaign.

Parameters

document

The document to detach.

override bool dotMailer.Sdk.Campaigns.DmCampaign.Equals

(

object

obj

)

Checks to is if the specified object is the same campaign

Parameters

obj	Potential DmCampaign object

Returns

true if objects are equal

override int dotMailer.Sdk.Campaigns.DmCampaign.GetHashCode

(

)

Returns object has code

bool dotMailer.Sdk.Campaigns.DmCampaign.IsValid

(

)

Checks to make sure that a campaign is valid

Returns

bool dotMailer.Sdk.Campaigns.DmCampaign.UpdateCampaignContent	(	string	html,
		string	plaintext
	)

Updates and saves the campaign content

Parameters

html
plaintext

Returns

Property Documentation

int dotMailer.Sdk.Campaigns.DmCampaign.AccountId

getset

Returns the dotMailer account Id for this address book

DmCampaignOpenerCollection dotMailer.Sdk.Campaigns.DmCampaign.ContactOpeners

getset

Returns a collection of DmCampaignOpenerCollection. Lazy Loaded - will call web service on first use

DmCampaignContactStatsCollection dotMailer.Sdk.Campaigns.DmCampaign.ContactStats

getset

Returns a collection of DmCampaignContactStats. Lazy Loaded - will call web service on first use

string dotMailer.Sdk.Campaigns.DmCampaign.ExternalId

get

Gets/Sets the generated Id that uniquely identifies this record

string dotMailer.Sdk.Campaigns.DmCampaign.FromName

getset

The name the email will be set to be from.

string dotMailer.Sdk.Campaigns.DmCampaign.HtmlContent

getset

Gets/Sets the html content - Lazy Loaded

The Html must contain the string http://$UNSUB$ in order for it to be considered valid

int dotMailer.Sdk.Campaigns.DmCampaign.Id

getset

The system Id of the campaign

bool dotMailer.Sdk.Campaigns.DmCampaign.IsDirty

get

Returns true if the object has changed

bool dotMailer.Sdk.Campaigns.DmCampaign.IsSplitTest

getset

Is this campaign a split-test campaign

string dotMailer.Sdk.Campaigns.DmCampaign.Name

getset

The name of the campaign.

string dotMailer.Sdk.Campaigns.DmCampaign.ObjectType

getset

Returns the type name of the class Used by the serialisation process

string dotMailer.Sdk.Campaigns.DmCampaign.PlainContent

getset

Gets/Sets the plain text content - Lazy Loaded

The plaintext must contain the string "$UNSUB$ in order for it to be considered valid

CampaignReplyActions dotMailer.Sdk.Campaigns.DmCampaign.ReplyAction

getset

See CampaignReplyActions

string dotMailer.Sdk.Campaigns.DmCampaign.ReplyToEmailAddress

getset

The email address replies should be forwarded to.

CampaignStatus dotMailer.Sdk.Campaigns.DmCampaign.Status

getset

See CampaignStatus

string dotMailer.Sdk.Campaigns.DmCampaign.Subject

getset

The subject line of the email.

DmCampaignSummary dotMailer.Sdk.Campaigns.DmCampaign.Summary

getset

Returns a DmCampaignSummary. Lazy Loaded - will call web service on first use

string dotMailer.Sdk.Campaigns.DmCampaign.UserTag1

getset

User Tag

string dotMailer.Sdk.Campaigns.DmCampaign.UserTag2

getset

User Tag

string dotMailer.Sdk.Campaigns.DmCampaign.UserTag3

getset

User Tag