/
MailMessageEventArgs.xml
131 lines (117 loc) · 8.88 KB
/
MailMessageEventArgs.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
<Type Name="MailMessageEventArgs" FullName="System.Web.UI.WebControls.MailMessageEventArgs">
<TypeSignature Language="C#" Value="public class MailMessageEventArgs : System.Web.UI.WebControls.LoginCancelEventArgs" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit MailMessageEventArgs extends System.Web.UI.WebControls.LoginCancelEventArgs" />
<TypeSignature Language="DocId" Value="T:System.Web.UI.WebControls.MailMessageEventArgs" />
<TypeSignature Language="VB.NET" Value="Public Class MailMessageEventArgs
Inherits LoginCancelEventArgs" />
<TypeSignature Language="F#" Value="type MailMessageEventArgs = class
 inherit LoginCancelEventArgs" />
<TypeSignature Language="C++ CLI" Value="public ref class MailMessageEventArgs : System::Web::UI::WebControls::LoginCancelEventArgs" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Web.UI.WebControls.LoginCancelEventArgs</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Provides data for email-related events.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Web.UI.WebControls.MailMessageEventArgs> class provides access to the <xref:System.Web.Mail.MailMessage> object that contains the email message. Because the <xref:System.Web.UI.WebControls.MailMessageEventArgs> class is derived from the <xref:System.Web.UI.WebControls.LoginCancelEventArgs> class, you can cancel sending an email message in your event handler by setting the <xref:System.Web.UI.WebControls.LoginCancelEventArgs.Cancel%2A> property to `true`.
## Examples
The following code example demonstrates how to use the <xref:System.Web.UI.WebControls.MailMessageEventArgs> class in an email message event handler to change the contents of the message before it is sent.
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/PasswordRecoveryOnBeforeSendMail/CS/passwordrecoveryonbeforesendmailcs.aspx" id="Snippet1":::
:::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/PasswordRecoveryOnBeforeSendMail/VB/passwordrecoveryonbeforesendmailvb.aspx" id="Snippet1":::
]]></format>
</remarks>
<altmember cref="T:System.Web.UI.WebControls.Login" />
<altmember cref="T:System.Web.UI.WebControls.CreateUserWizard" />
<altmember cref="T:System.Web.UI.WebControls.PasswordRecovery" />
<related type="Article" href="https://docs.microsoft.com/previous-versions/aspnet/ms178329(v=vs.100)">ASP.NET Login Controls Overview</related>
<related type="Article" href="https://docs.microsoft.com/previous-versions/aspnet/ms178346(v=vs.100)">Securing Login Controls</related>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public MailMessageEventArgs (System.Net.Mail.MailMessage message);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Net.Mail.MailMessage message) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.WebControls.MailMessageEventArgs.#ctor(System.Net.Mail.MailMessage)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (message As MailMessage)" />
<MemberSignature Language="F#" Value="new System.Web.UI.WebControls.MailMessageEventArgs : System.Net.Mail.MailMessage -> System.Web.UI.WebControls.MailMessageEventArgs" Usage="new System.Web.UI.WebControls.MailMessageEventArgs message" />
<MemberSignature Language="C++ CLI" Value="public:
 MailMessageEventArgs(System::Net::Mail::MailMessage ^ message);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<Parameters>
<Parameter Name="message" Type="System.Net.Mail.MailMessage" />
</Parameters>
<Docs>
<param name="message">The <see cref="T:System.Net.Mail.MailMessage" /> containing the message.</param>
<summary>Creates a new instance of the <see cref="T:System.Web.UI.WebControls.MailMessageEventArgs" /> class.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Create a new instance of the <xref:System.Web.UI.WebControls.MailMessageEventArgs> class when you want to pass a <xref:System.Net.Mail.MailMessage> object to an event handler that might modify the message before sending it.
]]></format>
</remarks>
<altmember cref="T:System.Web.UI.WebControls.Login" />
<altmember cref="T:System.Web.UI.WebControls.CreateUserWizard" />
<altmember cref="T:System.Web.UI.WebControls.PasswordRecovery" />
<related type="Article" href="https://docs.microsoft.com/previous-versions/aspnet/ms178329(v=vs.100)">ASP.NET Login Controls Overview</related>
</Docs>
</Member>
<Member MemberName="Message">
<MemberSignature Language="C#" Value="public System.Net.Mail.MailMessage Message { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Net.Mail.MailMessage Message" />
<MemberSignature Language="DocId" Value="P:System.Web.UI.WebControls.MailMessageEventArgs.Message" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Message As MailMessage" />
<MemberSignature Language="F#" Value="member this.Message : System.Net.Mail.MailMessage" Usage="System.Web.UI.WebControls.MailMessageEventArgs.Message" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Net::Mail::MailMessage ^ Message { System::Net::Mail::MailMessage ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Net.Mail.MailMessage</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the email message contents.</summary>
<value>A <see cref="T:System.Web.Mail.MailMessage" /> containing the message contents.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Web.UI.WebControls.MailMessageEventArgs.Message%2A> property returns the <xref:System.Web.Mail.MailMessage> object that contains the email message data. The <xref:System.Web.UI.WebControls.MailMessageEventArgs.Message%2A> property is read-only; however, you can use the <xref:System.Web.Mail.MailMessage> object that it returns to modify the properties of the email message.
## Examples
The following code example demonstrates how to use the <xref:System.Web.UI.WebControls.MailMessageEventArgs.Message%2A> property in an email message event handler to change the contents of the message before it is sent.
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/PasswordRecoveryOnBeforeSendMail/CS/passwordrecoveryonbeforesendmailcs.aspx" id="Snippet1":::
:::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/PasswordRecoveryOnBeforeSendMail/VB/passwordrecoveryonbeforesendmailvb.aspx" id="Snippet1":::
]]></format>
</remarks>
<altmember cref="T:System.Web.UI.WebControls.MailMessageEventHandler" />
<altmember cref="E:System.Web.UI.WebControls.PasswordRecovery.SendingMail" />
<altmember cref="T:System.Web.UI.WebControls.Login" />
<altmember cref="T:System.Web.UI.WebControls.CreateUserWizard" />
<altmember cref="T:System.Web.UI.WebControls.PasswordRecovery" />
<related type="Article" href="https://docs.microsoft.com/previous-versions/aspnet/ms178329(v=vs.100)">ASP.NET Login Controls Overview</related>
</Docs>
</Member>
</Members>
</Type>