TRIM.SDK.OriginEmailCaptureSettings Class Reference

The ApiOriginEmailCaptureSettings object is a helper class used to store settings when using an Origin of type 'Email Capture' More...

Inheritance diagram for TRIM.SDK.OriginEmailCaptureSettings:

Public Member Functions
	OriginEmailCaptureSettings (Database database)
	Construct an ApiOriginEmailCaptureSettings object More...
Public Member Functions inherited from TRIM.SDK.TrimSDKObject
	TrimSDKObject ()

Properties
bool	IncludeJournalHeaders [get, set]
	Gets or sets a boolean value indicating if the journal headers for the email should be stored in the EML document More...
bool	CreateContacts [get, set]
	Gets or sets a boolean value indicating if the email capture program should create contacts from email recipients More...
bool	CreateContactsOnlyForExistingLocations [get, set]
	Gets or sets a boolean value indicating when creating contacts from email recipients, limit contacts to only locations that already exist in the dataset. This prevents creating new 'unknown' locations from email addresses that haven't already been registered for a location. More...
bool	CheckForDuplicates [get, set]
	Gets or sets a boolean value indicating if the email capture program should check for duplicates based on messageId and prevent them being added into TRIM More...
bool	UseBulkLoader [get, set]
	Gets or sets a boolean value indicating if the email capture program should use the bulk data loader More...
string	QuarantineFolder [get, set]
	Gets or sets a string value indicating the name of a folder where any badly formatted email messages should be moved if they cannot be added into TRIM More...
LogLevels	LogLevel [get, set]
	Gets or sets a LogLevels enumerated value indicating the level of detail to be provided in the email capture log file More...
OriginEmailCaptureSpamRuleList?	SpamFilters [get, set]
	Gets or sets a an array of spam filter rules to be used to determine if an email message is to be deemed as spam and therefore not added into TRIM More...
bool	MoveSpamToFolder [get, set]
	Gets or sets a boolean value indicating if the spam mail messages should be moved over to a separate folder rather than being simply deleted More...
string	SpamFolder [get, set]
	Gets or sets a string value indicating the name of the folder to put any spam messages (if the MoveToSpamFolder setting is turned on) More...
Properties inherited from TRIM.SDK.TrimSDKObject
string	ErrorMessage [get]
	All TRIM SDK objects have an ErrorMessage property which can be used to examine any error that may have occurred in the most recent method call. More...
TrimException	Error [get]
	All TRIM SDK objects have an Error property which can be used to examine any error that may have occurred in the most recent method call. More...

Detailed Description

The ApiOriginEmailCaptureSettings object is a helper class used to store settings when using an Origin of type 'Email Capture'

Constructor & Destructor Documentation

OriginEmailCaptureSettings()

TRIM.SDK.OriginEmailCaptureSettings.OriginEmailCaptureSettings

(

Database

database

)

Construct an ApiOriginEmailCaptureSettings object

Property Documentation

CheckForDuplicates

bool TRIM.SDK.OriginEmailCaptureSettings.CheckForDuplicates

getset

Gets or sets a boolean value indicating if the email capture program should check for duplicates based on messageId and prevent them being added into TRIM

CreateContacts

bool TRIM.SDK.OriginEmailCaptureSettings.CreateContacts

getset

Gets or sets a boolean value indicating if the email capture program should create contacts from email recipients

CreateContactsOnlyForExistingLocations

bool TRIM.SDK.OriginEmailCaptureSettings.CreateContactsOnlyForExistingLocations

getset

Gets or sets a boolean value indicating when creating contacts from email recipients, limit contacts to only locations that already exist in the dataset. This prevents creating new 'unknown' locations from email addresses that haven't already been registered for a location.

IncludeJournalHeaders

bool TRIM.SDK.OriginEmailCaptureSettings.IncludeJournalHeaders

getset

Gets or sets a boolean value indicating if the journal headers for the email should be stored in the EML document

LogLevel

LogLevels TRIM.SDK.OriginEmailCaptureSettings.LogLevel

getset

Gets or sets a LogLevels enumerated value indicating the level of detail to be provided in the email capture log file

MoveSpamToFolder

bool TRIM.SDK.OriginEmailCaptureSettings.MoveSpamToFolder

getset

Gets or sets a boolean value indicating if the spam mail messages should be moved over to a separate folder rather than being simply deleted

QuarantineFolder

string TRIM.SDK.OriginEmailCaptureSettings.QuarantineFolder

getset

Gets or sets a string value indicating the name of a folder where any badly formatted email messages should be moved if they cannot be added into TRIM

SpamFilters

OriginEmailCaptureSpamRuleList? TRIM.SDK.OriginEmailCaptureSettings.SpamFilters

getset

Gets or sets a an array of spam filter rules to be used to determine if an email message is to be deemed as spam and therefore not added into TRIM

SpamFolder

string TRIM.SDK.OriginEmailCaptureSettings.SpamFolder

getset

Gets or sets a string value indicating the name of the folder to put any spam messages (if the MoveToSpamFolder setting is turned on)

UseBulkLoader

bool TRIM.SDK.OriginEmailCaptureSettings.UseBulkLoader

getset

Gets or sets a boolean value indicating if the email capture program should use the bulk data loader