Class EmailTask
- Namespace
- ArcanaDevelopment.adTempus.Client
- Assembly
- ArcanaDevelopment.adTempus.Client.dll
A task to download and process e-mail messages.
public sealed class EmailTask : Task
- Inheritance
-
objectEmailTask
Remarks
The e-mail server can be specified using either the MessagingServiceProvider or a ServerAddress.
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. A MessagingServiceProvider must be specified if ServerAddress is not set.
Script
public Script Script { get; set; }
Property Value
SupportedResponseEvents
Gets a list of the events that are supported for Responses associated with this task.
public override ReadOnlyCollection<SupportedResponseEvent> SupportedResponseEvents { get; }
Property Value
- ReadOnlyCollection<SupportedResponseEvent>
Methods
GetObjectDescription()
Gets a description of the object's key settings.
protected override string GetObjectDescription()
Returns
- string
Remarks
This method is called by GetDescription() to get a user-friendly description of the object (such as its key settings) for display to the user. The description should contain enough information to distinguish this object from others of the same class.
- See Also
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
ResetReadMessages()
Clear its list of messages that have already been processed for this trigger, causing it to reprocess all messages.
public void ResetReadMessages()
SetPassword(string)
public void SetPassword(string value)
Parameters
| Name | Type | Description |
|---|---|---|
value |
string |
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
- Task.UserInterfaceExtensionID
- Task.UserInterfaceExtensionData
- Task.DescriptionOverride
- 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.ExtendedDescription
- 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)