mail.h

Go to the documentation of this file.

/*
 * mail.h
 *
 * Electronic Mail abstraction class.
 *
 * Portable Windows Library
 *
 * Copyright (c) 1993-1998 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.
 *
 * Portions are Copyright (C) 1993 Free Software Foundation, Inc.
 * All Rights Reserved.
 *
 * Contributor(s): ______________________________________.
 *
 * $Log: mail.h,v $
 * Revision 1.14  2005/11/25 03:43:47  csoutheren
 * Fixed function argument comments to be compatible with Doxygen
 *
 * Revision 1.13  2003/09/17 05:41:58  csoutheren
 * Removed recursive includes
 *
 * Revision 1.12  2003/09/17 01:18:02  csoutheren
 * Removed recursive include file system and removed all references
 * to deprecated coooperative threading support
 *
 * Revision 1.11  2002/09/16 01:08:59  robertj
 * Added #define so can select if #pragma interface/implementation is used on
 *   platform basis (eg MacOS) rather than compiler, thanks Robert Monaghan.
 *
 * Revision 1.10  2001/05/22 12:49:32  robertj
 * Did some seriously wierd rewrite of platform headers to eliminate the
 *   stupid GNU compiler warning about braces not matching.
 *
 * Revision 1.9  1999/03/09 02:59:50  robertj
 * Changed comments to doc++ compatible documentation.
 *
 * Revision 1.8  1999/02/16 08:12:00  robertj
 * MSVC 6.0 compatibility changes.
 *
 * Revision 1.7  1999/02/10 13:20:53  robertj
 * Added ability to have attachments in mail messages.
 *
 * Revision 1.6  1998/09/23 06:20:51  robertj
 * Added open source copyright license.
 *
 * Revision 1.5  1997/05/16 12:14:08  robertj
 * Added BCC capability to send mail.
 *
 * Revision 1.4  1995/07/02 01:19:46  robertj
 * Change GetMessageBidy to return BOOL and have body string as
 *   parameter, due to slight change in semantics for large bodies.
 *
 * Revision 1.3  1995/06/17 00:42:22  robertj
 * Added mail reading interface.
 * Changed name to simply PMail
 *
 * Revision 1.2  1995/04/01 08:27:57  robertj
 * Added GUI support.
 *
 * Revision 1.1  1995/03/14  12:44:11  robertj
 * Initial revision
 *
 */

#ifndef _PMAIL
#define _PMAIL

#ifdef P_USE_PRAGMA
#pragma interface
#endif

#ifdef _WIN32

#  ifndef P_HAS_MAPI
#  define P_HAS_MAPI 1
#  endif

#  ifndef P_HAS_CMC
#  define P_HAS_CMC 1
#  endif

#  if P_HAS_MAPI
#  include <mapi.h>
#  endif

#  if P_HAS_CMC
#  include <xcmc.h>
#  endif

#endif  // _WIN32


class PMail : public PObject
{
  PCLASSINFO(PMail, PObject);

  public:
    PMail();

    PMail(
      const PString & username,  
      const PString & password   
    );

    PMail(
      const PString & username,  
      const PString & password,  
      const PString & service
    );


    virtual ~PMail();
    /* Destroy the mail session, logging off the mail system if necessary.
     */

    BOOL LogOn(
      const PString & username,  
      const PString & password   
    );

    BOOL LogOn(
      const PString & username,  
      const PString & password,  
      const PString & service
    );

    virtual BOOL LogOff();

    BOOL IsLoggedOn() const;

    BOOL SendNote(
      const PString & recipient,  
      const PString & subject,    
      const char * body           
    );

    BOOL SendNote(
      const PString & recipient,  
      const PString & subject,    
      const char * body,          
      const PStringList & attachments
    );

    BOOL SendNote(
      const PString & recipient,  
      const PStringList & carbonCopies, 
      const PStringList & blindCarbons, 
      const PString & subject,        
      const char * body,              
      const PStringList & attachments
    );

    PStringArray GetMessageIDs(
      BOOL unreadOnly = TRUE    
    );

    struct Header {
      PString  subject;           
      PString  originatorName;    
      PString  originatorAddress; 
      PTime    received;          
    };

    BOOL GetMessageHeader(
      const PString & id,      
      Header & hdrInfo         
    );

    BOOL GetMessageBody(
      const PString & id,      
      PString & body,          
      BOOL markAsRead = FALSE  
    );

    BOOL GetMessageAttachments(
      const PString & id,       
      PStringArray & filenames, 
      BOOL includeBody = FALSE, 
      BOOL markAsRead = FALSE   
    );

    BOOL MarkMessageRead(
      const PString & id      
    );

    BOOL DeleteMessage(
      const PString & id      
    );


    enum LookUpResult {
      UnknownUser,    
      AmbiguousUser,  
      ValidUser,      
      LookUpError     
    };

    LookUpResult LookUp(
      const PString & name,  
      PString * fullName = NULL
    );

    int GetErrorCode() const;

    PString GetErrorText() const;


  protected:
    void Construct();
    // Common construction code.

    BOOL loggedOn;


// Include platform dependent part of class
#ifdef _WIN32
#include "msos/ptlib/mail.h"
#else
#include "unix/ptlib/mail.h"
#endif
};

#endif

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

---