EmbeddedMailObjectsCollection Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Represents an ordered set of EmbeddedMailObject objects.
public ref class EmbeddedMailObjectsCollection sealed : System::Collections::CollectionBasepublic sealed class EmbeddedMailObjectsCollection : System.Collections.CollectionBasetype EmbeddedMailObjectsCollection = class
inherit CollectionBasePublic NotInheritable Class EmbeddedMailObjectsCollection
Inherits CollectionBase- Inheritance
Examples
The following code example demonstrates an ASP.NET page that uses a ChangePassword Web control, and includes an event handler for the SendingMail event named SendingMail. The code example assumes that the ASP.NET Web site has been configured to use ASP.NET membership and Forms authentication, and that a user has been created whose name and password are known to you. For more information, see How to: Implement Simple Forms Authentication.
If the password change succeeds, the code in the SendingMail event handler attempts to send an email message to the user to confirm the change. SMTP must already be configured on the server in order for this code example to work. For information about how to configure an SMTP server, see How to: Install and Configure SMTP Virtual Servers in IIS 6.0. For the purposes of this example, it is not necessary to configure an SMTP server; the example is constructed to test for a failure to send an email message.
If a mail server is not configured correctly or some other error occurs and the email message cannot be sent, the SendMailError function is called. A message is displayed to the user. In addition, an event is logged to the Windows Application event log with the assumption that an event source named MySamplesSite already exists. See the code example below to create the specified event source. For more information about creating an event source, see Server Event Handling in ASP.NET Web Forms Pages. The Handled property of the SendMailErrorEventArgs object is set to true to indicate that the error has been handled.
<%@ Page Language="C#" AutoEventWireup="True" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">
void MySendingMail(object sender, MailMessageEventArgs e)
{
Message1.Text = "Sent mail to you to confirm the password change.";
}
void MySendMailError(object sender, SendMailErrorEventArgs e)
{
Message1.Text = "Could not send email to confirm password change.";
// The MySamplesSite event source has already been created by an administrator.
System.Diagnostics.EventLog myLog = new System.Diagnostics.EventLog();
myLog.Log = "Application";
myLog.Source = "MySamplesSite";
myLog.WriteEntry(
"Sending mail via SMTP failed with the following error: " +
e.Exception.Message.ToString(),
System.Diagnostics.EventLogEntryType.Error);
e.Handled = true;
}
</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
<title>ChangePassword including a SendMailError Event</title>
</head>
<body>
<form id="form1" runat="server">
<div style="text-align:center">
<h1>ChangePassword</h1>
<asp:LoginView ID="LoginView1" Runat="server"
Visible="true">
<LoggedInTemplate>
<asp:LoginName ID="LoginName1" Runat="server" FormatString="You are logged in as {0}." />
<br />
</LoggedInTemplate>
<AnonymousTemplate>
You are not logged in
</AnonymousTemplate>
</asp:LoginView><br />
<asp:ChangePassword ID="ChangePassword1" Runat="server"
BorderStyle="Solid"
BorderWidth="1"
CancelDestinationPageUrl="~/Default.aspx"
DisplayUserName="true"
OnSendingMail="MySendingMail"
OnSendMailError="MySendMailError"
ContinueDestinationPageUrl="~/Default.aspx" >
<MailDefinition
BodyFileName="~\MailFiles\ChangePasswordMail.htm"
Subject="Activity information for you">
<EmbeddedObjects>
<asp:EmbeddedMailObject Name="LoginGif" Path="~\MailFiles\Login.gif" />
<asp:EmbeddedMailObject Name="PrivacyNoticeTxt" Path="~\MailFiles\PrivacyNotice.txt" />
</EmbeddedObjects>
</MailDefinition>
</asp:ChangePassword><br />
<asp:Label ID="Message1" Runat="server" ForeColor="Red" /><br />
<asp:HyperLink ID="HyperLink1" Runat="server"
NavigateUrl="~/Default.aspx">
Home
</asp:HyperLink>
</div>
</form>
</body>
</html>
<%@ Page Language="VB" AutoEventWireup="True" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">
Public Sub MySendingMail(ByVal Sender As Object, ByVal e As MailMessageEventArgs)
Message1.Text = "Sent mail to you to confirm the password change."
End Sub
Public Sub MySendMailError(ByVal Sender As Object, ByVal e As SendMailErrorEventArgs)
Message1.Text = "Could not send mail to confirm the password change."
' The MySamplesSite event source has already been created by an administrator.
Dim myLog As System.Diagnostics.EventLog
myLog = new System.Diagnostics.EventLog
myLog.Log = "Application"
myLog.Source = "MySamplesSite"
myLog.WriteEntry("Sending mail via SMTP failed with the following error: " & e.Exception.Message.ToString(), System.Diagnostics.EventLogEntryType.Error)
e.Handled = True
End Sub
</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
<title>ChangePassword including a SendMailError Event</title>
</head>
<body>
<form id="form1" runat="server">
<div style="text-align:center">
<h1>ChangePassword</h1>
<asp:LoginView ID="LoginView1" Runat="server"
Visible="true">
<LoggedInTemplate>
<asp:LoginName ID="LoginName1" Runat="server" FormatString="You are logged in as {0}." />
<br />
</LoggedInTemplate>
<AnonymousTemplate>
You are not logged in
</AnonymousTemplate>
</asp:LoginView><br />
<asp:ChangePassword ID="ChangePassword1" Runat="server"
BorderStyle="Solid"
BorderWidth="1"
CancelDestinationPageUrl="~/Default.aspx"
DisplayUserName="true"
OnSendingMail="MySendingMail"
OnSendMailError="MySendMailError"
ContinueDestinationPageUrl="~/Default.aspx" >
<MailDefinition
BodyFileName="~\MailFiles\ChangePasswordMail.htm"
Subject="Activity information for you">
<EmbeddedObjects>
<asp:EmbeddedMailObject Name="LoginGif" Path="~\MailFiles\Login.gif" />
<asp:EmbeddedMailObject Name="PrivacyNoticeTxt" Path="~\MailFiles\PrivacyNotice.txt" />
</EmbeddedObjects>
</MailDefinition>
</asp:ChangePassword><br />
<asp:Label ID="Message1" Runat="server" ForeColor="Red" /><br />
<asp:HyperLink ID="HyperLink1" Runat="server"
NavigateUrl="~/Default.aspx">
Home
</asp:HyperLink>
</div>
</form>
</body>
</html>
Use the following code example if you need to programmatically add the event source named MySamplesSite to your Application log. This event source must exist in order for the first code example to work correctly. The following code example requires Administrator privileges.
#region Using directives
using System;
using System.Collections.Generic;
using System.Text;
using System.Diagnostics;
#endregion
namespace CreateEventSource
{
class Program
{
static void Main(string[] args)
{
try
{
// Create the source, if it does not already exist.
if (!EventLog.SourceExists("MySamplesSite"))
{
EventLog.CreateEventSource("MySamplesSite", "Application");
Console.WriteLine("Creating Event Source");
}
// Create an EventLog instance and assign its source.
EventLog myLog = new EventLog();
myLog.Source = "MySamplesSite";
// Write an informational entry to the event log.
myLog.WriteEntry("Testing writing to event log.");
Console.WriteLine("Message written to event log.");
}
catch (Exception e)
{
Console.WriteLine("Exception:");
Console.WriteLine("{0}", e.ToString());
}
}
}
}
Imports System.Collections.Generic
Imports System.Text
Imports System.Diagnostics
Namespace CreateEventSource
Class Program
Sub Main()
Try
' Create the source, if it does not already exist.
If Not (EventLog.SourceExists("MySamplesSite")) Then
EventLog.CreateEventSource("MySamplesSite", "Application")
Console.WriteLine("Creating Event Source")
End If
' Create an EventLog instance and assign its source.
Dim myLog As New EventLog
myLog.Source = "MySamplesSite"
' Write an informational entry to the event log.
myLog.WriteEntry("Testing writing to event log.")
Console.WriteLine("Message written to event log.")
Catch e As Exception
Console.WriteLine("Exception:")
Console.WriteLine(e.ToString)
End Try
End Sub
End Class
End Namespace
The following example code can be used as the ChangePasswordMail.htm file for the preceding example code.
Important
Sending user account names or passwords in email is a potential security threat. Email messages are typically sent in plain text and can be read by special network "sniffing" applications. To improve security, use the mitigations that are described in Securing Login Controls.
<html>
<head><title></title></head>
<body>
<form>
<h1>Your password for the account named "<%Username%>" has changed.</h1>
<p>
If you did not initiate this change, please call 1-206-555-0100.
</p>
<p>
<a href="http://www.contoso.com/login.aspx">
<img src="cid:LoginGif" alt="Log In" />
</a>
</p>
<p>
Please read our attached Privacy Notice.
</p>
</form>
</body>
</html>
Remarks
The EmbeddedMailObjectsCollection stores references to items that will be embedded in an email message. The embedded items can be image files such as company logos. The EmbeddedMailObjectsCollection is used by the EmbeddedObjects property of the MailDefinition object.
Email messages that allow embedded objects are configurable in the following Web controls by setting their MailDefinition properties declaratively:
Note
The values in the EmbeddedMailObject and EmbeddedMailObjectsCollection objects are not stored in view state. This protects against malicious users discovering path information for your server.
Constructors
| EmbeddedMailObjectsCollection() |
Initializes a new instance of the EmbeddedMailObjectsCollection class. |
Properties
| Capacity |
Gets or sets the number of elements that the CollectionBase can contain. (Inherited from CollectionBase) |
| Count |
Gets the number of elements contained in the CollectionBase instance. This property cannot be overridden. (Inherited from CollectionBase) |
| InnerList |
Gets an ArrayList containing the list of elements in the CollectionBase instance. (Inherited from CollectionBase) |
| Item[Int32] |
Returns a specific element of a EmbeddedMailObjectsCollection, identified by its position. |
| List |
Gets an IList containing the list of elements in the CollectionBase instance. (Inherited from CollectionBase) |
Methods
| Add(EmbeddedMailObject) |
Adds an EmbeddedMailObject to the end of the EmbeddedMailObjectsCollection collection. |
| Clear() |
Removes all objects from the CollectionBase instance. This method cannot be overridden. (Inherited from CollectionBase) |
| Contains(EmbeddedMailObject) |
Determines whether the EmbeddedMailObjectsCollection contains a specific EmbeddedMailObject. |
| CopyTo(EmbeddedMailObject[], Int32) |
Copies the collection objects to a one-dimensional Array instance beginning at the specified index in the array. |
| Equals(Object) |
Determines whether the specified object is equal to the current object. (Inherited from Object) |
| GetEnumerator() |
Returns an enumerator that iterates through the CollectionBase instance. (Inherited from CollectionBase) |
| GetHashCode() |
Serves as the default hash function. (Inherited from Object) |
| GetType() |
Gets the Type of the current instance. (Inherited from Object) |
| IndexOf(EmbeddedMailObject) |
Determines the index of a specific EmbeddedMailObject in the EmbeddedMailObjectsCollection. |
| Insert(Int32, EmbeddedMailObject) |
Inserts an EmbeddedMailObject into the EmbeddedMailObjectsCollection object at the specified index position. |
| MemberwiseClone() |
Creates a shallow copy of the current Object. (Inherited from Object) |
| OnClear() |
Performs additional custom processes when clearing the contents of the CollectionBase instance. (Inherited from CollectionBase) |
| OnClearComplete() |
Performs additional custom processes after clearing the contents of the CollectionBase instance. (Inherited from CollectionBase) |
| OnInsert(Int32, Object) |
Performs additional custom processes before inserting a new element into the CollectionBase instance. (Inherited from CollectionBase) |
| OnInsertComplete(Int32, Object) |
Performs additional custom processes after inserting a new element into the CollectionBase instance. (Inherited from CollectionBase) |
| OnRemove(Int32, Object) |
Performs additional custom processes when removing an element from the CollectionBase instance. (Inherited from CollectionBase) |
| OnRemoveComplete(Int32, Object) |
Performs additional custom processes after removing an element from the CollectionBase instance. (Inherited from CollectionBase) |
| OnSet(Int32, Object, Object) |
Performs additional custom processes before setting a value in the CollectionBase instance. (Inherited from CollectionBase) |
| OnSetComplete(Int32, Object, Object) |
Performs additional custom processes after setting a value in the CollectionBase instance. (Inherited from CollectionBase) |
| OnValidate(Object) |
Performs additional custom processes when validating a value. (Inherited from CollectionBase) |
| Remove(EmbeddedMailObject) |
Removes the first occurrence of the specified EmbeddedMailObject from the EmbeddedMailObjectsCollection. |
| RemoveAt(Int32) |
Removes the element at the specified index of the CollectionBase instance. This method is not overridable. (Inherited from CollectionBase) |
| ToString() |
Returns a string that represents the current object. (Inherited from Object) |
Explicit Interface Implementations
| ICollection.CopyTo(Array, Int32) |
Copies the entire CollectionBase to a compatible one-dimensional Array, starting at the specified index of the target array. (Inherited from CollectionBase) |
| ICollection.IsSynchronized |
Gets a value indicating whether access to the CollectionBase is synchronized (thread safe). (Inherited from CollectionBase) |
| ICollection.SyncRoot |
Gets an object that can be used to synchronize access to the CollectionBase. (Inherited from CollectionBase) |
| IList.Add(Object) |
Adds an object to the end of the CollectionBase. (Inherited from CollectionBase) |
| IList.Contains(Object) |
Determines whether the CollectionBase contains a specific element. (Inherited from CollectionBase) |
| IList.IndexOf(Object) |
Searches for the specified Object and returns the zero-based index of the first occurrence within the entire CollectionBase. (Inherited from CollectionBase) |
| IList.Insert(Int32, Object) |
Inserts an element into the CollectionBase at the specified index. (Inherited from CollectionBase) |
| IList.IsFixedSize |
Gets a value indicating whether the CollectionBase has a fixed size. (Inherited from CollectionBase) |
| IList.IsReadOnly |
Gets a value indicating whether the CollectionBase is read-only. (Inherited from CollectionBase) |
| IList.Item[Int32] |
Gets or sets the element at the specified index. (Inherited from CollectionBase) |
| IList.Remove(Object) |
Removes the first occurrence of a specific object from the CollectionBase. (Inherited from CollectionBase) |
Extension Methods
| Cast<TResult>(IEnumerable) |
Casts the elements of an IEnumerable to the specified type. |
| OfType<TResult>(IEnumerable) |
Filters the elements of an IEnumerable based on a specified type. |
| AsParallel(IEnumerable) |
Enables parallelization of a query. |
| AsQueryable(IEnumerable) |
Converts an IEnumerable to an IQueryable. |
