MailDefinition.CreateMailMessage Method (String, IDictionary, Control)

Note: This method is new in the .NET Framework version 2.0.

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
)
public MailMessage CreateMailMessage (
	String recipients, 
	IDictionary replacements, 
	Control owner
)
public function CreateMailMessage (
	recipients : String, 
	replacements : IDictionary, 
	owner : Control
) : MailMessage

Parameters

recipients

A comma-separated list of message recipients.

replacements

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

owner

The Control that owns this MailDefinition.

Return Value

A new MailMessage object.

Exception typeCondition

ArgumentException

replacements does not contain strings.

HttpException

The From value in the SMTP section of the configuration file is a null reference (Nothing in Visual Basic) or the empty string

- or -

recipients contains an incorrect e-mail address.

ArgumentNullException

owner is a null reference (Nothing in Visual Basic).

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 (System.Web.Mail.MailFormat.Text) or HTML (System.Web.Mail.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.

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0

Community Additions

ADD
Show: