smtp.htm

VC++实现网络POP3协议的MFC扩展

<p><a href="#CSMTPAddress"><font face="Arial">CSMTPAddress</font></a></p>

<p>&nbsp;</p>

<p><a name="m_sSubject"></a><big><strong><font face="Arial">CSMTPMessage::m_sSubject</font></strong></big></p>

<p><font face="Arial"><strong>Remarks</strong></font></p>

<p><font face="Arial">The subject line of the message in the form of a CString. You would
normally set this value to something meaningful prior to sending a message.</font></p>

<p>&nbsp;</p>

<p>&nbsp;</p>

<p><a name="AddBody"></a><big><strong><font face="Arial">CSMTPMessage::AddBody</font></strong></big></p>

<p><font face="Arial"><strong>void AddBody(const CString&amp; </strong><em>sBody</em><strong>);</strong></font></p>

<p class="rl"><strong><font face="Arial">Return Value</font></strong></p>

<p class="t"><font face="Arial">None.</font></p>

<p><font face="Arial"><strong>Parameters</strong></font></p>

<p><font face="Arial"><em>sBody</em> A reference to the text to add to the body of the
message.</font></p>

<p><font face="Arial"><strong>Remarks</strong></font></p>

<p><font face="Arial">Internally this function will ensure that the contents of the string
conforms to the standards required for an SMTP message. Prior to v1.12 a public member
m_sBody was available. Client applications now should call AddBody instead. This ensures
that the internal function FixSingleDot is only called once even if the same message is
sent a number of times.</font></p>

<p><font face="Arial"><strong>See Also</strong></font></p>

<p><a href="#AddAttachment"><font face="Arial">CSMTPMessage::AddAttachment</font></a></p>

<p>&nbsp;</p>

<p>&nbsp;</p>

<p><a name="AddMultipleRecipients"></a><big><strong><font face="Arial">CSMTPMessage::AddMultipleRecipients</font></strong></big></p>

<p><font face="Arial"><strong>BOOL AddMultipleRecipients(const CString&amp; </strong><em>sRecipients</em><strong>);</strong></font></p>

<p class="rl"><strong><font face="Arial">Return Value</font></strong></p>

<p class="t"><font face="Arial">TRUE if the string was successfully parsed for recipients
otherwise FALSE.</font></p>

<p class="t"><font face="Arial">.<strong>Parameters</strong></font></p>

<p><font face="Arial"><em>sRecipients</em> A string containing a number of recipient
addresses.</font></p>

<p><font face="Arial"><strong>Remarks</strong></font></p>

<p><font face="Arial">This function allows the class to add a number of recipients quickly
without having to create a single CSMTPAddress for each recipient. The delimters allowed
in the string are &quot;;&quot; and &quot;,&quot; and friendly names can be specified with
&quot;&lt;&quot;, &quot;&gt;&quot; delimiters. An example of a valid string is:</font></p>

<p><font face="Times New Roman">&quot;PJ Naughter &lt;[e-mail]&gt; , My Boss
&lt;[e-mail]&gt; ; Joe &lt;[e-mail]&gt;&quot;</font></p>

<p><font face="Arial"><strong>See Also</strong></font></p>

<p><a href="#AddRecipient"><font face="Arial">CSMTPMessage::AddRecipient</font></a></p>

<p>&nbsp;</p>

<p>&nbsp;</p>

<p><a name="m_sXMailer"></a><big><strong><font face="Arial">CSMTPMessage::m_sXMailer</font></strong></big></p>

<p><font face="Arial"><strong>Remarks</strong></font></p>

<p><font face="Arial">The X-Mailer field which will be included in the email address. By
default it is set to _T(&quot;CSMTPConnection v1.21&quot;). You are free to change this
prior to sending an email message from your application.</font></p>

<p>&nbsp;</p>

<p>&nbsp;</p>

<p><a name="m_ReplyTo"></a><big><strong><font face="Arial">CSMTPMessage::m_ReplyTo</font></strong></big></p>

<p><font face="Arial"><strong>Remarks</strong></font></p>

<p><font face="Arial">This is the address of the person to which any replies to this
message should be sent. This is an optional field which is normally not required to be
present as you would normally want replies to your messages to be sent directly back to
the sender of the message. By default this field is not sent with a SMTP message is sent.</font></p>

<p><strong><font face="Arial">See Also</font></strong></p>

<p><a href="#CSMTPAddress"><font face="Arial">CSMTPAddress</font></a></p>

<p>&nbsp;</p>

<p>&nbsp;</p>

<p>&nbsp;</p>

<p><a name="Connect"></a><big><strong><font face="Arial">CSMTPConnection::Connect</font></strong></big></p>

<p><font face="Arial"><strong>BOOL Connect(LPCTSTR </strong><em>pszHostName</em><strong>,
int </strong><em>nPort</em><strong> = 25);</strong></font></p>

<p class="rl"><strong><font face="Arial">Return Value</font></strong></p>

<p class="t"><font face="Arial">If the function succeeds, the return value is TRUE. If the
function fails, the return value is FALSE. To get extended error information, call
::GetLastError.</font></p>

<p><font face="Arial"><strong>Parameters</strong></font></p>

<p><font face="Arial"><em>pszHostName</em> The network address of the socket to connect
to: a machine name such as &#147;mail.yourisp.com&#148;, or a dotted number such as
&#147;128.56.22.8&#148;.</font></p>

<p><font face="Arial"><em>nPort</em> This is the port number on which to connect. The
default value is 25 which is the default SMTP port number.</font></p>

<p><font face="Arial"><strong>Remarks</strong></font></p>

<p><font face="Arial">Call this member function to establish a connection to a SMTP mail
server.</font></p>

<p><strong><font face="Arial">See Also</font></strong></p>

<p><a href="#Disconnect"><font face="Arial">CSMTPConnection::Disconnect</font></a></p>

<p>&nbsp;</p>

<p>&nbsp;</p>

<p><a name="Disconnect"></a><big><strong><font face="Arial">CSMTPConnection::Disconnect</font></strong></big></p>

<p><strong><font face="Arial">BOOL Disconnect();</font></strong></p>

<p class="rl"><strong><font face="Arial">Return Value</font></strong></p>

<p class="t"><font face="Arial">If the function succeeds, the return value is TRUE. If the
function fails, the return value is FALSE. To get extended error information, call
::GetLastError.</font></p>

<p><font face="Arial"><strong>Parameters</strong></font></p>

<p><font face="Arial">None.</font></p>

<p><font face="Arial"><strong>Remarks</strong></font></p>

<p><font face="Arial">The corollary function of Connect.</font></p>

<p><strong><font face="Arial">See Also</font></strong></p>

<p><a href="#Connect"><font face="Arial">CSMTPConnection::Connect</font></a></p>

<p>&nbsp;</p>

<p>&nbsp;</p>

<p><a name="GetLastCommandResponse"></a><big><strong><font face="Arial">CSMTPConnection::GetLastCommandResponse</font></strong></big></p>

<p><strong><font face="Arial">CString GetLastCommandResponse() const;</font></strong></p>

<p class="rl"><strong><font face="Arial">Return Value</font></strong></p>

<p class="t"><font face="Arial">The last command response from the server as a CString.</font></p>

<p><font face="Arial"><strong>Parameters</strong></font></p>

<p><font face="Arial">None.</font></p>

<p><font face="Arial"><strong>Remarks</strong></font></p>

<p><font face="Arial">The CSMTPConnection class can return additional text information
along with most errors. This extended error information can be retrieved by using the
GetLastCommandResponse function after an unsuccessful function call.
GetLastCommandResponse can be called multiple times until another CSMTPConnection function
is called which sends an SMTP command. </font></p>

<p><strong><font face="Arial">See Also</font></strong></p>

<p><a href="#GetLastCommandResponseCode"><font face="Arial">CSMTPConnection::GetLastCommandResponseCode</font></a></p>

<p>&nbsp;</p>

<p>&nbsp;</p>

<p><a name="GetLastCommandResponseCode"></a><big><strong><font face="Arial">CSMTPConnection::GetLastCommandResponseCode</font></strong></big></p>

<p><strong><font face="Arial">int GetLastCommandResponseCode() const;</font></strong></p>

<p class="rl"><strong><font face="Arial">Return Value</font></strong></p>

<p class="t"><font face="Arial">The last command response from the server as a CString.</font></p>

<p><font face="Arial"><strong>Parameters</strong></font></p>

<p><font face="Arial">None.</font></p>

<p><font face="Arial"><strong>Remarks</strong></font></p>

<p><font face="Arial">The CSMTPConnection class can return additional text information
along with most errors. This extended error information can be retrieved by using the
GetLastCommandResponse function after an unsuccessful function call. Embedded within each
SMTP response is a 3 digit error code. The GetLastCommandResponseCode retrieves this
value.</font></p>

<p><strong><font face="Arial">See Also</font></strong></p>

<p><a href="#GetLastCommandResponse"><font face="Arial">CSMTPConnection::GetLastCommandResponse</font></a></p>

<p>&nbsp;</p>

<p>&nbsp;</p>

<p><a name="GetTimeout"></a><big><strong><font face="Arial">CSMTPConnection::GetTimeout</font></strong></big></p>

<p><strong><font face="Arial">DWORD GetTimeout() const;</font></strong></p>

<p class="rl"><strong><font face="Arial">Return Value</font></strong></p>

<p class="t"><font face="Arial">The timeout in milliseconds which the code will wait for
responses from the SMTP server.</font></p>

<p><font face="Arial"><strong>Parameters</strong></font></p>

<p><font face="Arial">None.</font></p>

<p><font face="Arial"><strong>Remarks</strong></font></p>

<p><font face="Arial">Since CSMTPConnection provides a synchronous API, a timeout
mechanism is provided. By default the value is 2 seconds in release mode and 20 seconds in
debug mode. The value is larger in debug mode so that the code does not time out when you
are debugging it.</font></p>

<p><strong><font face="Arial">See Also </font></strong></p>

<p><a href="#SetTimeout"><font face="Arial">CSMTPConnection::SetTimeout</font></a></p>

<p>&nbsp;</p>

<p>&nbsp;</p>

<p><a name="SetTimeout"></a><big><strong><font face="Arial">CSMTPConnection::SetTimeout</font></strong></big></p>

<p><font face="Arial"><strong>void SetTimeout(DWORD </strong><em>dwTimeout</em><strong>)
const;</strong></font></p>

<p class="rl"><strong><font face="Arial">Return Value</font></strong></p>

<p class="t"><font face="Arial">None.</font></p>

<p><font face="Arial"><strong>Parameters</strong></font></p>

<p><font face="Arial"><em>dwTimeout</em> The new timeout value in milliseconds.</font></p>

<p><font face="Arial"><strong>Remarks</strong></font></p>

<p><font face="Arial">Sets the timeout to use for connections to the SMTP server.</font></p>

<p><strong><font face="Arial">See Also </font></strong></p>

<p><a href="#GetTimeout"><font face="Arial">CSMTPConnection::GetTimeout</font></a></p>

<p>&nbsp;</p>

<p>&nbsp;</p>

<p><a name="SendMessage"></a><big><strong><font face="Arial">CSMTPConnection::SendMessage</font></strong></big></p>

<p><font face="Arial"><strong>BOOL SendMessage(const CSMTPMessage&amp; </strong><em>Message</em><strong>)
const;</strong></font></p>

<p class="rl"><strong><font face="Arial">Return Value</font></strong></p>

<p><font face="Arial">If the function succeeds, the return value is TRUE. If the function
fails, the return value is FALSE. To get extended error information, call ::GetLastError.</font></p>

<p><strong><font face="Arial">Parameters</font></strong></p>

<p><font face="Arial"><em>Message</em> A const reference to the message to send.</font></p>

<p><font face="Arial"><strong>Remarks</strong></font></p>

<p><font face="Arial">Sends the specified message using the server which it is currently
connected to.</font></p>

<p><strong><font face="Arial">See Also </font></strong></p>

<p><a href="#CSMTPMessage"><font face="Arial">CSMTPMessage</font></a></p>

<p>&nbsp;</p>

<p>&nbsp;</p>

<p>&nbsp;</p>

<p><font face="Arial"><big><a name="Enhancements"></a></big><font color="#000000" size="4"><strong>PLANNED
ENHANCEMENTS</strong></font> </font>

<ul>
  <li><font face="Arial">Package the code up into an OCX, COM Interface or DLL to allow non
    MFC apps to use the code.</font></li>
  <li><font face="Arial">Provide a better sample app. At the moment, it's very much a test
    program which tests all of the functions.</font></li>
  <li><font face="Arial" color="#000000" size="3">If you have any other suggested
    improvements, please let me know so that I can incorporate them into the next release.</font></li>
</ul>

<p>&nbsp;</p>

<p>&nbsp;</p>

<p>&nbsp;</p>

<p><font face="Arial"><a name="Contact"></a><font color="#000000" size="4"><strong>CONTACTING
THE AUTHOR</strong></font></font></p>

<p><font face="Arial" color="#000000" size="3">PJ Naughter<br>
Email: <a href="mailto:[e-mail]">[e-mail]</a><br>
Web: <a href="http://indigo.ie/~pjn">http://indigo.ie/~pjn</a><br>
5 October 1999</font></p>
</body>
</html>