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): ______________________________________.
 *
 * $Revision: 28729 $
 * $Author: csoutheren $
 * $Date: 2013-01-02 10:20:47 +1100 (Wed, 02 Jan 2013) $
 */

#ifndef PTLIB_MAIL_H
#define PTLIB_MAIL_H

#ifdef P_USE_PRAGMA
#pragma interface
#endif

#if defined(_WIN32) && !defined(_WIN64)

#  if _MSC_VER < 1700

#  ifndef P_HAS_MAPI
#  define P_HAS_MAPI 1
#  endif

#  ifndef P_HAS_CMC
#  define P_HAS_CMC 1
#  endif

#  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.
     */

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

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

    virtual PBoolean LogOff();

    PBoolean IsLoggedOn() const;

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

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

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

    PStringArray GetMessageIDs(
      PBoolean unreadOnly = true    
    );

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

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

    PBoolean GetMessageBody(
      const PString & id,      
      PString & body,          
      PBoolean markAsRead = false  
    );

    PBoolean GetMessageAttachments(
      const PString & id,       
      PStringArray & filenames, 
      PBoolean includeBody = false, 
      PBoolean markAsRead = false   
    );

    PBoolean MarkMessageRead(
      const PString & id      
    );

    PBoolean 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.

    PBoolean loggedOn;


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


#endif // PTLIB_MAIL_H


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