EmailAction Class

Represents an action that sends an e-mail.

  Note

Only available for Task Scheduler 2.0 on Windows Vista or Windows Server 2003 and later.

  Caution

This action has been deprecated in Windows 8 and later. However, this library is able to mimic its functionality using PowerShell if the PowerShellConversion property is set to All. To disable this conversion, set the value to Never.

Definition

Namespace: Microsoft.Win32.TaskScheduler
Assembly: Microsoft.Win32.TaskScheduler (in Microsoft.Win32.TaskScheduler.dll) Version: 2.11.1
[XmlTypeAttribute(IncludeInSchema = true)]
[XmlRootAttribute("SendEmail", Namespace = "http://schemas.microsoft.com/windows/2004/02/mit/task", 
	IsNullable = false)]
public sealed class EmailAction : Action
Inheritance
Object    Action    EmailAction

Remarks

The EmailAction allows for an email to be sent when the task is triggered.

Example

C#
EmailAction ea = new EmailAction("Task fired", "sender@email.com", "recipient@email.com", "You just got a message", "smtp.company.com");
ea.Bcc = "alternate@email.com";
ea.HeaderFields.Add("reply-to", "dh@mail.com");
ea.Priority = System.Net.Mail.MailPriority.High;
 // All attachement paths are checked to ensure there is an existing file
ea.Attachments = new object[] { "localpath\\ondiskfile.txt" };

Constructors

EmailActionCreates an unbound instance of EmailAction.
EmailAction(String, String, String, String, String)Creates an unbound instance of EmailAction.

Properties

ActionTypeGets the type of the action.
(Inherited from Action)
Attachments Gets or sets an array of file paths to be sent as attachments with the e-mail. Each item must be a String value containing a path to file.
BccGets or sets the e-mail address or addresses that you want to Bcc in the e-mail.
BodyGets or sets the body of the e-mail that contains the e-mail message.
CcGets or sets the e-mail address or addresses that you want to Cc in the e-mail.
FromGets or sets the e-mail address that you want to send the e-mail from.
HeaderFieldsGets or sets the header information in the e-mail message to send.
IdGets or sets the identifier of the action.
(Inherited from Action)
PriorityGets or sets the priority of the e-mail message.
ReplyToGets or sets the e-mail address that you want to reply to.
ServerGets or sets the name of the server that you use to send e-mail from.
SubjectGets or sets the subject of the e-mail.
ToGets or sets the e-mail address or addresses that you want to send the e-mail to.

Methods

CloneCreates a new object that is a copy of the current instance.
(Inherited from Action)
CompareTo Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.
(Inherited from Action)
DisposeReleases all resources used by this class.
(Inherited from Action)
Equals(Action)Indicates whether the current object is equal to another object of the same type.
(Overrides ActionEquals(Action))
Equals(Object)Determines whether the specified Object, is equal to this instance.
(Inherited from Action)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetHashCodeReturns a hash code for this instance.
(Inherited from Action)
GetTypeGets the Type of the current instance.
(Inherited from Object)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
ToStringGets a string representation of the EmailAction.
(Overrides ActionToString)
ToString(CultureInfo)Returns a String that represents this action.
(Inherited from Action)

Events

PropertyChangedOccurs when a property value changes.
(Inherited from Action)

Fields

unboundValuesList of unbound values when working with Actions not associated with a registered task.
(Inherited from Action)

See Also