Class EmailTrigger
- Namespace
- ArcanaDevelopment.adTempus.Client
- Assembly
- ArcanaDevelopment.adTempus.Client.dll
public sealed class EmailTrigger : Trigger
- Inheritance
-
objectEmailTrigger
Properties
CID
The Class ID for the object
[IgnoreDataMember]
public override ClassID CID { get; }
Property Value
Remarks
Obsolete. Use ClassID instead.
ClassKeyName
The key name for the class.
public override string ClassKeyName { get; }
Property Value
- string
Remarks
This name the name used by adTempus to identify the class and is intended for programmatic use only. Use the ClassName for a user-friendly name.
DeleteSelectedMessages
Specifies whether selected messages are deleted from the server.
public bool DeleteSelectedMessages { get; set; }
Property Value
- bool
IsDependent
[IgnoreDataMember]
public override bool IsDependent { get; }
Property Value
- bool
MailboxName
The name of the IMAP mailbox to read messages from.
public string MailboxName { get; set; }
Property Value
- string
Remarks
If no MailboxName is specified, the default mailbox is used.
MessageSaveFormat
Specifies whether and how to save selected messages.
public EmailSaveFormat MessageSaveFormat { get; set; }
Property Value
Remarks
If the MessageSaveFormat is EmailSaveFormat.None, the selected messages are not saved to files. Otherwise, the messages are saved in the specified format to the directory specified in MessageSaveLocation.
MessageSaveLocation
The directory where selected messages should be saved if message saving is specified in MessageSaveFormat
public string MessageSaveLocation { get; set; }
Property Value
- string
MessagingServiceProvider
The MessagingServiceProvider to use for connecting to the mailbox.
public MessagingServiceProvider MessagingServiceProvider { get; set; }
Property Value
Remarks
The provider must be of type POP3 or IMAP.
PollingInterval
The interval (in seconds) at which to check for new messages.
public int PollingInterval { get; set; }
Property Value
- int
Remarks
The default value is 300 seconds (5 minutes).
TriggerForEachMessage
Specifies whether the job is triggered separately for each message that matches the criteria.
public bool TriggerForEachMessage { get; set; }
Property Value
- bool
Remarks
If True, a separate instance of the job is started for each matching message found. If False, only a single instance of the job is started on each processing pass, regardless of how many matching messages are found.
Methods
GetSelectionRules()
Gets the set of rules defining which messages to select. If not rules are specified, the trigger will fire for all messages that have not previously been seen.
public ExpressionList GetSelectionRules()
Returns
GetTriggerDescription()
protected override string GetTriggerDescription()
Returns
- string
ResetReadMessages()
Clear its list of messages that have already been processed for this trigger, causing it to reprocess all messages.
public void ResetReadMessages()
SetSelectionRules(ExpressionList)
Sets he set of rules defining which messages to select. If not rules are specified, the trigger will fire for all messages that have not previously been seen.
public void SetSelectionRules(ExpressionList value)
Parameters
| Name | Type | Description |
|---|---|---|
value |
ExpressionList |
WriteToConfigurationReport(IADTObjectConfigurationReportWriter)
public override void WriteToConfigurationReport(IADTObjectConfigurationReportWriter reportBuilder)
Parameters
| Name | Type | Description |
|---|---|---|
reportBuilder |
IADTObjectConfigurationReportWriter |
Inherited Members
- Trigger.Name
- Trigger.Description
- Trigger.MinimumInterval
- Trigger.Enabled
- Trigger.UserInterfaceExtensionID
- Trigger.UserInterfaceExtensionData
- Trigger.DescriptionOverride
- Trigger.SelectionScript
- Trigger.JobVariables
- Trigger.GetInheritedVariables(bool)
- Trigger.ExtendedDescription
- ADTObject.LastModified
- ADTObject.CreationTimestamp
- ADTObject.FromMaster
- ADTObject.OID
- ADTObject.ClassID
- ADTObject.BindingDescription
- ADTObject.ToString()
- ADTObject.ParentObject
- ADTObject.CanPerform(SecurityPermission)
- ADTObject.Duplicate()
- ADTObject.DataContext
- ADTObject.AccessMask
- ADTObject.Validate(MessageCollection)
- ADTObject.SupportedSecurityActions
- ADTObject.SupportedSecurityInheritanceOptions
- ADTObject.GetTopLevelOwner()
- ADTObject.GetConfigurationReport()
- ADTObject.GetConfigurationReport(bool)
- ADTObject.IsReadOnly
- ObjectBase.IsDirty
- ObjectBase.IsNew
- ObjectBase.IsStub
- ObjectBase.ClassName
- ObjectBase.GetDescription()
- ObjectBase.BeginEdit()
- ObjectBase.BeginEdit(UndoLevelAction)
- ObjectBase.CommitEdit(Guid)
- ObjectBase.CommitEdit()
- ObjectBase.UndoEdit()
- ObjectBase.UndoEdit(Guid)