dotmailer SDK: dotMailer.Sdk.Campaigns.DmCampaignOpener Class Reference

dotmailer SDK

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

Campaign Opener Information More...

Inheritance diagram for dotMailer.Sdk.Campaigns.DmCampaignOpener:
dotMailer.Sdk.Interfaces.IDmObject dotMailer.Sdk.Cache.IDmCacheableObject

Properties

int AccountId [get, set]
 The parent account id
 
int CampaignId [get, set]
 The parent campaign id
 
string ContactEmail [get, set]
 The contact id
 
string MailClientVersion [get, set]
 The version of the mail client used to open the email.
 
string MailClient [get, set]
 The mail client used to open the email.
 
string IpAddress [get, set]
 The IP address that the contact was using when they clicked the link.
 
string UserAgent [get, set]
 The user agent the contact was using the read the email when the link was clicked.
 
bool IsHtml [get, set]
 Whether the campaign opened was the HTML one (TRUE) or Plain Text one (FALSE).
 
bool IsForward [get, set]
 Whether the open was from a forwarded campaign..
 
DateTime DateOpened [get, set]
 The date and time the link was opened.
 
string UserTag1 [get, set]
 User Tag
 
string UserTag2 [get, set]
 User Tag
 
string UserTag3 [get, set]
 User Tag
 
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. Note: If a contact's email address is changed, then the external IDs of all related DmCampaignOpeners will also change.
 
- 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

Campaign Opener Information

Property Documentation

int dotMailer.Sdk.Campaigns.DmCampaignOpener.AccountId
getset

The parent account id

int dotMailer.Sdk.Campaigns.DmCampaignOpener.CampaignId
getset

The parent campaign id

string dotMailer.Sdk.Campaigns.DmCampaignOpener.ContactEmail
getset

The contact id

The email address of the contact.

DateTime dotMailer.Sdk.Campaigns.DmCampaignOpener.DateOpened
getset

The date and time the link was opened.

string dotMailer.Sdk.Campaigns.DmCampaignOpener.ExternalId
get

Gets/Sets the generated ID that uniquely identifies this record. Note: If a contact's email address is changed, then the external IDs of all related DmCampaignOpeners will also change.

string dotMailer.Sdk.Campaigns.DmCampaignOpener.IpAddress
getset

The IP address that the contact was using when they clicked the link.

bool dotMailer.Sdk.Campaigns.DmCampaignOpener.IsDirty
get

Returns true if the object has changed

bool dotMailer.Sdk.Campaigns.DmCampaignOpener.IsForward
getset

Whether the open was from a forwarded campaign..

bool dotMailer.Sdk.Campaigns.DmCampaignOpener.IsHtml
getset

Whether the campaign opened was the HTML one (TRUE) or Plain Text one (FALSE).

string dotMailer.Sdk.Campaigns.DmCampaignOpener.MailClient
getset

The mail client used to open the email.

string dotMailer.Sdk.Campaigns.DmCampaignOpener.MailClientVersion
getset

The version of the mail client used to open the email.

string dotMailer.Sdk.Campaigns.DmCampaignOpener.ObjectType
getset

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

string dotMailer.Sdk.Campaigns.DmCampaignOpener.UserAgent
getset

The user agent the contact was using the read the email when the link was clicked.

string dotMailer.Sdk.Campaigns.DmCampaignOpener.UserTag1
getset

User Tag

string dotMailer.Sdk.Campaigns.DmCampaignOpener.UserTag2
getset

User Tag

string dotMailer.Sdk.Campaigns.DmCampaignOpener.UserTag3
getset

User Tag

Generated by   doxygen 1.8.3