topical media & game development

talk show tell print

lib-of-vs-libs-Poco-include-Poco-Net-MailStream.h / h



  //
  // MailStream.h
  //
  // Id: //poco/1.3/Net/include/Poco/Net/MailStream.h#1 
  //
  // Library: Net
  // Package: Mail
  // Module:  MailStream
  //
  // Definition of the MailStream class.
  //
  // Copyright (c) 2005-2006, Applied Informatics Software Engineering GmbH.
  // and Contributors.
  //
  // Permission is hereby granted, free of charge, to any person or organization
  // obtaining a copy of the software and accompanying documentation covered by
  // this license (the "Software") to use, reproduce, display, distribute,
  // execute, and transmit the Software, and to prepare derivative works of the
  // Software, and to permit third-parties to whom the Software is furnished to
  // do so, all subject to the following:
  // 
  // The copyright notices in the Software and this entire statement, including
  // the above license grant, this restriction and the following disclaimer,
  // must be included in all copies of the Software, in whole or in part, and
  // all derivative works of the Software, unless such copies or derivative
  // works are solely in the form of machine-executable object code generated by
  // a source language processor.
  // 
  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  // FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
  // SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
  // FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
  // ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  // DEALINGS IN THE SOFTWARE.
  //
  
  ifndef Net_MailStream_INCLUDED
  define Net_MailStream_INCLUDED
  
  include "Poco/Net/Net.h"
  include "Poco/UnbufferedStreamBuf.h"
  include <istream>
  include <ostream>
  
  namespace Poco {
  namespace Net {
  
  class Net_API MailStreamBuf: public Poco::UnbufferedStreamBuf
  
The sole purpose of this stream buffer is to replace a "\r\n.\r\n" character sequence with a "\r\n..\r\n" sequence for output streams and vice-versa for input streams. This is used when sending mail messages to SMTP servers, or receiving mail messages from POP servers. See RFC 2181 (Simple Mail Transfer Protocol) and RFC 1939 (Post Office Protocol - Version 3) for more information. { public: MailStreamBuf(std::istream& istr); Creates the MailStreamBuf and connects it to the given input stream.

          MailStreamBuf(std::ostream& ostr);
  
Creates the MailStreamBuf and connects it to the given output stream.

          ~MailStreamBuf();
  
Destroys the MailStreamBuf. void close(); Writes the terminating period, followed by CR-LF. protected: int readFromDevice(); int writeToDevice(char c); int readOne();

  private:
          enum State
          {
                  ST_DATA,
                  ST_CR,
                  ST_CR_LF,
                  ST_CR_LF_DOT,
                  ST_CR_LF_DOT_DOT,
                  ST_CR_LF_DOT_CR,
                  ST_CR_LF_DOT_CR_LF
          };
          
          std::istream* _pIstr;
          std::ostream* _pOstr;
          std::string   _buffer;
          State         _state;
  };
  
  class Net_API MailIOS: public virtual std::ios
  
The base class for MailInputStream and MailOutputStream. This class provides common methods and is also needed to ensure the correct initialization order of the stream buffer and base classes. { public: MailIOS(std::istream& istr); Creates the MailIOS and connects it to the given input stream.

          MailIOS(std::ostream& ostr);
  
Creates the MailIOS and connects it to the given output stream.

          ~MailIOS();
  
Destroys the stream.

          void close();
  
Writes the terminating period, followed by CR-LF.

          MailStreamBuf* rdbuf();
  
Returns a pointer to the underlying streambuf.

  protected:
          MailStreamBuf _buf;
  };
  
  class Net_API MailInputStream: public MailIOS, public std::istream
  
This class is used for reading E-Mail messages from a POP3 server. All occurences of "\r\n..\r\n" are replaced with "\r\n.\r\n". The first occurence of "\r\n.\r\n" denotes the end of the stream. { public: MailInputStream(std::istream& istr); Creates the MailInputStream and connects it to the given input stream.

          ~MailInputStream();
  
Destroys the MailInputStream. };

  class Net_API MailOutputStream: public MailIOS, public std::ostream
  
This class is used for writing E-Mail messages to a SMTP server. All occurences of "\r\n.\r\n" are replaced with "\r\n..\r\n". { public: MailOutputStream(std::ostream& ostr); Creates the MailOutputStream and connects it to the given input stream.

          ~MailOutputStream();
  
Destroys the MailOutputStream. };

  } } // namespace Poco::Net
  
  endif // Net_MailStream_INCLUDED
  


(C) Æliens 04/09/2009

You may not copy or print any of this material without explicit permission of the author or the publisher. In case of other copyright issues, contact the author.