opensmtp.xml

用C#开发实现SMTP相关技术,能接收到带附件的邮件服务功能.

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>OpenSmtp</name>
    </assembly>
    <members>
        <member name="T:OpenSmtp.Mail.Attachment">
            <summary>
            This Type stores a file attachment. There can be many attachments in each MailMessage
            <seealso cref="T:OpenSmtp.Mail.MailMessage"/>
            </summary>
            <example>
            <code>
            MailMessage msg = new MailMessage();
            Attachment a = new Attachment("C:\\file.jpg");
            msg.AddAttachment(a);
            </code>
            </example>
        </member>
        <member name="M:OpenSmtp.Mail.Attachment.#ctor(System.String)">
            <summary>Constructor using a file path</summary>
            <example>
            <code>Attachment a = new Attachment("C:\\file.jpg");</code>
            </example>
        </member>
        <member name="M:OpenSmtp.Mail.Attachment.#ctor(System.IO.Stream,System.String)">
            <summary>Constructor using a provided Stream</summary>
            <example>
            <code>Attachment a = new Attachment(new FileStrema(@"C:\file.jpg", FileMode.Open, FileAccess.Read), "file.jpg");</code>
            </example>
        </member>
        <member name="M:OpenSmtp.Mail.Attachment.getMimeType(System.String)">
            <summary>Returns the MIME content-type for the supplied file extension</summary>
            <returns>String MIME type (Example: \"text/plain\")</returns>
        </member>
        <member name="M:OpenSmtp.Mail.Attachment.getFileName(System.String)">
            <summary>returns the file name from a parsed file path</summary>
            <param name="filePath">UNC file path to file (IE: "C:\file.txt")</param>
            <returns>string file name (Example: \"test.zip\")</returns>
        </member>
        <member name="M:OpenSmtp.Mail.Attachment.ToMime">
            <summary>
            Encode the file for inclusion as a mime attachment.
            The boundaries are not provided.
            </summary>
            <returns></returns>
        </member>
        <member name="P:OpenSmtp.Mail.Attachment.Name">
            <value> Stores the Attachment Name</value>
        </member>
        <member name="P:OpenSmtp.Mail.Attachment.MimeType">
            <value> Stores the MIME content-type of the attachment</value>
        </member>
        <member name="P:OpenSmtp.Mail.Attachment.Encoding">
            <value> Returns the MIME content-encoding type of the attachment</value>
        </member>
        <member name="P:OpenSmtp.Mail.Attachment.FilePath">
            <value> Returns the path of an attached file</value>
        </member>
        <member name="P:OpenSmtp.Mail.Attachment.Size">
            <value> Returns the attachment size in bytes</value>
        </member>
        <member name="P:OpenSmtp.Mail.Attachment.EncodedFilePath">
            <value>When the file is encoded it is stored in temp directory until sendMail() method is called.
            This property retrieves the path to that temp file.</value>
        </member>
        <member name="T:OpenSmtp.Mail.AddressType">
            <summary>This enumeration stores the Address type</summary>
            <example>
            <code>
            msg.AddRecipient(ccAddress, AddressType.Cc);
            msg.AddRecipient(bccAddress, AddressType.Bcc);
            </code>
            </example>
        </member>
        <member name="T:OpenSmtp.Mail.EmailAddress">
            <summary>This Type stores a rfc822 email address and a name for that
            particular address (Example: "John Smith, [e-mail]")
            </summary>
            <example>
            <code>
            EmailAddress from = new EmailAddress("[e-mail]", "John Smith");
            EmailAddress to = new EmailAddress("[e-mail]");
            MailMessage msg = new MailMessage(from, to);
            </code>
            </example>
        </member>
        <member name="M:OpenSmtp.Mail.EmailAddress.#ctor(System.String)">
            <summary>Constructor using RFC 822 formatted email mesage</summary>
            <example>
            <code>EmailAddress a = new EmailAddress("[e-mail]");</code>
            </example>
        </member>
        <member name="M:OpenSmtp.Mail.EmailAddress.#ctor(System.String,System.String)">
            <summary>Constructor using RFC 822 formatted email mesage and a friendly 
            name associated with that email address</summary>
            <example>
            <code>EmailAddress a = new EmailAddress("[e-mail]", "John Smith");</code>
            </example>
        </member>
        <member name="M:OpenSmtp.Mail.EmailAddress.initregex">
            <summary>
            Initialize the regex and compiles it so that it runs a little faster.
            </summary>
        </member>
        <member name="P:OpenSmtp.Mail.EmailAddress.Address">
            <value>Stores a RFC 822 formatted message</value>
            <seealso cref="F:OpenSmtp.Mail.SmtpConfig.VerifyAddresses"/>
            <example>"[e-mail]"</example>
        </member>
        <member name="P:OpenSmtp.Mail.EmailAddress.Name">
            <value>Stores a name associated with the Address</value>
            <example>"John Smith"</example>
        </member>
        <member name="T:OpenSmtp.Mail.Log">
            <summary>
            This is a Log class. You can log text messages to a 
            text file and/or the event log
            </summary>
        </member>
        <member name="M:OpenSmtp.Mail.Log.logToTextFile(System.String,System.String,System.String)">
            Logs string message to TextFile
        </member>
        <member name="T:OpenSmtp.Mail.MailEncoder">
            <summary>
            This Type is used to encode and decode files and strings using 
            MIME compatible encoding methods such as Base64 and quoted-printable
            </summary>
        </member>
        <member name="M:OpenSmtp.Mail.MailEncoder.ConvertToBase64(System.String)">
            <summary>Encodes a String using Base64 (see RFC 1521)</summary>
            <param name="s">string to be encoded</param>
            <example>
            <code>
            string base64EncodedText = MailEncoder.ConvertQP("脣脟脜脙");
            </code>
            </example>
            <returns>Base64 encoded string</returns>
        </member>
        <member name="M:OpenSmtp.Mail.MailEncoder.ConvertToBase64(System.String,System.String)">
            <summary> Encodes a FileStream using Base64 (see RFC 1521)</summary>
            <param name="inputFilePath">UNC path to file that needs to be encoded</param>
            <param name="outputFilePath">UNC path to file will store Base64 encoded ASCII text</param>
            <example>
            <code>
            MailEncoder.ConvertBase64("file.jpg", "file.txt");
            </code>
            </example>
        </member>
        <member name="M:OpenSmtp.Mail.MailEncoder.ConvertToBase64(System.IO.Stream,System.String)">
            <summary> Encodes a FileStream using Base64 (see RFC 1521)</summary>
            <param name="inputStream">The stream that needs to be encoded</param>
            <param name="outputFilePath">UNC path to file will store Base64 encoded ASCII text</param>
            <example>
            <code>
            MailEncoder.ConvertBase64(Stream, "file.txt");
            </code>
            </example>
        </member>
        <member name="M:OpenSmtp.Mail.MailEncoder.ConvertToQP(System.String,System.String)">
            <summary> Encodes a string using Quoted-Printable encoding (see RFC 1521)</summary>
            <param name="s">string that needs to be encoded</param>
            <param name="charset">charset of string that needs to be encoded</param>
            <example>
            <code>
            string qpEncodedText = MailEncoder.ConvertQP("脣脟脜脙");
            </code>
            </example>
            <returns>Quoted-Printable encoded string</returns>
        </member>
        <member name="M:OpenSmtp.Mail.MailEncoder.ConvertHeaderToQP(System.String,System.String,System.Boolean)">
            <summary>
            Convert to Quoted Printable if necessary
            </summary>
            <param name="s"></param>
            <param name="charset"></param>
            <param name="forceconversion">force a conversion</param>
            <returns></returns>
        </member>
        <member name="M:OpenSmtp.Mail.MailEncoder.ConvertHeaderToQP(System.String,System.String)">
            <summary>
            Convert to Quoted printable if necessary.
            </summary>
            <param name="s"></param>
            <param name="charset"></param>
            <returns></returns>
        </member>
        <member name="T:OpenSmtp.Mail.MailHeader">
            <summary>
            This Type is used to store Mail Headers
            <seealso cref="T:OpenSmtp.Mail.MailMessage"/>
            </summary>
        </member>
        <member name="T:OpenSmtp.Mail.MailMessage">
            <summary>
            This Type stores the addresses, attachments, body, subject,
            and properties of the email message. There can be many
            attachments and email addresses in each MailMessage.
            <seealso cref="T:OpenSmtp.Mail.EmailAddress"/>
            <seealso cref="T:OpenSmtp.Mail.Attachment"/>
            </summary>
            <remarks>
            This Type stores the addresses, attachments, body, subject,
            and properties of the email message. There can be many
            attachments and email addresses in each MailMessage.
            <seealso cref="T:OpenSmtp.Mail.EmailAddress"/>
            <seealso cref="T:OpenSmtp.Mail.Attachment"/>
            </remarks>
            <example>
            <code>
            	from 			= new EmailAddress("[e-mail]", "Support");
            	to				= new EmailAddress("[e-mail]", "Joe Smith");
            	cc				= new EmailAddress("[e-mail]", "CC Name");
            
            	msg 			= new MailMessage(from, to);
            	msg.AddRecipient(cc, AddressType.Cc);
            	msg.AddRecipient("[e-mail]", AddressType.Bcc);
            
            	msg.Subject 	= "Testing OpenSmtp .Net SMTP component";
            	msg.Body 		= "Hello Joe Smith.";
            	msg.HtmlBody 	= "<html><body>Hello Joe Smith.</body></html>";
            
            	// mail message properties
            	msg.Charset		= "ISO-8859-1";
            	msg.Priority 	= MailPriority.High;
            	msg.Notification = true;
            
            	// add custom headers
            	msg.AddCustomHeader("X-CustomHeader", "Value");
            	msg.AddCustomHeader("X-CompanyName", "Value");
            
            	// add attachments
            	msg.AddAttachment(@"..\attachments\test.jpg");
            	msg.AddAttachment(@"..\attachments\test.htm");
            </code>
            </example>
        </member>
        <member name="M:OpenSmtp.Mail.MailMessage.#ctor(OpenSmtp.Mail.EmailAddress,OpenSmtp.Mail.EmailAddress)">
            <summary>Constructor using EmailAddress type</summary>
            <example>
            <code>