dotmailer SDK: dotMailer.Sdk.Objects.Templates.DmTemplate Class Reference

dotmailer SDK

previous page next page
dotmailer SDK
Tools to access and manage an account in the dotMailer system
Public Member Functions | Properties | List of all members
dotMailer.Sdk.Objects.Templates.DmTemplate Class Reference

A Template is a wrapper for campaign content. More...

Inheritance diagram for dotMailer.Sdk.Objects.Templates.DmTemplate:
dotMailer.Sdk.Interfaces.IDmTemplate dotMailer.Sdk.Interfaces.IDmObject dotMailer.Sdk.Cache.IDmCacheableObject

Public Member Functions

 DmTemplate ()
 Constructor
 
DmCampaign ConvertToCampaign (string subject, string campaignName)
 Converts the template to a campaign
 

Properties

int AccountId [get, set]
 The parent account id
 
string FromName [get, set]
 The name the email will be set to be from.
 
int Id [get, set]
 The template ID.
 
string Name [get, set]
 The name of the template.
 
CampaignReplyActions ReplyAction [get, set]
 CampaignReplyActions Unset, WebMailForward, Webmail or Delete.
 
string ReplyToAddress [get, set]
 The email address replies should be forwarded to.
 
string Subject [get, set]
 The subject line of the email.
 
string UserTag1 [get, set]
 User Tag
 
string UserTag2 [get, set]
 User Tag
 
string UserTag3 [get, set]
 User Tag
 
string HtmlContent [get, set]
 The contents of the HTML template.
 
string PlainContent [get, set]
 The contents of the Plain Text version of the template.
 
string ExternalId [get]
 A generated Id that uniquely identifies this template across all dotMailer accounts.
 
string ObjectType [get, set]
 Returns the type name of the class Used by the serialisation process
 
bool IsDirty [get]
 Returns true if the object has changed
 
- Properties inherited from dotMailer.Sdk.Interfaces.IDmTemplate
string FromName [get]
 The name the email will be set to be from.
 
string HtmlContent [get]
 The contents of the HTML template.
 
int Id [get]
 The template ID.
 
string Name [get]
 The name of the template.
 
string PlainContent [get]
 The contents of the Plain Text version of the template.
 
CampaignReplyActions ReplyAction [get]
 Unset, WebMailForward, Webmail or Delete.
 
string ReplyToAddress [get]
 The email address replies should be forwarded to.
 
string Subject [get]
 The subject line of the email.
 
- 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

A Template is a wrapper for campaign content.

It is used to create campaigns which are then sent as emails

Constructor & Destructor Documentation

dotMailer.Sdk.Objects.Templates.DmTemplate.DmTemplate ( )

Constructor

Member Function Documentation

DmCampaign dotMailer.Sdk.Objects.Templates.DmTemplate.ConvertToCampaign ( string  subject,
string  campaignName 
)

Converts the template to a campaign

Parameters
subjectThe subject of the campaign
campaignNameThe name of the campaign
Returns

Property Documentation

int dotMailer.Sdk.Objects.Templates.DmTemplate.AccountId
getset

The parent account id

string dotMailer.Sdk.Objects.Templates.DmTemplate.ExternalId
get

A generated Id that uniquely identifies this template across all dotMailer accounts.

string dotMailer.Sdk.Objects.Templates.DmTemplate.FromName
getset

The name the email will be set to be from.

string dotMailer.Sdk.Objects.Templates.DmTemplate.HtmlContent
getset

The contents of the HTML template.

int dotMailer.Sdk.Objects.Templates.DmTemplate.Id
getset

The template ID.

bool dotMailer.Sdk.Objects.Templates.DmTemplate.IsDirty
get

Returns true if the object has changed

string dotMailer.Sdk.Objects.Templates.DmTemplate.Name
getset

The name of the template.

string dotMailer.Sdk.Objects.Templates.DmTemplate.ObjectType
getset

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

string dotMailer.Sdk.Objects.Templates.DmTemplate.PlainContent
getset

The contents of the Plain Text version of the template.

CampaignReplyActions dotMailer.Sdk.Objects.Templates.DmTemplate.ReplyAction
getset

CampaignReplyActions Unset, WebMailForward, Webmail or Delete.

string dotMailer.Sdk.Objects.Templates.DmTemplate.ReplyToAddress
getset

The email address replies should be forwarded to.

string dotMailer.Sdk.Objects.Templates.DmTemplate.Subject
getset

The subject line of the email.

string dotMailer.Sdk.Objects.Templates.DmTemplate.UserTag1
getset

User Tag

string dotMailer.Sdk.Objects.Templates.DmTemplate.UserTag2
getset

User Tag

string dotMailer.Sdk.Objects.Templates.DmTemplate.UserTag3
getset

User Tag

Generated by   doxygen 1.8.3
previous page start next page