JAMS 6.x Help
TriggerEventMail Class Members
Properties  Methods  Events


The following tables list the members exposed by TriggerEventMail.

Public Constructors
 NameDescription
Public ConstructorTriggerEventMail ConstructorCreates a new TriggerEventMail.  
Top
Public Properties
 NameDescription
Public PropertyDeleteWhen set to true, the e-mail is deleted from the mail server when the event fires.  
Public PropertyDescriptionOverridden. Generate and return a description of this TriggerEvent  
Public PropertyErrorGets an error message that describes the errors in the object. (Inherited from MVPSI.JAMS.BasePublicObject)
Public PropertyEventHappenedGets the EventHappened property which contains a DateTime indicating the last time this Event was true; (Inherited from MVPSI.JAMS.TriggerEvent)
Public PropertyEventHappenedUTCGets the EventHappened property which contains a UTC DateTime indicating the last time this Event was true; (Inherited from MVPSI.JAMS.TriggerEvent)
Public PropertyEventIDGets the EventID property. The value returned is the ID of a JAMS Job or Variable. Use the EventType to determine if this value is a Job or Variable ID. (Inherited from MVPSI.JAMS.TriggerEvent)
Public PropertyEventIsTrueGets the EventIsTrue property which indicates whether this Event is true right now. (Inherited from MVPSI.JAMS.TriggerEvent)
Public PropertyEventNameGets this Trigger Event Name. The name is either the JobName or VariableName depending upon the TriggerEventType. (Inherited from MVPSI.JAMS.TriggerEvent)
Public PropertyEventTypeGets this TriggerEvent Type. (Inherited from MVPSI.JAMS.TriggerEvent)
Public PropertyFromGets or Sets text which must be found in one of the From addresses of the mail message  
Public PropertyHasErrorsThe HasErrors property can be used to determine if the object has any errors. If the object needs to be validated, it is done before returning. (Inherited from MVPSI.JAMS.BasePublicObject)
Public PropertyImplicitModeWhen set to true, implicit SSL is used to secure the connection to the mail server.  
Public PropertyInEditIs this object in the middle of an edit? (Inherited from MVPSI.JAMS.BasePublicObject)
Public PropertyIntervalSets the interval between checking for new mail.  
Public PropertyItemReturns any error messages currently associated with this column. (Inherited from MVPSI.JAMS.BasePublicObject)
Public PropertyLastChangeGets the date and time that this TriggerEvent was last changed. (Inherited from MVPSI.JAMS.TriggerEvent)
Public PropertyLastChangeUTCGets the UTC date and time that this TriggerEvent was last changed. (Inherited from MVPSI.JAMS.TriggerEvent)
Public PropertyLoadedFromGets the JAMS server where this TriggerEvent is stored. (Inherited from MVPSI.JAMS.TriggerEvent)
Public PropertyMailProtocolGets or Sets the mail protocol to use when connecting to the e-mail server  
Public PropertyMailServerGets or Sets the name of the mail server.  
Public PropertyMarkAsReadWhen set to true, the e-mail is marked as read when the event fires.  
Public PropertyModifiedThe Modified property keeps track of modified state of this object. You cannot set the Modified property. If you modify the object, the modified property will be true until you end or cancel the update. (Inherited from MVPSI.JAMS.BasePublicObject)
Public PropertyNewObjectThe NewObject property indicates that this object has just been created and has never been saved on a JAMS Server. (Inherited from MVPSI.JAMS.BasePublicObject)
Public PropertyOptionsGets or Sets mail server options.  
Public PropertyParentListGets the list that this object is contained in. (Inherited from MVPSI.JAMS.TriggerEvent)
Public PropertyPortSets the TCP/IP port that should be used to connect to the e-mail server. Set this to zero to use the default port.  
Public PropertySSLWhen set to true, SSL is used to secure the connection to the mail server.  
Public PropertySubjectGets or Sets text which must be found in the subject of the mail message  
Public PropertyToGets or Sets text which must be found in one of the From addresses of the mail message  
Public PropertyUserIDGets or Sets the username which should be used to check for the file.  
Public PropertyUserNameGets or Sets the username which should be used to check for the file.  
Public PropertyUserSecurityGets or Sets the username which should be used to check for the file.  
Public PropertyValidatedThe Validated property keeps track of the validation state of this object. If the object has been modified, Validated will be false until the object has been successfully validated by the Validate method. (Inherited from MVPSI.JAMS.BasePublicObject)
Top
Public Methods
 NameDescription
Public MethodBeginEditStarts an edit of this object. (Inherited from MVPSI.JAMS.BasePublicObject)
Public MethodCancelEditCancels an edit of this object. (Inherited from MVPSI.JAMS.BasePublicObject)
Public MethodClearErrorClears the error message for a property. (Inherited from MVPSI.JAMS.BasePublicObject)
Public MethodClearModifiedClearModified is designed to be used internally and should not be called from end-user code. Call Update() which saves the modifications and then calls ClearModified. (Inherited from MVPSI.JAMS.BasePublicObject)
Public MethodCloneOverridden. Clone this TriggerEvent  
Public MethodCompareToImplementation of IComparable CompareTo. Compares this instance to the one specified. (Inherited from MVPSI.JAMS.TriggerEvent)
Public MethodEndEditEnds an edit of this object. Any changes are saved. (Inherited from MVPSI.JAMS.BasePublicObject)
Public MethodInitializeOverridden. Initialize this TriggerEventMail to its default values.  
Public MethodSetErrorSets the error message for a property. (Inherited from MVPSI.JAMS.BasePublicObject)
Public MethodSetModifiedMarks the object as modified. (Inherited from MVPSI.JAMS.BasePublicObject)
Public MethodToStringReturns a string representation of this Variable Trigger.  
Public MethodUndoEditsOverridden. Undo changes that have not been saved to the database.  
Public MethodUpdateOverridden. Save pending updates.  
Public MethodValidateOverloaded. Overridden. Validate all properties.  
Top
Protected Methods
 NameDescription
Protected MethodRaisePropertyChangedAttempts to raise the PropertyChanged event (Inherited from MVPSI.JAMS.BasePublicObject)
Protected MethodRaisePropertyChangingAttempts to raise the PropertyChanging event (Inherited from MVPSI.JAMS.BasePublicObject)
Protected MethodSaveOriginalOverridden. Save the original values incase we have to Undo.  
Top
Public Events
 NameDescription
Public EventPropertyChangedEvent Handler for Property Changed Event (Inherited from MVPSI.JAMS.BasePublicObject)
Public EventPropertyChangingEvent Handler for Property Changing Event (Inherited from MVPSI.JAMS.BasePublicObject)
Top
See Also

Reference

TriggerEventMail Class
MVPSI.JAMS Namespace