Micro Focus Content Manager SDK 9.3
HP.HPTRIM.SDK.MailTemplate Class Reference

A mail template is designed to allow mail messages sent by Content Manager to be customized More...

Inheritance diagram for HP.HPTRIM.SDK.MailTemplate:
HP.HPTRIM.SDK.TrimMainObject HP.HPTRIM.SDK.TrimObject HP.HPTRIM.SDK.TrimPropertySet

Public Member Functions

 MailTemplate (Database database, TrimURI uri)
 
 MailTemplate (Database database, string name)
 
 MailTemplate (Database database)
 
MailTemplate NewCopy ()
 
- Public Member Functions inherited from HP.HPTRIM.SDK.TrimMainObject
virtual void Save ()
 Permanently commits all changes made to this object (and all its child objects). For new objects a new unique identifier will be allocated (Uri). More...
 
string MakeReference (string SuggestName)
 Creates a TRIM reference file for this object, given the path and filename. A reference file can be associated with the Open command of various of the TRIM executables - TRIM.exe, TRIMDesktop.exe, etc. When the reference file is double-clicked, the associated application will then launch (or activate if it already running) and the object will then be displayed inside that executable. Returns a string containing the path and filename of the reference file created. More...
 
virtual void Delete ()
 Permanently removes this object and all its associated child objects from the database. More...
 
bool IsDeleteOk ()
 Determines if this object can be deleted. If it returns false, check the ErrorMessage details for more information. It is possible that the ErrorMessage property could contain a warning message even though the function returns true. More...
 
bool Verify (bool failOnWarning)
 Verifies all properties that have been modified since this object was last saved. Returns a Boolean value indicating whether the function succeeded. If false, the error description is stored in the ErrorMessage property. More...
 
TrimChildObjectList GetChildObjectList (BaseObjectTypes childType)
 Retrieves the child object collection of the nominated child object type. More...
 
TrimMainObject GetNewCopy ()
 Creates a new TrimMainObject which is a copy of this TrimMainObject. Where appropriate, property values are copied from this TrimMainObject to the new TrimMainObject. You will generally need to set any unique properties manually afterwards, prior to committing this new TrimMainObject to the TRIM database with the Save() method. See also the NewCopy function of the derived objects that implement this capability. Will return NULL if this object does not support the Copy function. More...
 
virtual void Refresh ()
 Resets this object to the current state on the database, will revert any changes that might have been made. Only required if you are not using BOBnotifications, or need to guarantee a really up-to-date version of the object state. More...
 
- Public Member Functions inherited from HP.HPTRIM.SDK.TrimObject
bool IsMandatory (FieldDefinition field)
 Gets a boolean value indication whether the specified field must have a non-NULL value for this object. More...
 
bool IsValidFor (int purpose)
 Call this method to determine if this object can be used for the nominated purpose. To determine what the valid purposes are, look in the derived class at the more type safe versions of this function. More...
 
bool IsValidFor (int purpose, TrimMainObject purposeExtraObject)
 Call this method to determine if this object can be used for the nominated purpose. To determine what the valid purposes are, look in the derived class at the more type safe versions of this function. The purposeExtraObject is necessary for some purpose types - once again, the derived class will have more information. More...
 
bool IsValidFor (int purpose, int purposeExtraEnumValue)
 Call this method to determine if this object can be used for the nominated purpose. To determine what the valid purposes are, look in the derived class at the more type safe versions of this function. The purposeExtraInformation is necessary for some purpose types - once again, the derived class will have more information. More...
 
bool HasPermission (GenericPermissions prm)
 Checks to see if the currently logged in user has permission to perform the generic action on this object More...
 
bool HasPropertyPermission (GenericPermissions prm, PropertyIds propId)
 Checks to see if the currently logged in user has permission to perform the generic action on the specified property of this object More...
 
- Public Member Functions inherited from HP.HPTRIM.SDK.TrimPropertySet
TrimIcon GetPropertyIcon (PropertyIds propertyId)
 Gets the icon value associated the a property of this object. More...
 
TrimMainObject GetPropertyTrimObject (PropertyIds dnPropId)
 
string GetPropertyString (PropertyIds dnPropId)
 
int GetPropertyLong (PropertyIds dnPropId)
 
long GetPropertyLong64 (PropertyIds dnPropId)
 
bool GetPropertyBool (PropertyIds dnPropId)
 
TrimDateTime GetPropertyDate (PropertyIds dnPropId)
 
TrimDecimal GetPropertyDecimal (PropertyIds dnPropId)
 
TrimCurrency GetPropertyCurrency (PropertyIds dnPropId)
 
TrimURI GetPropertyUri (PropertyIds dnPropId)
 
bool SetPropertyTrimObject (PropertyIds dnPropId, TrimMainObject newValue)
 
bool SetPropertyString (PropertyIds dnPropId, string newValue)
 
bool SetPropertyLong (PropertyIds dnPropId, int newValue)
 
bool SetPropertyLong64 (PropertyIds dnPropId, long newValue)
 
bool SetPropertyBool (PropertyIds dnPropId, bool newValue)
 
bool SetPropertyDate (PropertyIds dnPropId, TrimDateTime newValue)
 
bool SetPropertyCurrency (PropertyIds dnPropId, TrimCurrency newValue)
 
bool SetPropertyDecimal (PropertyIds dnPropId, TrimDecimal newValue)
 
bool SetPropertyDouble (PropertyIds dnPropId, double newValue)
 
bool SetPropertyUri (PropertyIds dnPropId, TrimURI newValue)
 
bool ClearProperty (PropertyIds dnPropId)
 
object GetProperty (PropertyIds propId)
 
bool SetProperty (PropertyIds propId, object newValue)
 
string GetPropertyAsString (PropertyIds propertyId, StringDisplayType propertyValueStringType, bool useHTMLEscapeChars)
 Gets a string representation of a property value in a format appropriate for a specific use. More...
 
bool IsMandatory (PropertyIds propertyId)
 Gets a boolean value indication whether the specified property must have a non-NULL value for this object. More...
 
bool VerifyProperty (PropertyIds propertyId, bool doMandatoryChecks)
 Verifies the value of a particular property, by cross checking it against other property values. The ErrorMessage property provides details if the verification fails. More...
 
bool CanModifyProperty (PropertyIds propertyId)
 Indicates whether the current user has the permission to modify the specified property. More...
 

Properties

bool AttachReference [get, set]
 Gets (or sets) a boolean value to indicate whether a Content Manager reference for the relevant object should be attached to the mail message when it is sent. More...
 
string ContentTemplate [get, set]
 Gets (or sets) the actual text to be provided for the content of the generated email message, containing any special substitution strings that will be replaced by details extracted from the relevant object or proposed recipient More...
 
MailEventType ForEventType [get, set]
 Gets (or sets) the event type that this template will be used for More...
 
PropertyIds ForPropertyId [get, set]
 Gets (or sets) a unique property identification number that can be used to further differentiate which objects should use this template More...
 
PropertyIds ForRecipientPropertyId [get, set]
 Gets (or sets) a unique property identification number that can be used to further identify whether the template should be applied, based on the recipient More...
 
FieldDefinition ForRecipientUserDefinedField [get, set]
 Gets (or sets) a user-defined field that can be used to further identify whether the template should be applied, based on the recipient More...
 
string ForRecipientWithValue [get, set]
 Gets (or sets) the actual value of the property/user-defined field that will be used to distinguish whether this template should be used in for a particular recipient More...
 
FieldDefinition ForUserDefinedField [get, set]
 Gets (or sets) a user-defined field that can be used to further differentiate which objects should use this template. Is mutually exclusive with 'forPropertyId' More...
 
new string Name [get, set]
 Gets (or sets) the unique name for this mail template More...
 
string ObjectsSelected [get]
 Gets a description of the objects that are applicable for this mail template More...
 
string RecipientsSelected [get]
 Gets a description of the recipients that are applicable for this mail template More...
 
BaseObjectTypes RelatingToObjectType [get]
 Gets the type of Content Manager object that the email template relates to More...
 
string ReplyTo [get, set]
 Gets (or sets) the email address that will appear in the 'From' field of any mail message generated using this template. More...
 
string SubjectTemplate [get, set]
 Gets (or sets) the actual text to be provided for the subject of the generated email message, containing any special substitution strings that will be replaced by details extracted from the relevant object or proposed recipient More...
 
bool UseHTMLformat [get, set]
 Gets (or sets) a boolean value to indicate whether the mail message uses HTML format. More...
 
string WithValue [get, set]
 Gets (or sets) the actual value of the property/user-defined field that will be used to distinguish whether this template should be used in a particular circumstance More...
 
- Properties inherited from HP.HPTRIM.SDK.TrimMainObject
TrimDateTime LastUpdatedOn [get]
 Returns the date and time that changes to this object were last committed. More...
 
string Name [get]
 Gets a string name for this object which is a user-friendly way of displaying this object. For most TRIM objects the name is a unique string, although some times this is not the case (eg Location Names). More...
 
bool Verified [get]
 Gets a Boolean value indicating whether the object has been verified. That is, whether a call to the 'Verify' method has been made and has succeeded. More...
 
string WebURL [get]
 
bool IsInFavorites [get]
 Gets a boolean value indicating whether this object is in the current user's list of favorites More...
 
string UpdateComment [get, set]
 Gets or sets a string value to be recorded with any audit entries related to the update of this object More...
 
- Properties inherited from HP.HPTRIM.SDK.TrimObject
BaseObjectTypes TrimType [get]
 Gets a BaseObjectTypes enum value indicating the type of this object. More...
 
TrimURI Uri [get]
 Gets the unique row identifier for this object. Once an object has been committed to the database, typically by calling a Save method, this unique identifier is allocated. From that time on, the uri will remain constant and can never be changed. It is always unique across all objects of the same Type. More...
 
string URN [get]
 Gets the uniform resource name for this object. More...
 
string NameString [get]
 Gets a string name for this object which is a user-friendly way of displaying this object. For most TRIM objects the name is a unique string, although some times this is not the case (eg Location Names). More...
 
string NameStringExtra [get]
 Gets a more verbose description of this object, particularly when the name is perhaps a little cryptic or not enough to fully describe the object. More...
 
bool IsReadOnly [get]
 Gets a boolean parameter indicating if this object is "ReadOnly". This would generally indicate that none of the object's properties could be modified, in some cases there are exceptions that can be tested via CanModifyProperty method. More...
 
bool PossiblyHasSubordinates [get]
 Indicates if this object could possibly have child objects of the same type that can be displayed in a hierarchy. More...
 
- Properties inherited from HP.HPTRIM.SDK.TrimPropertySet
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...
 
Database Database [get]
 Gets the TRIM Database object in which this object resides. All TRIM objects live within a particular TRIM database and cannot be created without one. More...
 
virtual string Caption [get]
 Gets the user-defined caption that has been associated with all TrimPropertySets of this type. More...
 
virtual TrimIcon Icon [get]
 Gets the icon value associated this TrimPropertySet. More...
 
bool IsModified [get]
 Gets a boolean parameter indicating if any changes have been made to this object since it was first constructed, or last saved. More...
 

Detailed Description

A mail template is designed to allow mail messages sent by Content Manager to be customized

Constructor & Destructor Documentation

HP.HPTRIM.SDK.MailTemplate.MailTemplate ( Database  database,
TrimURI  uri 
)
HP.HPTRIM.SDK.MailTemplate.MailTemplate ( Database  database,
string  name 
)
HP.HPTRIM.SDK.MailTemplate.MailTemplate ( Database  database)

Member Function Documentation

MailTemplate HP.HPTRIM.SDK.MailTemplate.NewCopy ( )

Property Documentation

bool HP.HPTRIM.SDK.MailTemplate.AttachReference
getset

Gets (or sets) a boolean value to indicate whether a Content Manager reference for the relevant object should be attached to the mail message when it is sent.

string HP.HPTRIM.SDK.MailTemplate.ContentTemplate
getset

Gets (or sets) the actual text to be provided for the content of the generated email message, containing any special substitution strings that will be replaced by details extracted from the relevant object or proposed recipient

MailEventType HP.HPTRIM.SDK.MailTemplate.ForEventType
getset

Gets (or sets) the event type that this template will be used for

PropertyIds HP.HPTRIM.SDK.MailTemplate.ForPropertyId
getset

Gets (or sets) a unique property identification number that can be used to further differentiate which objects should use this template

PropertyIds HP.HPTRIM.SDK.MailTemplate.ForRecipientPropertyId
getset

Gets (or sets) a unique property identification number that can be used to further identify whether the template should be applied, based on the recipient

FieldDefinition HP.HPTRIM.SDK.MailTemplate.ForRecipientUserDefinedField
getset

Gets (or sets) a user-defined field that can be used to further identify whether the template should be applied, based on the recipient

string HP.HPTRIM.SDK.MailTemplate.ForRecipientWithValue
getset

Gets (or sets) the actual value of the property/user-defined field that will be used to distinguish whether this template should be used in for a particular recipient

FieldDefinition HP.HPTRIM.SDK.MailTemplate.ForUserDefinedField
getset

Gets (or sets) a user-defined field that can be used to further differentiate which objects should use this template. Is mutually exclusive with 'forPropertyId'

new string HP.HPTRIM.SDK.MailTemplate.Name
getset

Gets (or sets) the unique name for this mail template

string HP.HPTRIM.SDK.MailTemplate.ObjectsSelected
get

Gets a description of the objects that are applicable for this mail template

string HP.HPTRIM.SDK.MailTemplate.RecipientsSelected
get

Gets a description of the recipients that are applicable for this mail template

BaseObjectTypes HP.HPTRIM.SDK.MailTemplate.RelatingToObjectType
get

Gets the type of Content Manager object that the email template relates to

string HP.HPTRIM.SDK.MailTemplate.ReplyTo
getset

Gets (or sets) the email address that will appear in the 'From' field of any mail message generated using this template.

string HP.HPTRIM.SDK.MailTemplate.SubjectTemplate
getset

Gets (or sets) the actual text to be provided for the subject of the generated email message, containing any special substitution strings that will be replaced by details extracted from the relevant object or proposed recipient

bool HP.HPTRIM.SDK.MailTemplate.UseHTMLformat
getset

Gets (or sets) a boolean value to indicate whether the mail message uses HTML format.

string HP.HPTRIM.SDK.MailTemplate.WithValue
getset

Gets (or sets) the actual value of the property/user-defined field that will be used to distinguish whether this template should be used in a particular circumstance