smtp_client.h

Go to the documentation of this file.

#ifndef SMTP_CLIENT_CLASS
#define SMTP_CLIENT_CLASS

/*****************************************************************************\
*                                                                             *
*  Name   : smtp_client                                                       *
*  Author : Chris Koeritz                                                     *
*                                                                             *
*******************************************************************************
* Copyright (c) 2006-$now By Author.  This program is free software; you can  *
* redistribute it and/or modify it under the terms of the GNU General Public  *
* License as published by the Free Software Foundation; either version 2 of   *
* the License or (at your option) any later version.  This is online at:      *
*     http://www.fsf.org/copyleft/gpl.html                                    *
* Please send any updates to: fred@gruntose.com                               *
\*****************************************************************************/


#include "dll_smtp_client.h"

#include <basis/object_base.h>
#include <sockets/definitions_sockets.h>

// forward.
class istring;
class log_base;
class stdio_redirecter;
class string_array;

class SMTP_CLIENT_CLASS_STYLE smtp_client
{
public:
  smtp_client();
    // creates an email sender that logs to the program wide logger.

  smtp_client(log_base &logging);
    // creates an email sender that sends output and errors to "logging".

  virtual ~smtp_client();

  #define SC_SMTP_DEFAULT_PORT 25

  enum outcomes {
    OKAY = common::OKAY,
    BAD_INPUT = common::BAD_INPUT,
    TIMED_OUT = common::TIMED_OUT,
    ACCESS_DENIED = common::ACCESS_DENIED,

    NO_SERVER = communication_commons::NO_SERVER,
    NO_CONNECTION = communication_commons::NO_CONNECTION
  };

  static const char *outcome_name(const outcome &to_name);

  IMPLEMENT_CLASS_NAME("smtp_client");

  istring text_form() const;

  static istring prune_address(const istring &to_prune, istring &name);

  static bool validate_address(const istring &to_check);

  void setup_session(const istring &server_name,
          int smtp_port = SC_SMTP_DEFAULT_PORT,
          const istring &user_name = istring::empty_string(),
          const istring &password = istring::empty_string());

  void set_server(const istring &server_name);
  void set_port(int smtp_port);
  void set_auth_user(const istring &user_name);
  void set_auth_password(const istring &password);
  void set_timeout(int timeout);

  void setup_message(const istring &sender_email, const istring &subject,
          const istring &message_body,
          const istring &one_recipient = istring::empty_string());

  void set_sender(const istring &sender_email);
  void set_subject(const istring &subject);
  void set_body(const istring &message_body);

  // standard email destination management.  these are the To: header.
  void add_recipient(const istring &recipient);
  bool remove_recipient(const istring &recipient);
  void clear_recipients();

  // carbon copy destinations.  these are the CC: header.
  void add_carbon(const istring &cc_dest);
  bool remove_carbon(const istring &cc_dest);
  void clear_carbons();

//  void add_attachment(const istring &filename);
//  bool remove_attachment(const istring &filename);
//  void clear_attachments();

  outcome send_email();

private:
  log_base *_logging;  
  istring *_sess_server;  
  int _sess_port;  
  istring *_sess_user;  
  istring *_sess_password;  
  istring *_msg_sender;  
  istring *_msg_subject;  
  istring *_msg_body;  
  string_array *_msg_attachments;  
  string_array *_msg_recipients;  
  string_array *_msg_carbons;  
  int _timeout;  

  bool okay_exit_value(int value);

  bool get_outputs(stdio_redirecter &msmtp, byte_array &received);

};

#endif

---