DotNetOpenMail A message which can be sent. Objects of a class which implements this interface can be converted to a string which can be used in an email. General Mail Exception, including network errors, connection errors, and configuration errors. Create an instance of a MailException Create an instance of a MailException The message describing the exception Create an instance of a MailException The message describing the exception The inner exception Summary description for LogMessage. Log a message The object logging the message The message to be logged The log message The sender object A mime representation of a file which can be transferred via email. This is an abstract version of the email attachment. It may or may not contain content, a character encoding method, a mime-encoding method, a content-type designation, a content-id designation, among other things The mail encoding type (e.g. quoted-printable, etc) The "content type" of the attachment The content-transfer encoding of the attachment The content disposition of the attachment The content description of the attachment The character set of the encoded text The unencoded contents, as a string (optional) An optional content id The file name to identify the content. (This can be different from the actual file name, if there was one.) The file source to read from The binary source of the file Empty constructor Get the contents, encoded for shipping via SMTP The encoder to encode the contents returns the encoded string, ready for SMTP transfer Return the encoded contents, including mime header. Create the internal mime header, as found on the mime-attachment itself. The encoding type for this attachment. The "content type" of the attachment The character set of the encoded text An optional content id that is used to refer to the attachment from elsewhere within a multipart/related email. The file name to attach to the attachment. The unencoded contents, as a string (optional) The raw bytes of the content (if this is the way it was set.) Create a new File attachment from a FileInfo object A fileinfo object which points to a local file. Create a new text file attachment from a StreamReader. An open streamreader Create a new binary file attachment from a BinaryReader. An open binaryreader Create a new binary file attachment from an array of bytes. An array of bytes Create a new file attachment from a String. The contents of the file Create a new File attachment with a contentid from a FileInfo object. The contentid will be used to refer to this attachment in another mime part of the email. A fileinfo object which points to a local file. the content id value Create a new file attachment from a StreamReader. The contentid will be used to refer to this attachment in another mime part of the email. An open streamreader the content id value Create a new file attachment from a BinaryReader. The contentid will be used to refer to this attachment in another mime part of the email. An open binary readerr the content id value Create a new file attachment from a byte array. The contentid will be used to refer to this attachment in another mime part of the email. An array of bytes the content id value Create a new text file attachment from a String. The contentid will be used to refer to this attachment in another mime part of the email. The contents of the file the content id value An email address. The two parts of the email address object are the email address itself and the name. The name may be encoded if desired. Create an instance of an email address object. The address portion of the email The name portion of the email. Create an instance of an email address object. The address portion of the email Create an character-encoded instance of an email address object. The address portion of the email The name portion of the email. The character set to encode the name portion of the email address. The encoding type to use to encode the name portion of the mail address. Create the string representation of this email address (encoded or otherwise) as it will appear in the email Calls ToDataString. The email address portion of the email address object The name portion of the email address object A mime representation of plain-text content. Create a new plain-text Attachment. It flags the content/type as "text/plain", uses Quoted Printable encoding by default, and uses the default character set, which is ISO-8859-1 unless otherwise specified in the .config file. Interact directly with the SMTP server. Open the connection The SMTP response Send the HELO command Send the EHLO command Send the MAIL FROM command Send one RCPT TO command Send the DATA command Write the message content Send the QUIT message to the server Close the connection The SMTP response Send the AUTH command the SMTP response Send any old string to the proxy the SMTP response Turn the SMTP Conversation Capture off/on. If on, GetSmtpConversation will contain the most recent conversation. the on/off value Denotes 8bit encoding. Note that this doesn't really encode anything; it just specifies that this email is already in 8-bit encoding. An encoder that does nothing. (This is essentially what the 7bit and 8bit encodings are; they are just markers, not actual encodings) An interface for a string encoder Encode from the stringreader to the stringwriter. an open stringreader to the source string where the output is written the outgoing charset Encode the file stream into the stringwriter. an open stream to file to be read where the output is written the outgoing charset Encode the binary reader into the stringwriter. an open binary reader for the data to be encoded. where the output is written Encode the string according to rfc-2047 if some of it falls outside the 7bit ASCII charset. The header key The header value string Charset for the encoded string Force encoding, even if in ascii-only. The encoded string The String that goes in the content transfer encoding header Empty constructor Echo the text back unchanged. Reader for the incoming string Writer for the outgoing string The encodigng for the outgoing string (ignored) Echo the text back unchanged The incoming filestream The outgoing filestream Charset (ignored) Echo the text back unchanged (good for 7bit text only). The incoming binaryreader The outgoing stream Do nothing to the header string The header key The header value The charset to encode in (ignored) (ignored) The String that goes in the content transfer encoding header Empty Constructor Create the EightBitEncoder object. The String that goes in the content transfer encoding header An Email Message Create a new instance of an EmailMessage. Add a To address to the Headers. This will also be used during the "RCPT TO" SMTP negotiation Email Address object of the recipient Add a To address to the Headers. This will also be used during the "RCPT TO" SMTP negotiation The plain email address (don't include the name) Add a Cc address to the Headers. This will also be used during the "RCPT TO" SMTP negotiation Email Address object of the recipient Add a Cc address to the Headers. This will also be used during the "RCPT TO" SMTP negotiation The plain email address (don't include the name) Add a recipient who will be "Blind Carbon Copied" as a recipient of the email. BCC addresses are not added to the email headers, but only appear during the "RCPT TO" SMTP negotiation. The EmailAddress object Add a recipient who will be "Blind Carbon Copied" as a recipient of the email. BCC addresses are not added to the email headers, but only appear during the "RCPT TO" SMTP negotiation. The plain email address (don't include the name) Add a custom mail header, e.g. "X-MyHeader". The header name (without a colon) The value of the header. This value will not be encoded. Get the minimal header set in the specified character, and using the mime encoder provided. Encode a header value using the current header encoder and charset. The header name The header value Returns true if there is content that should be "multipart/mixed" true if the content is multipart/mixed. Returns true if there is content that should be "multipart/related" true if the content is multipart/related. Encode the headers as they will appear in the email the charset encoding for the string the mime encoding the encoded string Encode the email body as it will appear in the email the encoded body format the body text---not implemented yet. Render the encoded message for smtp "DATA" transmission. This is the final version that will get sent to the Send out the email via the smtp server given. If the SMTP server throws an error, an SmtpException will be thrown. All other exceptions will be MailExceptions The outgoing SMTP server. true if sent successfully. (note that this will not currently return false, but in the future a false value may be used) Add an attachment which will appear to the user as a separate file. (It is not referred to in the email itself.) The file attachment Add an image which is referred to from another part of the email (probably the HTML attachment). You should set the ContentID of the file attachment before passing it in. The file attachment The subject line or subject header of the email. The address that appears in the From header. It will also be used as the Envelope From address in the SMTP negotiation, unless it is overridden by the EnvelopeFromAddress setting. Normally the FromAddress is used as the envelope-from address, but it can be overridden here, if it is not null. Retrieve the collection of recipients that will appear in the "To" header of the email. Retrieve the collection of recipients that will appear in the "Cc" header of the email. Get the current EmailAddressCollection of BCC addresses Get/set the organization (as it will appear in the organization header Get the current XMailer setting for the X-Mailer header. The charset that is used for encoding the headers The mime encoding that is used for encoding the headers The text that occurs within the body. By default, it is a MIME notice, but it can be overridden here. NOTE: This is only useful for 7 bit us-ascii currently. Set the content type string in the mime header Set the plain text part of the email. This is optional Set the html part of the email. This is optional An SmtpException represents an SMTP response code and an error message. Network and connection errors are represented by a MailException instead. Create a new instance of the SmtpException The SMTP error code Create a new instance of the SmtpException The SMTP error code The SMTP error message Create a new instance of the SmtpException The SMTP error code The SMTP error message The inner exception Convert to a string The SMTP error code. A full, preformatted email message, including headers Create an instance of the RawEmailMessage Add a recipient to the EmailAddressCollection of recipients Send the email via the specified SMTP server The SMTP server to use true if the email was sent Render the message for smtp "DATA" transmission. The rendered String, which in this case is the content itself, untouched. The raw content of the email The address to use in the envelope-from SMTP negotiation The recipient addresses A collection of MessageHeader objects Implements the CollectionBase interface. Initializes a new instance of the ArrayList class. Adds an object to the end of the MessageHeaderCollection The Object to be added to the end of the MessageHeaderCollection. The value can be a null reference (Nothing in Visual Basic). The MessageHeaderCollection index at which the value has been added. Returns the zero-based index of the first occurrence of a value in the MessageHeaderCollection or in a portion of it. The Object to locate in the MessageHeaderCollection. The value can be a null reference (Nothing in Visual Basic). Inserts an element into the MessageHeaderCollection at the specified index. The zero-based index at which value should be inserted The MessageHeader to insert. The value can be a null reference (Nothing in Visual Basic). Removes the first occurrence of a specific MessageHeader from the MessageHeaderCollection. The object to remove from the MessageHeaderCollection Write the MessageHeaderCollection to a string that can be included in an email. The String as it will appear in the resulting email. A proxy to access an SMTP server. This drives the protocol interaction. Get an instance of the SMTP Proxy Connect to the server and return the initial welcome string. Throw a MailException if we can't connect. Send the HELO string. Throw a MailException if we can't connect. the SMTP response Send the EHLO string. Throw a MailException if we can't connect. the SMTP response Send the MAIL FROM command Throw a MailException if we can't connect. The Envelope-From address the SMTP response Send the MAIL FROM command Throw a MailException if we can't connect. A recipient's address the SMTP response Send the DATA string (without the data) Throw a MailException if we can't connect. the SMTP response Send the message content string Throw a MailException if we can't connect. the SMTP response Parse the response from the EHLO into an EhloSmtpResponse. Returns 250 "OK" if successful. Send the AUTH command Throw a MailException if we can't connect. the SMTP response Send any old string to the proxy the SMTP response Write a string to the current connection. Send the QUIT command Throw a MailException if we can't connect. the SMTP response A proxy to access an SMTP server. This drives the protocol interaction. Set this to "true" if you want to capture the SMTP negotiation. Once the conversation has finished, use "GetConversation" to view it. The DotNetOpenMail Version. Empty Constructor Get the singleton of this class Get the current version info as a printable string. This will be of the form A.B.CD, where A is the majorid, B is the minor id, C is the incidental revision, and D is either "a", "b", "rcX" for "alpha", "beta" and "release candidate X", respectively. If it is the release version, D is blank. Parse a email address string into an EmailAddress. * This isn't very mature yet! * Constructor Parse a raw email address into an EmailAddress object. If it can't be parsed, return null and set LastError to the error message. If the last conversion was unsuccessful, this contains the error message. If it was successful, it will be null. Created: 2007-12-20 Last Modified: 2007-12-20 Based on the original SmtpProxy class but modified by Joe Audette to use Org.Mentalis.Security for SSL A proxy to access an SMTP server. This drives the protocol interaction. Get an instance of the SMTP Proxy Connect to the server and return the initial welcome string. Throw a MailException if we can't connect. Send the HELO string. Throw a MailException if we can't connect. the SMTP response Send the EHLO string. Throw a MailException if we can't connect. the SMTP response Send the MAIL FROM command Throw a MailException if we can't connect. The Envelope-From address the SMTP response Send the MAIL FROM command Throw a MailException if we can't connect. A recipient's address the SMTP response Send the DATA string (without the data) Throw a MailException if we can't connect. the SMTP response Send the message content string Throw a MailException if we can't connect. the SMTP response Parse the response from the EHLO into an EhloSmtpResponse. Returns 250 "OK" if successful. Send the AUTH command Throw a MailException if we can't connect. the SMTP response Send any old string to the proxy the SMTP response Write a string to the current connection. Send the QUIT command Throw a MailException if we can't connect. the SMTP response Created: 2007-12-20 Last Modified: 2007-12-20 Based on the original SmtpProxy class but modified by Joe Audette to use Org.Mentalis.Security for SSL A proxy to access an SMTP server. This drives the protocol interaction. Set this to "true" if you want to capture the SMTP negotiation. Once the conversation has finished, use "GetConversation" to view it. Create a RFC 2822-compliant date. See section 3.3 in http://ftp.rfc-editor.org/in-notes/rfc2822.txt Create an instance of the RFC 2822 date object. The date to convert The timezone to use in the conversion Generate the date string A RFC-2822 error code See: http://www.freesoft.org/CIE/RFC/1521/6.htm Maximum characters per line, before the end-of-line character The end-of-line character(s). Empty Constructor Create an instance of the encoder The instantiated Quoted-printable encoder Encode the incoming stream in quoted-printable encoding. The incoming binary reader The outgoing string writer Encode the incoming stream in quoted-printable encoding. The incoming file stream The outgoing string writer The charset to write the outgoing string in Encode the string in quoted printable format The source string The outgoing charset the encoded string Encode the string in quoted printable format The source string The outgoing charset Force encoding, even if not required by qp RFC The total characters outside the encoding. This is used to figure out how long the line will be after encoding. the encoded string Encode header as per RFC 2047: http://www.faqs.org/rfcs/rfc2047.html This doesn't split long lines yet the header name the string to encode The charset to encode to Force encoding, even if not required by qp RFC the encoded string, suitable for use in a header Encode a char according to quoted-printable standard the char to encode the encoded char representation Encode a byte according to quoted-printable standard the byte to encode the encoded byte representation Return true if the char needs to be encoded. Return true if the byte needs to be encoded. Return true if the string needs to be encoded. The string to check true if outside 127-bit, or one of the quoted-printable special characters. Check if the character is one of the non-qp characters the character to check true if outside the acceptable qp range The String that goes in the content transfer encoding header Enumeration of encoding types. The Quoted-Printable encoding The Base-65 encoding The 7Bit encoding marker The 8Bit encoding marker Token which will negotiate an authentication type with the server. Summary description for ISmtpAuthenticationToken. Negotiate AUTH with the SmtpProxy. The user's login The user's password Create a new instance of the LOCAL SMTP AUTH token Return the 235 response code if valid, otherwise return the error. The SmtpProxy being used String array of EHLO-specified auth types The User's password The User's login A LOCAL SMTP AUTH token Create a new instance of the LOCAL SMTP AUTH token Return the 235 response code if valid, otherwise return the error. the supported auth types The User's password The User's login A MIME container for content or other mime containers. A boundary which delimits a MIME object. An interface to the configuration settings for the library. This includes an interface to the .config file. This is a singleton. The singleton Empty constructor Instantiate the instance of the object (if not created) and return it. the Configuration singleton object Get the X-Sender header, if any is specified in the .config file with the key dnom.headers.xsender. Get the default encoding, if any is specified in the .config file with the key dnom.encoding. Get the default charset, if any is specified in the .config file with the key dnom.charset. Get an app setting from the .config file. If none is found or it is empty or only whitespace, use the defaultvalue. The key to search for in the .config file The default value if the value is null or only whitespace. SMTP server response codes and their meanings. System status, or system help reply. Help message. Domain service ready. Ready to start TLS. Domain service closing transmission channel. Authentication successfully completed. OK, queuing for node node started. Requested mail action completed. OK, no messages waiting for node node. User not local, will forward to forwardpath. OK, pending messages for node node started. Cannot VRFY user (e.g., info is not local), but will take message for this user and attempt delivery. OK, messages pending messages for node node started. Start mail input, end with CRLF.CRLF Octet-offset is the transaction offset. Domain service not available, closing transmission channel. A password transition is needed. Requested mail action not taken: mailbox unavailable. Requested action aborted: local error in processing. Unable to process ATRN request now. Requested action not taken: insufficient system storage. You have no mail. TLS not available. Encryption required for requested authentication mechanism. Unable to queue messages for node node. Node node not allowed: reason. Command not recognized: command. Syntax error. Syntax error, no parameters allowed. Command not implemented. Bad sequence of commands. Command parameter not implemented. Security error. Machine does not accept mail. Must issue a STARTTLS command first. Encryption required for requested authentication mechanism. Authentication mechanism is too weak. Encryption required for requested authentication mechanism. Requested action not taken: mailbox unavailable. User not local, please try forward path. Requested mail action aborted: exceeded storage allocation. Requested action not taken: mailbox name not allowed. Transaction failed. Factory for instantiating the right encoder class, given an encoding Empty Constructor. Method for determining the correct encoder for this encoding type. Enumerated encoding type Returns the proper IEncoder implementation Throws an ApplicationException if the specified encoding is unknown. The server response from EHLO Create an instance of the EhloSmtpResponse class Get the available Auth Types strings as reported by the server. (e.g. "login", etc.) Add an Auth type (by string as contained in the EHLO authentication. These are converted to lower case. The auth type from EHLO The SMTP Reponse code The SMTP Message. This will be "OK" if successful, otherwise it will be the part that failed. Something take a binary reader's data into a byte array. Constructor for BinaryReaderUtil Read a binary stream into a byte array (Cribbed from posting by Jon Skeet: http://www.developerfusion.co.uk/show/4696/) An open Binary Reader A byte array with the bytes from the disk Summary description for SmtpAuthHelper. Get the Auth type from the SMTP EHLO response. If it is unrecognized or unimplemented, return null. Case doesn't matter. The string as returned in EHLO negotiation. The user's login The User's password 2007-12-20 Joe Audette added useSsl property and code to support smtp over SSL Create a new SMTP server at this hostname and port. The address or hostname of the smtp server The port of the smtp server. Create a new SMTP server at this hostname and port. The address or hostname of the smtp server The port of the smtp server. Create a new SMTP server at this hostname and port. The address or hostname of the smtp server Create a new SMTP server at this hostname and port. The ip address of the SMTP server The port number of SMTP server Get the end point for the SMTP server. The IPEndpoint will be saved for later to prevent multiple hostname lookups. SmtpException is thrown if the host doesn't resolve. returns an IPEndPoint for the SMTPServer. Get an instance of an SmtpProxy Figure out whether we need EHLO or not. Currently, this is only for SMTP AUTH Send the email. The completed message A list of email addresses which are to be used in the RCPT TO SMTP communication An email address for the MAIL FROM part of the SMTP protocol. throws an SmtpException if there is an unexpected SMTP error number sent from the server. throws a MailException if there is a network problem, connection problem, or other issue. Override the SmtpProxy. This is only for testing smtp negotiation without an smtp server. Append this string to the conversation log. the string from the SMTP conversation If CaptureSmtpConversation is true, a Send() will be captured, and will be accessible here. The SMTP Conversation or null. Return the host name, a colon, and a port number. Handle a message about to be sent Handle a message received Log that the conversation has completed The timeout waiting for an SMTP command, in milliseconds Get or set the SMTP AUTH token for the server. If true, the following call to "Send" will capture the most recent SMTP conversation to the SmtpServer object. This is intended for debugging only. This is deprecated in favour of the log message events. The server hostname The server port Set the hostname used by the HELO command. Logging delegate Denotes 7bit encoding. Note that this doesn't really encode anything; it just specifies that this email is already in 7-bit ascii encoding. Empty constructor Create an instance of this class. The String that goes in the content transfer encoding header Encode a file in Base64 Encoding. See: http://www.freesoft.org/CIE/RFC/1521/7.htm The maximum chars per line before end of line char(s) The end-of-line character(s) to use Empty Constructor Create an instance of this class Encode the Stringreader's data in base64. Note: This is not particularly efficient on memory. This method should probably be improved to take advantage of the Reader, rather than taking the whole string into memory. Reader for incoming string Writer for outgoing encoded string The character encoding for the encoded string. Encode the File's data in base64. Reader for incoming string Writer for outgoing encoded string The character set for the encoded string Encode the File's data in base64. Reader for incoming string Writer for outgoing encoded string Encode a string in Base64 in a particular characters set The source text the charset for the encoded text Returns an encoded string Encode header as per RFC 2047: http://www.faqs.org/rfcs/rfc2047.html The header name The header text to be encoded (data only) The charset for the encoded string ignored for this class Returns the encoded string Chop the text into lines that are smaller than MAX_CHARS_PER_LINE The String that goes in the content transfer encoding header Summary description for Logger. Log event Return the singleton object Log a message with level "Info" Log a message with level "Debug" Log a message with level "Error" Log the output of sending smtp Log the reply via smtp Log handler delegate An HTML email attachment Create a new HTML Attachment. It flags the content/type as "text/html", uses Quoted Printable encoding by default, and uses the default character set, which is ISO-8859-1 unless otherwise specified in the .config file. The HTML content of the attachment The response from the SMTP server Create an instance of the SmtpResponse Convert this response to an exception The SmtpException corresponding to this response The SMTP Reponse code The SMTP Response String Was the response a fatal error? Was the response an OK message? A collection of EmailAddress objects. Implements CollectionBase Create a new instance of the EmailAddressCollection Add an object to the collection The EmailAddress object to add Append a collection of objects to the existing collection The EmailAddressCollection to append to the existing collection. Find the index of the EmailAddress in the collection The object to find. The index, from 0, or -1 if not found. Insert an EmailAddress into the collection at the specified index. The index, starting at zero. The email address to add to the collection Remove an address, if found, from the collection. The EmailAddress to remove Render the email addresses in a comma-separated list, suitable for being rendered in an email. Calls ToDataString(). ARM= Assembly Resource Manager. Manage the strings for the various CultureInfo types. The singleton object The namespace of the resource files The singleton System.Resources.ResourceManager. Create the singleton Get the instance of the class the ARM instance Get an object from the file The key The key lookup for the default culture Get an object for the specified CultureInfo The specified culture for the resource The key for the resource returns an object, if one is found, else null Get a string for the specified CultureInfo for the default culture The key for the resource returns a string, if one is found, else null Get a string for the specified CultureInfo for the default culture. If not found, return defaultvalue The key for the resource The value to return if there is no value found. returns a string, if one is found, else defaultvalue Get a string for the specified CultureInfo for the current culture. If not found, return null The culture of the resulting string The key for the resource returns a string, if one is found, else null Get a string for the specified CultureInfo for the default culture. If not found, return defaultvalue The culture of the resulting string The key for the resource The value to return if there is no value found. returns a string, if one is found, else defaultvalue Retrieve the entire resource set for this culture. The culture to examine The resource set, if any. This represents one of the message headers as it appears in the email. Create a new instance of a MessageHeader The header name (without a colon) The unencoded value Create a new instance of a MessageHeader, with a mime-encoded value. The header name (without a colon) The non-encoded header value The mime-encoded value The string representation of the header, as it will appear in the email. The name of the header. The unencoded value of the header The mime-encoded value of the header