aspNetEmail

EmailMessage Members

EmailMessage overview

Public Static Properties

MSXReceiver The X-Receiver line written to the MS Pickup Files.
MSXSender The X-Sender line written to the MS Pickup Files.

Public Static Methods

DeSerializeOverloaded. Deserializes a previously serialized EmailMessage, from a XML file, into a new EmailMessage object.
FireandForget A OneWay method that executes a .Send() method asynchronously on the EmailMessage object.
FormToDataTableOverloaded. Converts an ASP.NET/HTML form to a DataTable that can be used for a MailMerge
HtmlToPlainText Converts a HTML formatted string to a formatted plain text string.
LoadLicenseFileLoads a license file, based upon a fileystem path.
LoadLicenseResourceOverloaded. Loads a license that was embedded as a resource.
LoadLicenseStream Loads the license from a System.IO.Stream
LoadLicenseStringLoads a license file, from a properly formatted Xml license string.
ParseOverloaded. Parses a RFC2822 formatted message sting into an EmailMessage
ParseBinaryOverloaded. Parses a RFC2822 formatted byte array into an EmailMessage
ParseFileOverloaded. Parses a RFC2822 formatted file into an EmailMessage
ParseSteam This method has been depreciated. Use ParseStream( stream ) instead.
ParseStreamOverloaded. Parses a RFC2822 formatted message stream into an EmailMessage
SendOverloaded. A static/shared method for sending email.
SendASPNETExceptionOverloaded. Formats and sends the base ASP.NET exception. Useful to administrators and developers who monitor their ASP.NET web applications.
SendHtml A static/shared method for sending a HTML formatted email.
SendWebPage A static/shared method for emailing a webpage.

Public Instance Constructors

EmailMessageOverloaded. Initializes a new instance of the EmailMessage class.

Public Instance Properties

AltText Sets the preamble text for a mime formatted email message.
Attachments An ArrayList of Attachments
BaseEFN Base Email FileName used when an email is sent to the filesystem, during a mailmerge.
Bcc Allows you to easily set the EmailMessage.Bcc property of an email without having to use the EmailMessge.AddBcc() method.
Body The email message body contents.
BodyFormat The Format of the body, either HTML formatted or TEXT formatted.
Boundary Gets or Sets the boundary for parts of the email.
CancelMailMerge This property has been depreciated in favor of the Cancel property on the MergedRowSentEventArgs class.
Cc Allows you to easily set the EmailMessage.Cc property of an email without having to use the EmailMessge.AddCc() method.
CharSet Set a Custom Character set.
CharSetHeader Set a Custom Character set used in header encoding, according to RFC2047.
CheckNewLines Verifies that all newline characters (13) have are preceded by a carriage return (10). Also checks headers to be sure they do not have newline characters in them.
ConfirmRead Confirms that an email has been read.
ContentLocation Content location of the EmailMessage object.
ContentTransferEncoding ContentTransferEncoding sets the encoding for the email.
ContentType The Content-type of the email, for example text/html; or text/plain;.
Date Overrides the Date set in the mail header.
EmbeddedObjects An ArrayList of EmbeddedObjects or Images.
ForceHeaderEncoding Forces headers to be encoded, even if all of the characters in the header are an ascii value less than 127.
From The 'FROM' address (and name) of the sender
FromAddress The From Address of an email, for example: john@smith.com
FromName The From Name of an email. For example: John Smith.
HeaderEncoding The type of encoding to be used in the email headers.
HtmlBodyPart The HTML mime body part of a Multi-Part email.
IgnoreRecipientErrors Ignores any mail addressing errors as returned from the mail server.
IMailHost Overrides the default value for the IMail Host value found in the Q File.
IMailSpoolDirectory Sets or retrieves the spool directory, used by IPSwitch IMail mail server.
Importance Sets the Importance flag for the mail header, of the message sent.
InternalEncoding The internal encoding used to convert text to the Quoted-Printable or Base64 format. This property should NOT be modified, and is exposed for use in extreme cases.
InternalEncodingHeader The internal encoding used to convert header text to the Quoted-Printable or Base64 format. This property should NOT be modified, and is exposed for use in extreme cases.
IsConnected Used to check if the connection is open to the SMTP server.
LocalEndPoint The localhost endpoint to use as the network origin for sending email.
LogBody When logging is turned on, LogBody can log or ignore the body of the email to the log file.
LogDebugStatements Adds additional debugging statements to the log.
LogExceptionToEventLog Setting ExceptionsToAppLog will log any exceptions to the windows application event log.
Logging True or False, turns logging on or off for troubleshooting purposes.
LogInMemory When logging is enabled, by default, a log is kept in memory.
LogOverwriteOverwrite the log file during each program execution.
LogPath Path to the text log file.
MailMergeReconnectAttempts The number of times aspNetEmail should reconnect, if the SMTP session times out, during a mail merge.
MailMergeReconnectDelay The number of milliseconds aspNetEmail should wait between reconnection attempts
MailMergeSuccess MailMergeSuccess contains an ArrayList of all email addresses that were successfully sent during a MailMerge.
MessageId Sets the MessageId of the email.
MimeBodyParts The ArrayList of individual MimeBodyParts
MMPrefix The beginning characters the designate a mail merge field.
MMSuffix The ending characters that designate a mail merge field.
MSPickupDirectory Sets or retrieves the pickup directory for Microsoft's queue directory.
MSPickupDotStuff This poperty compensates for a bug in the IIS SMTP Server where it removes any periods "." (dots) from the begining of a line.
NetworkEncoding The System.Text.Encoding to be used during the network SMTP session of text translation to byte arrays.
Organization Sets an organization header in the email.
Password The password required by the mail server, this is set in conjunction with the EmailMessage.Username property.
Port The port of the relay mail server. By default, this value is 25.
Priority Sets the priority of the email.
PriorityMS Sets the X-MSMail-Priority flag of an email. Usually used by MS mail readers.
PriorityX Sets the X-Priority flag for the email message.
RawHeaders Advanced property to set any custom headers.
ReplyTo The optional Reply-To mail header.
ReturnReceipt Sets an optional mail read receipt to be notified when an email is recieved.
ReturnReceiptAddress By default, if ReturnReceipt = true, sends the receipts to this address.
ReversePath The reverse path is the actual 'Mail From' address presented to the relay SMTP server.
Sensitivity Sets the sensitivity of an email, as obeyed by Microsoft Outlook clients.
Server The MailServer to relay through.
SmartTimeOut Attempts to detect when an invalid or corrupt response is sent back from the SMTP Server, instead of waiting for the underlying socket to timeout.
SmtpAuthentication Authentication mechanism used against the SMTP server.
SmtpData Data sent to the SMTP server when the DATA command is issued.
SmtpGreeting Specifieds either EHLO or HELO greeting to the Mail Server.
SmtpHello The string used to say hello to the connecting mail server for relay. By default the property is the host name of the local computer.
SmtpHelloResponse The response of the SMTP server from the HELO/EHLO Command.
Subject The contents of the subject line of an email.
SynchronizingObject Gets or sets the object used to marshal event-handler calls that are issued.
TextBodyPart The text of the text/plain body part, of a mult-part mime formatted email.
ThrowException If set to true, this property will throw internal exceptions back to the calling program.
TimeOut The timeout, in milliseconds, to talk to the mail server. By default this setting is 20,000 for 20 seconds.
To Allows you to easily set the EmailMessage.To property of an email without having to use the EmailMessge.AddTo() method.
UndisclosedRecipient If all email addresses are set as Bcc, this line of text will appear in the To header of the email message.
Urgent Sets the Urgent flag for the mail header, of the message.
UrlContentBase Sets the url base of the email.
Username The username used when authentication is required by the mail server.
ValidateAddress Validates addresses before they are added to the To, Bcc, or Cc fields with the regular expression pattern set by ValidateRegEx.
ValidateRegEx The string pattern to be used for the Regular Expression matching of email addresses.
WordWrapLen Setting a value to word-wrap will wrap the body text for each line to this length.
XAccounting The XAccounting object used for sending faxes.
XHeaderArray Exposes the X-Headers as a string array.
XHeaders A NameValue collection of XHeaders.
XMailer Sets the X-Mailer flag for the email header.
XRCPTTO Sets the X-RCPT-TO header of the email address.

Public Instance Methods

AddAttachmentOverloaded. Adds a previously created attachment.
AddBcc Adds a blind carbon copied recipient to a MailMessage.
AddCalendarOverloaded. Creates an iCalendar object based upon the 'To' and 'From' properties of the EmailMessage object.
AddCcOverloaded. Adds an email address to be Cc'd.
AddHeader Adds a custom header to the email header.
AddMimeBodyPart Adds a Mime formatted body part to the EmailMessage object.
AddToOverloaded. Adds a 'TO' recipient to a MailMessage.
AddvCard Adds a vCard to the EmailMessage object.
AddXHeader Adds a custom x-header to the email header.
AppendBodyFromFileOverloaded. Appends the contents of a text or html file to the body.
AppendBodyFromUrlOverloaded. This method scrapes the HTML from a specified URL.
AppendControlToBodyOverloaded. This method accepts an instance of a control inherited from System.Web.UI.Control and renders it to the email body.
Base64EncodeOverloaded. A utility function used for encoding a Byte array to a base64 encoded string, according to RFC standards.
BeginSend Begins an asynchronous request to send an email.
BeginSendMailMerge Begins an asynchronous request so send a mail merge.
BeginSendMailMergeToIMailQueue Begins an asynchronous request so send a mail merge.
BeginSendMailMergeToMSPickup Begins an asynchronous request so send a mail merge.
ClearAttachments Clears all attachments of the MailMessage.
ClearBccs Clears the Bcc list of an EmailMessage.
ClearBody Clears the body contents of an EmailMessage.
ClearCalendarOverloaded. Removes a specific iCalendar from the EmailMessage object.
ClearCalendarsClears the EmailMessage object of all iCalendars.
ClearCcs Clears the Cc list of an EmailMessage.
ClearEmbeddedObjects Clears the Embedded Object collection.
ClearHeaders Clears all custom headers of an EmailMessage.
ClearMimeBodyPartOverloaded. Clears the mime body part at the specified index.
ClearMimeBodyParts Clears all existing mime body parts.
ClearRecipients Clears the Bcc, Cc, and To list of an EmailMessage.
ClearTos Clears the To list of an EmailMessage.
ClearvCard Removes a vCard, based upon it's filename.
ClearvCards Removes all vCards from the EmailMessage object.
ClearXHeaders Clears all custom headers of an EmailMessage.
Connect Open's the mail server network connection.
Disconnect Closes the mail server connections.
Dispose Releases the resources used by EmailMessage
EmbedImage EmbedImage will embed an image in a html email. By embedding an image, you will not need to link to the image externally. To reference an image from inside the html, follow the following examples.
EmbedObjectOverloaded. Embeds an object in the email.
EndSend Ends an asynchronous Send of an Email.
EndSendMailMerge Ends an asynchronous SendMailMerge of an Email.
EndSendMailMergeToIMailQueue Ends an asynchronous SendMailMergeToIMailQueue..
EndSendMailMergeToMSPickup Ends an asynchronous SendMailMergeToMSPickup..
Equals (inherited from Object)Determines whether the specified Object is equal to the current Object.
ExpirationDate If the component is an evaluation version, it returns a message containing the expiration date. If the component is not an evaluation version, it returns a message saying this is a functional version.
FormatExceptionOverloaded. Formats the last ASP.NET Error that occurred and creates an email report.
GetBodyFromFile This method will populate the body of the email with the contents from a text file. The file can either be pure text, or may contain HTML. If the file is a HTML file, you will want to set the BodyFormat property to 1 for HTML formatted email.
GetBodyFromURL Retrieve the text from any valid URL.
GetHashCode (inherited from Object)Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetLogOverloaded. If EmailMessage.Logging = True, and LogInMemoryLogInMemory = true, this returns the value of the troubleshooting Log.
GetType (inherited from Object)Gets the Type of the current instance.
Initialize Initializes the EmailMessage object.
IsValidEmail Validates an email address, based upon the regular expression pattern set with ValidateRegEx. Returns true, if the email address is syntactically correct, or false, if the email address is not matched by the regular expression
LastException If an internal error or exception occurred, it is checked by calling LastException()
LoadFromConfigOverloaded. Loads and sets email properties from the application configuration file.
LoadHtmlFormOverloaded. Automatically loads the values of a Html posted form into the body of an email.
LoadSslSocket Loads the SSL socket for SSL/TLS communication.
Noop Issues a NOOP (No Operation) SMTP command against the server.
ProcessASPNETForm Processes an ASP.NET form with specially named controls, for easy email sending.
Reconnect Reconnects a dropped SMTP connection.
SaveToFileOverloaded. Saves this email message to a file.
SaveToStream Saves the EmailMessage to a stream.
SendOverloaded. Sends the MailMessage through the Mail Server.
SendMailMergeOverloaded. SendMailMerge will send a mass amount of emails using a DataSet as a source of Mail Merge Data. Under the covers, SendMailMerge( DataSet MailMergeDataSet ) actually takes the first DataTable of the MailMergeDataSet and calls SendMailMerge( DataTable MailMergeData ).
SendMailMergeListOverloaded. Extracts a list of email addresses (each line must be a separate email address) from a file, and sends the EmailMessage to each address.
SendMailMergeListToIMailQueueOverloaded. Extracts a list of email addresses from a file, and the EmailMessage to each address.
SendMailMergeListToMSPickupOverloaded. Extracts a list of email addresses from a file, and the EmailMessage to each address.
SendMailMergeToIMailQueueOverloaded. Performs a mail merge, and writes an email directly to the spool directory used by IMail, thus by passing the SMTP layer.
SendMailMergeToMSPickupOverloaded. Performs a mail merge, from data found in the first DataTable of the dataset, and sends the resulting emails to the Microsoft SMTPsvc Pickup directory.
SendToIMailQueueOverloaded. Writes an email directly to the spool directory used by IMail, thus bypassing the SMTP layer.
SendToMSPickupOverloaded. Sends an email to Microsoft's Pickup queue directory.
SerializeOverloaded. Serializes this EmailMessage to a file.
ToAttachment Renders the EmailMessage object as an Attachment;
ToByteArray Converts the EmailMessage object to a byte array.
ToString Returns a string representation of the formatted EmailMessage
VersionNumber Returns the current version number of this component.
WriteLineToLog Logs a custom error message to the error log as a new line. Used only in debugging, and if Logging=true
WriteToLog Logs a custom error message to the error log. Used if Logging=true

Public Instance Events

BeforeEmailSend A BeforeEmailSend event has occurred.
BeforeQueueWrite A BeforeQueueWrite event has occurred.
BeforeRowMerge This event is raised before the EmailMessage object performs a mailmerge with a row of data.
BeforeSmtpSend A BeforeSmtpSend event has occurred.
Error A Error event has occurred.
MergedRowSent A MergedRowSent event has occurred.
MMProgress This event has been depreciated in favor of the MergedRowSentEvent
SmtpServerResponse The event for handling a response from the server.

Protected Instance Methods

Finalize Finalizes for aspNetEmail.
MemberwiseClone (inherited from Object)Creates a shallow copy of the current Object.
OnBeforeEmailSend Raises the BeforeEmailSend event.
OnBeforeQueueWrite Raises the BeforeQueueWrite event.
OnBeforeRowMerge Raises the BeforeRowMergeEvent event.
OnBeforeSmtpSend Raises the BeforeSmtpSend event.
OnError Raises the Error event.
OnMergedRowSent Raises the MergedRowSent event.
OnSmtpServerResponse Raises the SmtpServerResponse event.

See Also

EmailMessage Class | aspNetEmail Namespace