inetmail.h

Go to the documentation of this file.

/*
 * inetmail.h
 *
 * Internet Mail channel classes
 * Simple Mail Transport Protocol & Post Office Protocol v3
 *
 * Portable Windows Library
 *
 * Copyright (c) 1993-2002 Equivalence Pty. Ltd.
 *
 * The contents of this file are subject to the Mozilla Public License
 * Version 1.0 (the "License"); you may not use this file except in
 * compliance with the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
 * the License for the specific language governing rights and limitations
 * under the License.
 *
 * The Original Code is Portable Windows Library.
 *
 * The Initial Developer of the Original Code is Equivalence Pty. Ltd.
 *
 * Contributor(s): Federico Pinna and Reitek S.p.A.
 */

#ifndef PTLIB_INETMAIL_H
#define PTLIB_INETMAIL_H

#ifdef P_USE_PRAGMA
#pragma interface
#endif

#include <ptclib/inetprot.h>
#include <ptclib/mime.h>

class PSocket;


// PSMTP

class PSMTP : public PInternetProtocol
{
  PCLASSINFO(PSMTP, PInternetProtocol)

  public:
  // New functions for class.
    enum Commands {
      HELO, EHLO, QUIT, HELP, NOOP,
      TURN, RSET, VRFY, EXPN, RCPT,
      MAIL, SEND, SAML, SOML, DATA,
      AUTH, STARTTLS, NumCommands
    };

    struct Parameters
    {
      Parameters()
        : m_port(0)
        , m_eightBitMIME(false)
      {
      }

      PString     m_hostname;    
      WORD        m_port;        
      PString     m_username;    
      PString     m_password;    
      PString     m_from;        
      PStringList m_to;          
      PStringList m_cc;          
      PStringList m_bcc;         
      PString     m_subject;     
      PString     m_bodyText;    
      PStringList m_attachments; 
      bool        m_eightBitMIME;
    };

    static bool SendMail(
      const Parameters & params, 
      PString & error            
    );

  protected:
    PSMTP();
    // Create a new SMTP protocol channel.
};


class PSMTPClient : public PSMTP
{
  PCLASSINFO(PSMTPClient, PSMTP)

  public:
    PSMTPClient();

    ~PSMTPClient();


  // Overrides from class PChannel.
    virtual PBoolean Close();


  // New functions for class.
    bool LogIn(
      const PString & username,   
      const PString & password    
    );

    bool BeginMessage(
      const PString & from,        
      const PString & to,          
      PBoolean eightBitMIME = false    
    );
    bool BeginMessage(
      const PString & from,        
      const PStringList & toList,  
      bool eightBitMIME = false    
    );

    PBoolean EndMessage();


  protected:
    PBoolean OnOpen();

    bool            m_haveHello;
    PStringToString m_extensions;
    PString         m_fromAddress;
    PStringList     m_toNames;
    bool            m_sendingData;

  private:
    bool InternalHello();
    bool InternalExtendedHello();
    PString InternalLocalHostName();
    bool InternalBeginMessage(bool useEightBitMIME);
};


class PSMTPServer : public PSMTP
{
  PCLASSINFO(PSMTPServer, PSMTP)

  public:
    PSMTPServer();


  // New functions for class.
    PBoolean ProcessCommand();

    void ServerReset();
    // Reset the state of the SMTP server socket.

    enum ForwardResult {
      LocalDomain,    
      WillForward,    
      CannotForward   
    };
    // Result of forward check

    virtual ForwardResult ForwardDomain(
      PCaselessString & userDomain,       
      PCaselessString & forwardDomainList 
    );

    enum LookUpResult {
      ValidUser,      
      AmbiguousUser,  
      UnknownUser,    
      LookUpError     
    };
    // Result of user name look up

    virtual LookUpResult LookUpName(
      const PCaselessString & name,    
      PString & expandedName           
    );

    virtual PBoolean HandleMessage(
      PCharArray & buffer,  
      PBoolean starting,        
      PBoolean completed        
    );


  protected:
    PBoolean OnOpen();

    virtual void OnHELO(
      const PCaselessString & remoteHost  
    );
    // Start connection.

    virtual void OnEHLO(
      const PCaselessString & remoteHost  
    );
    // Start extended SMTP connection.

    virtual void OnQUIT();
    // close connection and die.

    virtual void OnHELP();
    // get help.

    virtual void OnNOOP();
    // do nothing
    
    virtual void OnTURN();
    // switch places
    
    virtual void OnRSET();
    // Reset state.

    virtual void OnVRFY(
      const PCaselessString & name    
    );
    // Verify address.

    virtual void OnEXPN(
      const PCaselessString & name    
    );
    // Expand alias.

    virtual void OnRCPT(
      const PCaselessString & recipient   
    );
    // Designate recipient

    virtual void OnMAIL(
      const PCaselessString & sender  
    );
    // Designate sender
    
    virtual void OnSEND(
      const PCaselessString & sender  
    );
    // send message to screen

    virtual void OnSAML(
      const PCaselessString & sender  
    );
    // send AND mail
    
    virtual void OnSOML(
      const PCaselessString & sender  
    );
    // send OR mail

    virtual void OnDATA();
    // Message text.

    virtual PBoolean OnUnknown(
      const PCaselessString & command  
    );

    virtual void OnSendMail(
      const PCaselessString & sender  
    );
    // Common code for OnMAIL(), OnSEND(), OnSOML() and OnSAML() funtions.

    virtual PBoolean OnTextData(PCharArray & buffer, PBoolean & completed);

    virtual PBoolean OnMIMEData(PCharArray & buffer, PBoolean & completed);


  // Member variables
    PBoolean        extendedHello;
    PBoolean        eightBitMIME;
    PString     fromAddress;
    PString     fromPath;
    PStringList toNames;
    PStringList toDomains;
    PINDEX      messageBufferSize;
    enum { WasMAIL, WasSEND, WasSAML, WasSOML } sendCommand;
    StuffState  endMIMEDetectState;
};


// PPOP3

class PPOP3 : public PInternetProtocol
{
  PCLASSINFO(PPOP3, PInternetProtocol)

  public:
    enum Commands {
      USER, PASS, QUIT, RSET, NOOP, STATcmd,
      LIST, RETR, DELE, APOP, TOP,  UIDL,
      AUTH, NumCommands
    };


  protected:
    PPOP3();

    virtual PINDEX ParseResponse(
      const PString & line 
    );

  // Member variables
    static const PString & okResponse();
    static const PString & errResponse();
};


class PPOP3Client : public PPOP3
{
  PCLASSINFO(PPOP3Client, PPOP3)

  public:
    PPOP3Client();

    ~PPOP3Client();


  // Overrides from class PChannel.
    virtual PBoolean Close();


  // New functions for class.
    enum LoginOptions
    {
      AllowUserPass = 1,      
      UseSASL = 2,            
      AllowClearTextSASL = 4  
    };

    PBoolean LogIn(
      const PString & username,       
      const PString & password,       
      int options = AllowUserPass     
    );

    int GetMessageCount();

    PUnsignedArray GetMessageSizes();

    PStringArray GetMessageHeaders();


    /* Begin the retrieval of an entire message. The application may then use
       the <A>PApplicationSocket::ReadLine()</A> function with the
       <CODE>unstuffLine</CODE> parameter set to true. Repeated calls until
       its return valus is false will read the message headers and body.

       @return
       Array of strings continaing message headers.
     */
    PBoolean BeginMessage(
      PINDEX messageNumber
    );

    PBoolean DeleteMessage(
      PINDEX messageNumber
        /* Number of message to retrieve. This is an integer from 1 to the
           maximum number of messages available.
         */
    );


  protected:
    PBoolean OnOpen();

  // Member variables
    PBoolean loggedIn;
    PString apopBanner;
};


class PPOP3Server : public PPOP3
{
  PCLASSINFO(PPOP3Server, PPOP3)

  public:
    PPOP3Server();


  // New functions for class.
    PBoolean ProcessCommand();

    virtual PBoolean HandleOpenMailbox(
      const PString & username,  
      const PString & password   
    );

    virtual void HandleSendMessage(
      PINDEX messageNumber, 
      const PString & id,   
      PINDEX lines          
    );
    
    virtual void HandleDeleteMessage(
      PINDEX messageNumber, 
      const PString & id    
    );
    

  protected:
    PBoolean OnOpen();

    virtual void OnUSER(
      const PString & name  
    );
    // Specify user name (mailbox).

    virtual void OnPASS(
      const PString & passwd  
    );
    // Specify password and log user in.

    virtual void OnQUIT();
    // End connection, saving all changes (delete messages).

    virtual void OnRSET();
    // Reset connection (undelete messages).

    virtual void OnNOOP();
    // Do nothing.

    virtual void OnSTAT();
    // Get number of messages in mailbox.

    virtual void OnLIST(
      PINDEX msg  
    );

    virtual void OnRETR(
      PINDEX msg  
    );
    // Retrieve a message from mailbox.

    virtual void OnDELE(
      PINDEX msg  
    );
    // Delete a message from mailbox.

    virtual void OnTOP(
      PINDEX msg,  
      PINDEX count 
    );
    // Get the message header and top <CODE>count</CODE> lines of message.

    virtual void OnUIDL(
      PINDEX msg  
    );

    virtual PBoolean OnUnknown(
      const PCaselessString & command  
    );


  // Member variables
    PString        username;
    PUnsignedArray messageSizes;
    PStringArray   messageIDs;
    PBYTEArray     messageDeletions;
};


class PRFC822Channel : public PIndirectChannel
{
    PCLASSINFO(PRFC822Channel, PIndirectChannel);
  public:
    enum Direction {
      Sending,
      Receiving
    };
    PRFC822Channel(
      Direction direction 
    );

    ~PRFC822Channel();


  // Overrides from class PChannel.
    PBoolean Close();

    virtual PBoolean Write(
      const void * buf, 
      PINDEX len        
    );


    void NewMessage(
      Direction direction  
    );

    PString MultipartMessage();

    PBoolean MultipartMessage(
      const PString & boundary
    );

    void NextPart(
      const PString & boundary
    );


    void SetFromAddress(
      const PString & fromAddress  
    );

    void SetToAddress(
      const PString & toAddress 
    );

    void SetCC(
      const PString & ccAddress 
    );

    void SetBCC(
      const PString & bccAddress 
    );

    void SetSubject(
      const PString & subject  
    );

    void SetContentType(
      const PString & contentType   
    );

    void SetContentAttachment(
      const PFilePath & filename   
    );

    void SetTransferEncoding(
      const PString & encoding,   
      PBoolean autoTranslate = true   
    );


    void SetHeaderField(
      const PString & name,   
      const PString & value   
    );

    // Common MIME header tags
    static const PCaselessString & MimeVersionTag();
    static const PCaselessString & FromTag();
    static const PCaselessString & ToTag();
    static const PCaselessString & CCTag();
    static const PCaselessString & BCCTag();
    static const PCaselessString & SubjectTag();
    static const PCaselessString & DateTag();
    static const PCaselessString & ReturnPathTag();
    static const PCaselessString & ReceivedTag();
    static const PCaselessString & MessageIDTag();
    static const PCaselessString & MailerTag();
    static const PCaselessString & ContentTypeTag() { return PMIMEInfo::ContentTypeTag(); }
    static const PCaselessString & ContentDispositionTag() { return PMIMEInfo::ContentDispositionTag(); }
    static const PCaselessString & ContentTransferEncodingTag() { return PMIMEInfo::ContentTransferEncodingTag(); }


  protected:
    PBoolean OnOpen();

    bool        writeHeaders;
    PMIMEInfo   headers;
    bool        writePartHeaders;
    PMIMEInfo   partHeaders;
    PStringList boundaries;
    PBase64   * base64;
};


#endif  // PTLIB_INETMAIL_H


// End Of File ///////////////////////////////////////////////////////////////