An email link is a place where users can drop email messages for filing into HPE Records Manager
More...
|
| | EmailLink (Database database, TrimURI uri) |
| | construct an email link for the current user for the nominated record More...
|
| |
| | EmailLink (Database database, string name) |
| | construct an email link for the current user for the nominated classification More...
|
| |
| | EmailLink (Record linkedToRecord) |
| | construct an email link for the nominated user for the nominated record (requires appropriate permissions) More...
|
| |
| | EmailLink (Classification linkedToClassification) |
| | construct an email link for the current user for the nominated classification (requires appropriate permissions) More...
|
| |
| | EmailLink (Record linkedToRecord, Location forNominatedUser) |
| |
| | EmailLink (Classification linkedToClassification, Location forNominatedUser) |
| |
| void | SetSyncState (string newStateValue) |
| | Sets the sync state string for this email link to the value used for the email synchronization system. More...
|
| |
| void | SetNotes (string newValue, NotesUpdateType TypeOfNotesUpdate) |
| |
 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...
|
| |
| 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...
|
| |
| 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) |
| |
| TrimGeography | GetPropertyGeography (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...
|
| |
|
| string | Description [get] |
| | Gets a string describing this email link More...
|
| |
| string | DisplayName [get, set] |
| | Gets or sets a string value used when displaying this email link as a folder within an email application. More...
|
| |
| Classification | LinkedClassification [get] |
| | Gets a classification object representing the classification that will be used to file under for this email link (only for linkedObjectType = Classification) More...
|
| |
| EmailLinkType | LinkedObjectType [get] |
| | Gets a emailLinkType enumerated value indicating which type of HPE Records Manager filing object is used for this email link. More...
|
| |
| Record | LinkedRecord [get] |
| | Gets a record object representing the container or matter that will be used to file under for this email link More...
|
| |
| string | MailFolderId [get, set] |
| | Gets or sets a string value representing the identifier of a corresponding folder in the mail system used to represent this email link. More...
|
| |
| Record | Matter [get] |
| | Gets a Record object indicating the matter that this email link belongs to. Applies to the automatically generated subfolder email links, created when a Matter email link type is created More...
|
| |
| bool | PermanentDelete [get, set] |
| | Gets or sets a boolean variable indicating that when deleting an email, the email message should be permanently deleted rather than moved to the Deleted Mail folder More...
|
| |
| RecordType | RecordType [get, set] |
| | Gets or sets a RecordType object indicating which record type to use when creating records from email messages within this email link More...
|
| |
| bool | RetainInMailClient [get, set] |
| | Gets or sets a boolean variable indicating if the email message should remain within the email client after it has been registered within HPE Records Manager More...
|
| |
| int | RetentionPeriod [get, set] |
| | Gets or sets a number value indicating how long an email message should be held within the email client after it has been registered within HPE Records Manager (if RetainInMailClient = true). Zero Means Forever More...
|
| |
| RecordType | SubFolderRecordType [get, set] |
| | Gets or sets a RecordType object used as the RecordType for the automatically generated subfolder email links that are created for a Matter email link type More...
|
| |
| string | SyncState [get, set] |
| | Gets or sets a string value uses to record the current synchronization state of the corresponding Email Server Folder. More...
|
| |
| Location | User [get] |
| | Gets a location object representing the user who owns and uses this email link for filing. More...
|
| |
| bool | CanModifyExistingNotes [get] |
| |
| bool | CanAddToNotes [get] |
| |
| string | Notes [get, set] |
| |
| 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...
|
| |
| 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...
|
| |
| 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] |
| |
| virtual TrimIcon | Icon [get] |
| |
| 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...
|
| |
An email link is a place where users can drop email messages for filing into HPE Records Manager
1.8.11 
