MailDefinition::CreateMailMessage Method (String^, IDictionary^, Control^)

 

Creates an e-mail message from a text file to send by means of SMTP (Simple Mail Transfer Protocol).

Namespace:   System.Web.UI.WebControls
Assembly:  System.Web (in System.Web.dll)

public:
MailMessage^ CreateMailMessage(
	String^ recipients,
	IDictionary^ replacements,
	Control^ owner
)

Parameters

recipients
Type: System::String^

A comma-separated list of message recipients.

replacements
Type: System.Collections::IDictionary^

An IDictionary containing a list of strings and their replacement strings.

owner
Type: System.Web.UI::Control^

The Control that owns this MailDefinition.

Return Value

Type: System.Net.Mail::MailMessage^

The e-mail message from a text file.

Exception Condition
ArgumentException

replacements does not contain strings.

HttpException

The From value in the SMTP section of the configuration file is null or the empty string

- or -

recipients contains an incorrect e-mail address.

ArgumentNullException

owner is null.

The CreateMailMessage method creates a new MailMessage object that can be sent using the SmtpClient::Send method.

The BodyFormat property must be set to indicate whether the mail message should be formatted as plain text (MailFormat::Text) or HTML (MailFormat::Html).

The recipients parameter contains a comma-separated list of recipients of the e-mail message. If the recipients parameter contains an improperly formatted Internet e-mail address, the Send method throws an HttpException exception and the e-mail message is not sent.

The replacements parameter is an IDictionary instance that contains a list of strings to substitute. Strings are replaced in the order in which they were added to the IDictionary collection, and they can overwrite earlier replacements.

The owner parameter indicates which control is the parent of the MailDefinition control. It determines which directory to search for the text file specified in the BodyFileName property.

The following code example creates a ListDictionary object that defines two strings ("<%To%>" and "<%From%>") that are replaced in the e-mail message.

This code example is part of a larger example provided for the MailDefinition class.

No code example is currently available or this language may not be supported.

The following code example uses the CreateMailMessage method to create a new e-mail message from a text file.

This code example is part of a larger example provided for the MailDefinition class.

No code example is currently available or this language may not be supported.

.NET Framework
Available since 2.0
Return to top
Show: