Table of Contents

Class EmailTrigger

Namespace
ArcanaDevelopment.adTempus.Client
Assembly
ArcanaDevelopment.adTempus.Client.dll

A trigger that fires based on email messages

public sealed class EmailTrigger : Trigger, ISupportJobVariables
Inheritance
object
EmailTrigger
Implements

Properties

ClassID

The Class ID for the object

[IgnoreDataMember]
public override ClassID ClassID { get; }

Property Value

ClassID

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 after processing.

public bool DeleteSelectedMessages { get; set; }

Property Value

bool

IsDependent

Indicates whether the object is a dependent of (owned by) another object

[IgnoreDataMember]
public override bool IsDependent { get; }

Property Value

bool

Remarks

An independent object (IsDependent is false) is an object that can exist on its own without being part of another object. For example, Jobs, Job Groups, etc.

A dependent object (IsDependent is true) is a part of another object. For example, a JobStep cannot exist independently of a Job, so the JobStep is dependent.

Dependent objects cannot be directly fetched from the server: they are only fetched as part of the object they belong to. They also cannot be saved or deleted independently: they are automatically saved or deleted when the owning object is saved or deleted.

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

EmailSaveFormat

Remarks

If the MessageSaveFormat is 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

MessagingServiceProvider

Remarks

The provider must be of type POP3 or IMAP.

PollingInterval

The interval at which to check for new messages.

public TimeSpan PollingInterval { get; set; }

Property Value

TimeSpan

Remarks

Set to System.TimeSpan.Zero to use the default value of 300 seconds (5 minutes). The minimum interval is 30 seconds.

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 no rules are specified, the trigger will fire for all messages that have not previously been seen.

public ExpressionList GetSelectionRules()

Returns

ExpressionList

Remarks

If you make changes to the returned collection of rules you must call SetSelectionRules(ExpressionList) to update the task with the modified rules.

See Also

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 on the server.

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 rules)

Parameters

NameTypeDescription
rules ExpressionList

The rules to set
See Also

WriteToConfigurationReport(IADTObjectConfigurationReportWriter)

Writes the object and any contained objects to a configuration report

public override void WriteToConfigurationReport(IADTObjectConfigurationReportWriter reportBuilder)

Parameters

NameTypeDescription
reportBuilder IADTObjectConfigurationReportWriter

The report builder to write the object to.

Inherited Members