diff --git a/BMAMail b/BMAMail new file mode 100755 index 0000000..66c910b Binary files /dev/null and b/BMAMail differ diff --git a/BMAMail.project b/BMAMail.project deleted file mode 100644 index 0f001c4..0000000 --- a/BMAMail.project +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - None - - - - - - - - - - - - - - - diff --git a/BMAMail.txt b/BMAMail.txt deleted file mode 100644 index 6716386..0000000 --- a/BMAMail.txt +++ /dev/null @@ -1 +0,0 @@ -./Debug/main.cpp.o diff --git a/IMAPCommand.h b/IMAPCommand.h new file mode 100644 index 0000000..9db46ea --- /dev/null +++ b/IMAPCommand.h @@ -0,0 +1,24 @@ +#ifndef __IMAPCommand_h__ +# define __IMAPCommand_h__ + +# include "Command.h" +# include "TCPSession.h" +# include "IMAPSession.h" + +namespace mail { + + class IMAPCommand : public core::Command { + + public: + virtual int processCommand(std::string request, core::TCPSession *session, std::stringstream &data) override { + coreutils::PString parser(request); + return processCommand(parser, (IMAPSession &)*session, data); + } + + virtual int processCommand(coreutils::PString request, IMAPSession &session, std::stringstream &data) {} + + }; + +} + +#endif diff --git a/IMAPService.h b/IMAPService.h index d9890cf..4ebd19f 100644 --- a/IMAPService.h +++ b/IMAPService.h @@ -1,48 +1,88 @@ #ifndef __IMAPService_h__ #define __IMAPService_h__ -#include "Service.h" +#include "TCPServer.h" #include "Exception.h" -#include "__SMTP_AUTH.h" -#include "__SMTP_DATA.h" -#include "__SMTP_EHLO.h" -#include "__SMTP_HELO.h" -#include "__SMTP_MAIL.h" -#include "__SMTP_NOOP.h" -#include "__SMTP_QUIT.h" -#include "__SMTP_RCPT.h" -#include "__SMTP_RSET.h" -#include "__SMTP_VRFY.h" +#include "__IMAP_APPEND.h" +#include "__IMAP_AUTHENTICATE.h" +#include "__IMAP_CHECK.h" +#include "__IMAP_CLOSE.h" +#include "__IMAP_COPY.h" +#include "__IMAP_CREATE.h" +#include "__IMAP_DELETE.h" +#include "__IMAP_EXAMINE.h" +#include "__IMAP_EXPUNGE.h" +#include "__IMAP_FETCH.h" +#include "__IMAP_LIST.h" +#include "__IMAP_LOGIN.h" +#include "__IMAP_LSUB.h" +#include "__IMAP_RENAME.h" +#include "__IMAP_SEARCH.h" +#include "__IMAP_SELECT.h" +#include "__IMAP_STARTTLS.h" +#include "__IMAP_STATUS.h" +#include "__IMAP_STORE.h" +#include "__IMAP_SUBSCRIBE.h" +#include "__IMAP_UID.h" +#include "__IMAP_UNSUBSCRIBE.h" namespace mail { - class IMAPService : public core::Service { + class IMAPService : public core::TCPServer { public: - IMAPService() { - commands.add(_smtp_auth, "AUTH"); - commands.add(_smtp_data, "DATA"); - commands.add(_smtp_ehlo, "EHLO"); - commands.add(_smtp_helo, "HELO"); - commands.add(_smtp_mail, "MAIL"); - commands.add(_smtp_noop, "NOOP"); - commands.add(_smtp_quit, "QUIT"); - commands.add(_smtp_rcpt, "RCPT"); - commands.add(_smtp_rset, "RSET"); - commands.add(_smtp_vrfy, "VRFY"); + IMAPService(core::EPoll &epoll, std::string hostName, std::string mailPath, core::IPAddress ipAddress) + : TCPServer(epoll, ipAddress), mailFileSystem(mailPath), hostName(hostName) { + commands.add(_imap_append, "APPEND"); + commands.add(_imap_authenticate, "AUTHENTCATE"); + commands.add(_imap_check, "CHECK"); + commands.add(_imap_close, "CLOSE"); + commands.add(_imap_copy, "COPY"); + commands.add(_imap_create, "CREATE"); + commands.add(_imap_delete, "DELETE"); + commands.add(_imap_examine, "EXAAMINE"); + commands.add(_imap_expunge, "EXPUNGE"); + commands.add(_imap_fetch, "FETCH"); + commands.add(_imap_list, "LIST"); + commands.add(_imap_login, "LOGIN"); + commands.add(_imap_lsub, "LSUB"); + commands.add(_imap_rename, "RENAME"); + commands.add(_imap_search, "SEARCH"); + commands.add(_imap_select, "SELECT"); + commands.add(_imap_starttls, "STARTTLS"); + commands.add(_imap_status, "STATUS"); + commands.add(_imap_store, "STORE"); + commands.add(_imap_subscribe, "SUBSCRIBE"); + commands.add(_imap_uid, "UID"); + commands.add(_imap_unsubscribe, "UNSUBSCRIBE"); } + + MailFileSystem mailFileSystem; + std::string hostName; private: - __SMTP_AUTH _smtp_auth; - __SMTP_DATA _smtp_data; - __SMTP_EHLO _smtp_ehlo; - __SMTP_HELO _smtp_helo; - __SMTP_MAIL _smtp_mail; - __SMTP_NOOP _smtp_noop; - __SMTP_QUIT _smtp_quit; - __SMTP_RCPT _smtp_rcpt; - __SMTP_RSET _smtp_rset; - __SMTP_VRFY _smtp_vrfy; + __IMAP_APPEND _imap_append; + __IMAP_AUTHENTICATE _imap_authenticate; + __IMAP_CHECK _imap_check; + __IMAP_CLOSE _imap_close; + __IMAP_COPY _imap_copy; + __IMAP_CREATE _imap_create; + __IMAP_DELETE _imap_delete; + __IMAP_EXAMINE _imap_examine; + __IMAP_EXPUNGE _imap_expunge; + __IMAP_FETCH _imap_fetch; + __IMAP_LIST _imap_list; + __IMAP_LOGIN _imap_login; + __IMAP_LSUB _imap_lsub; + __IMAP_RENAME _imap_rename; + __IMAP_SEARCH _imap_search; + __IMAP_SELECT _imap_select; + __IMAP_STARTTLS _imap_starttls; + __IMAP_STATUS _imap_status; + __IMAP_STORE _imap_store; + __IMAP_SUBSCRIBE _imap_subscribe; + __IMAP_UID _imap_uid; + __IMAP_UNSUBSCRIBE _imap_unsubscribe; }; diff --git a/IMAPSession.h b/IMAPSession.h new file mode 100644 index 0000000..27dee61 --- /dev/null +++ b/IMAPSession.h @@ -0,0 +1,21 @@ +#ifndef __IMAPSession_h__ +#define __IMAPSession_h__ + +namespace mail { + + class IMAPSession : public core::TCPSession { + + public: + + std::string clientDomainName; + std::string userName; + std::string password; + AuthState authstate = USER_UNKNOWN; + bool relay = false; + + + }; + +} + +#endif diff --git a/MailDelivery.cpp2 b/MailDelivery.cpp2 new file mode 100644 index 0000000..f7667fd --- /dev/null +++ b/MailDelivery.cpp2 @@ -0,0 +1,58 @@ +#include "MailDelivery.h" +#include "Directory.h" +#include "time.h" + +namespace mail { + + MailDelivery::MailDelivery(core::EPoll &ePoll, std::string mailQueue) : INotify(ePoll) { + addWatch(mailQueue); + startDelivery(mailQueue); + } + + void MailDelivery::onDataReceived(std::string data) { + + // TODO: Receive file and parse email name. + + // TODO: Compare time to named time and if time has passed then send the message + // TODO: If email is a local mailbox then make a hard link to the mail message in the appropriate Inbox. Remove entry from queue. + // TODO: If email is a remote mailbox then perform remote send algorithm. + // TODO: If error sending on remote then calculate next send attempt time and rename file to reflect new time. + // TODO: If date is on the future then set a timer to that time and wait. + + } + + int MailDelivery::startDelivery(std::string mailQueue) { + coreutils::Directory mailDir(mailQueue); + std::string entryName = mailDir.get().getName(); + std::string now = getMailFileName(); +// if(now > entryName) { +// std::string recipientName = coreutils::File(); // read recipient name +// if(isLocal(recipientName)) { +// link(existing, new); +// } else { + // open connect socket to mx.domain + // if error + // calculate future date name and rename mail data + // else + // write smtp data on socket 25 + // +// } + // } + } + + int MailDelivery::deliver() { + + + } + + std::string MailDelivery::getMailFileName() { + char fileName[64]; + time_t gtime; + time(>ime); + struct tm *timex; + timex = gmtime(>ime); + strftime(fileName, 64, "%Y%m%d%H%M%S", gmtime(>ime)); + return std::string(fileName); + } + +} diff --git a/MailDelivery.h2 b/MailDelivery.h2 new file mode 100644 index 0000000..a02b3ef --- /dev/null +++ b/MailDelivery.h2 @@ -0,0 +1,24 @@ +#ifndef __MailDelivery_h__ +# define __MailDelivery_h__ + +# include "INotify.h" +# include "EPoll.h" + +namespace mail { + + class MailDelivery : core::INotify { + + public: + MailDelivery(core::EPoll &ePoll, std::string mailQueue); + + void onDataReceived(std::string data) override; + + int startDelivery(std::string mailQueue); + int deliver(); + std::string getMailFileName(); + + }; + +} + +#endif diff --git a/MailFileSystem.h b/MailFileSystem.h new file mode 100644 index 0000000..5aa6978 --- /dev/null +++ b/MailFileSystem.h @@ -0,0 +1,52 @@ +#ifndef __MailFileSystem_h__ +# define __MailFileSystem_h__ + +# include +# include +# include +# include "EPoll.h" +# include "INotify.h" + +namespace mail { + + class MailFileSystem { + + public: + MailFileSystem(std::string mailPath) : mailPath(mailPath) {} + + bool ifMailBoxExists(std::string mailbox) { + if(stat(getMailBoxPath(mailbox).c_str(), &statbuf) != -1) + if(S_ISDIR(statbuf.st_mode)) + return true; + return false; + } + + bool ifAliasExists(std::string alias) { + if(stat(getMailBoxPath(alias).c_str(), &statbuf) != -1) + if(S_ISREG(statbuf.st_mode)) + return true; + return false; + } + + std::string getMailBoxPath(std::string mailbox) { + coreutils::PString email(mailbox); + email.split("@"); + std::string path = mailPath + "/" + email[1].str() + "/" + email[0].str(); + return path; + } + + std::vector getAliasMailboxes(std::string alias); + + std::string getMailPath() { + return mailPath; + } + + private: + std::string mailPath; + struct stat statbuf; + + }; + +} + +#endif diff --git a/POP3Command.h b/POP3Command.h new file mode 100644 index 0000000..2918e2d --- /dev/null +++ b/POP3Command.h @@ -0,0 +1,24 @@ +#ifndef __POP3Command_h__ +# define __POP3Command_h__ + +# include "Command.h" +# include "TCPSession.h" +# include "POP3Session.h" + +namespace mail { + + class POP3Command : public core::Command { + + public: + virtual int processCommand(std::string request, core::TCPSession *session, std::stringstream &data) override { + coreutils::PString parser(request); + return processCommand(parser, (POP3Session &)*session, data); + } + + virtual int processCommand(coreutils::PString request, POP3Session &session, std::stringstream &data) {} + + }; + +} + +#endif diff --git a/POP3Service.h b/POP3Service.h index 61d0593..45d5188 100644 --- a/POP3Service.h +++ b/POP3Service.h @@ -1,48 +1,58 @@ #ifndef __POP3Service_h__ #define __POP3Service_h__ -#include "Service.h" +#include "TCPServer.h" #include "Exception.h" -#include "__SMTP_AUTH.h" -#include "__SMTP_DATA.h" -#include "__SMTP_EHLO.h" -#include "__SMTP_HELO.h" -#include "__SMTP_MAIL.h" -#include "__SMTP_NOOP.h" -#include "__SMTP_QUIT.h" -#include "__SMTP_RCPT.h" -#include "__SMTP_RSET.h" -#include "__SMTP_VRFY.h" +#include "__POP3_DELE.h" +#include "__POP3_LAST.h" +#include "__POP3_LIST.h" +#include "__POP3_NOOP.h" +#include "__POP3_PASS.h" +#include "__POP3_QUIT.h" +#include "__POP3_RETR.h" +#include "__POP3_RPOP.h" +#include "__POP3_RSET.h" +#include "__POP3_STAT.h" +#include "__POP3_TOP.h" +#include "__POP3_USER.h" namespace mail { - class POP3Service : public core::Service { + class POP3Service : public core::TCPServer { public: - POP3Service() { - commands.add(_smtp_auth, "AUTH"); - commands.add(_smtp_data, "DATA"); - commands.add(_smtp_ehlo, "EHLO"); - commands.add(_smtp_helo, "HELO"); - commands.add(_smtp_mail, "MAIL"); - commands.add(_smtp_noop, "NOOP"); - commands.add(_smtp_quit, "QUIT"); - commands.add(_smtp_rcpt, "RCPT"); - commands.add(_smtp_rset, "RSET"); - commands.add(_smtp_vrfy, "VRFY"); + POP3Service(core::EPoll &epoll, std::string hostName, std::string mailPath, core::IPAddress ipAddress) + : TCPServer(epoll, ipAddress), mailFileSystem(mailPath), hostName(hostName) { + commands.add(_pop3_dele, "DELE"); + commands.add(_pop3_last, "LAST"); + commands.add(_pop3_list, "LIST"); + commands.add(_pop3_noop, "NOOP"); + commands.add(_pop3_pass, "PASS"); + commands.add(_pop3_quit, "QUIT"); + commands.add(_pop3_retr, "RETR"); + commands.add(_pop3_rpop, "RPOP"); + commands.add(_pop3_rset, "RSET"); + commands.add(_pop3_stat, "STAT"); + commands.add(_pop3_top, "TOP"); + commands.add(_pop3_user, "USER"); } + + MailFileSystem mailFileSystem; + std::string hostName; private: - __SMTP_AUTH _smtp_auth; - __SMTP_DATA _smtp_data; - __SMTP_EHLO _smtp_ehlo; - __SMTP_HELO _smtp_helo; - __SMTP_MAIL _smtp_mail; - __SMTP_NOOP _smtp_noop; - __SMTP_QUIT _smtp_quit; - __SMTP_RCPT _smtp_rcpt; - __SMTP_RSET _smtp_rset; - __SMTP_VRFY _smtp_vrfy; + __POP3_DELE _pop3_dele; + __POP3_LAST _pop3_last; + __POP3_LIST _pop3_list; + __POP3_NOOP _pop3_noop; + __POP3_PASS _pop3_pass; + __POP3_QUIT _pop3_quit; + __POP3_RETR _pop3_retr; + __POP3_RPOP _pop3_rpop; + __POP3_RSET _pop3_rset; + __POP3_STAT _pop3_stat; + __POP3_TOP _pop3_top; + __POP3_USER _pop3_user; }; diff --git a/POP3Session.h b/POP3Session.h new file mode 100644 index 0000000..037461c --- /dev/null +++ b/POP3Session.h @@ -0,0 +1,20 @@ +#ifndef __POP3Session_h__ +#define __POP3Session_h__ + +namespace mail { + + class POP3Session : public core::TCPSession { + + public: + std::string clientDomainName; + std::string userName; + std::string password; + AuthState authstate = USER_UNKNOWN; + bool relay = false; + + + }; + +} + +#endif diff --git a/SMTPCommand.cpp b/SMTPCommand.cpp new file mode 100644 index 0000000..811bd02 --- /dev/null +++ b/SMTPCommand.cpp @@ -0,0 +1,15 @@ +# include "Command.h" +# include "SMTPSession.h" +# include "SMTPServer.h" +# include "Log.h" + +namespace mail { + + int SMTPCommand::processCommand(std::string request, core::TCPSession *session, std::stringstream &data) { + coreutils::PString parser(request); + parser.split(" "); + return processCommand(parser, (SMTPSession &)*session, (SMTPServer &)session->server, data); + } + +} + diff --git a/SMTPCommand.h b/SMTPCommand.h new file mode 100644 index 0000000..6e0511c --- /dev/null +++ b/SMTPCommand.h @@ -0,0 +1,21 @@ +#ifndef __SMTPCommand_h__ +# define __SMTPCommand_h__ + +# include "Command.h" +# include "SMTPSession.h" + +namespace mail { + + class SMTPServer; + + class SMTPCommand : public core::Command { + + public: + virtual int processCommand(std::string request, core::TCPSession *session, std::stringstream &data) override; + virtual int processCommand(coreutils::PString request, SMTPSession &session, SMTPServer &server, std::stringstream &data) {} + + }; + +} + +#endif diff --git a/SMTPServer.h b/SMTPServer.h new file mode 100644 index 0000000..9c2a5d9 --- /dev/null +++ b/SMTPServer.h @@ -0,0 +1,91 @@ +#ifndef __SMTPServer_h__ +# define __SMTPServer_h__ + +# include +# include "EPoll.h" +# include "TCPServer.h" +# include "SMTPSession.h" +# include "MailFileSystem.h" +# include "__SMTP_AUTH.h" +# include "__SMTP_DATA.h" +# include "__SMTP_EHLO.h" +# include "__SMTP_HELO.h" +# include "__SMTP_MAIL.h" +# include "__SMTP_NOOP.h" +# include "__SMTP_QUIT.h" +# include "__SMTP_RCPT.h" +# include "__SMTP_RSET.h" +# include "__SMTP_VRFY.h" +# include "INotify.h" +# include "Log.h" + +namespace mail { + + class SMTPServer : public core::TCPServer, public core::INotify { + + public: + SMTPServer(core::EPoll &ePoll, std::string hostName, std::string mailPath, core::IPAddress ipAddress) + : core::TCPServer(ePoll, ipAddress, "SMTP Server"), core::INotify(ePoll), hostName(hostName), mailFileSystem(mailPath) { + this->mailPath = mailPath; + commands.add(_smtp_auth, "AUTH"); + commands.add(_smtp_data, "DATA"); + commands.add(_smtp_ehlo, "EHLO"); + commands.add(_smtp_helo, "HELO"); + commands.add(_smtp_mail, "MAIL"); + commands.add(_smtp_noop, "NOOP"); + commands.add(_smtp_quit, "QUIT"); + commands.add(_smtp_rcpt, "RCPT"); + commands.add(_smtp_rset, "RSET"); + commands.add(_smtp_vrfy, "VRFY"); + processExisting(); + wd = addWatch(mailPath + "/.queue/"); + } + + MailFileSystem mailFileSystem; + std::string hostName; + std::string mailPath; + + SMTPSession * getSocketAccept(core::EPoll &ePoll) override { + return new SMTPSession(ePoll, *this); + } + + void sessionErrorHandler(std::string errorString, std::stringstream &out) { + out << "252 " << errorString << CRLF; + } + + protected: + void inCreate(std::string name) { + int pos = name.find(".") + 10; + std::string mail = name.substr(0, pos); + std::string recipient = name.substr(pos); + if(recipient != "") { + std::string fileName = mailPath + "/.queue/" + name; + std::string path = mailFileSystem.getMailBoxPath(recipient) + "/Inbox/" + mail; + int rc = link(fileName.c_str(), path.c_str()); + rc = unlink(fileName.c_str()); + coreutils::Log(coreutils::LOG_INFO) << "Message " << mail << " delivered to " << recipient << "."; + } + } + + private: + __SMTP_AUTH _smtp_auth; + __SMTP_DATA _smtp_data; + __SMTP_EHLO _smtp_ehlo; + __SMTP_HELO _smtp_helo; + __SMTP_MAIL _smtp_mail; + __SMTP_NOOP _smtp_noop; + __SMTP_QUIT _smtp_quit; + __SMTP_RCPT _smtp_rcpt; + __SMTP_RSET _smtp_rset; + __SMTP_VRFY _smtp_vrfy; + int wd; + + void processExisting() { + + } + + }; + +} + +#endif diff --git a/SMTPService.h b/SMTPService.h deleted file mode 100644 index ebfd60c..0000000 --- a/SMTPService.h +++ /dev/null @@ -1,51 +0,0 @@ -#ifndef __SMTPService_h__ -#define __SMTPService_h__ - -#include "Service.h" -#include "Exception.h" -#include "__SMTP_AUTH.h" -#include "__SMTP_DATA.h" -#include "__SMTP_EHLO.h" -#include "__SMTP_HELO.h" -#include "__SMTP_MAIL.h" -#include "__SMTP_NOOP.h" -#include "__SMTP_QUIT.h" -#include "__SMTP_RCPT.h" -#include "__SMTP_RSET.h" -#include "__SMTP_VRFY.h" - -namespace mail { - - class SMTPService : public core::Service { - - public: - SMTPService() { - commands.add(_smtp_auth, "AUTH"); - commands.add(_smtp_data, "DATA"); - commands.add(_smtp_ehlo, "EHLO"); - commands.add(_smtp_helo, "HELO"); - commands.add(_smtp_mail, "MAIL"); - commands.add(_smtp_noop, "NOOP"); - commands.add(_smtp_quit, "QUIT"); - commands.add(_smtp_rcpt, "RCPT"); - commands.add(_smtp_rset, "RSET"); - commands.add(_smtp_vrfy, "VRFY"); - } - - private: - __SMTP_AUTH _smtp_auth; - __SMTP_DATA _smtp_data; - __SMTP_EHLO _smtp_ehlo; - __SMTP_HELO _smtp_helo; - __SMTP_MAIL _smtp_mail; - __SMTP_NOOP _smtp_noop; - __SMTP_QUIT _smtp_quit; - __SMTP_RCPT _smtp_rcpt; - __SMTP_RSET _smtp_rset; - __SMTP_VRFY _smtp_vrfy; - - }; - -} - -#endif diff --git a/SMTPSession.h b/SMTPSession.h index 045f8f7..51ba56b 100644 --- a/SMTPSession.h +++ b/SMTPSession.h @@ -1,14 +1,37 @@ #ifndef __SMTPSession_h__ -#define __SMTPSession_h__ +# define __SMTPSession_h__ -#include "includes" +# include "TCPSession.h" +# include "TCPServer.h" + +# define CRLF "\r\n" namespace mail { + + enum State {CONNECT, READY, MAIL, RCPT, DATA}; + enum AuthState {USER_UNKNOWN, USER_QUERY, USER_SECRET_QUERY, USER_KNOWN}; + enum Mode {WAIT_FOR_DATA, RECEIVE_DATA}; + + class SMTPSession : public core::TCPSession { + + public: + SMTPSession(core::EPoll &ePoll, core::TCPServer &server) + : TCPSession(ePoll, server, "SMTP Client Session") {} - class SMTPSession : public core::Session { - - public: - std::string state; + void onConnected(std::stringstream &out) { + out << "220 localhost BMAMail" << CRLF; + } + + std::string clientDomainName; + std::string userName; + std::string password; + std::stringstream mailData; + State state = CONNECT; + AuthState authState = USER_UNKNOWN; + Mode mode = WAIT_FOR_DATA; + bool relay = false; + std::string sender; + std::vector recipientList; }; diff --git a/__IMAP_APPEND.h b/__IMAP_APPEND.h new file mode 100644 index 0000000..74a3177 --- /dev/null +++ b/__IMAP_APPEND.h @@ -0,0 +1,19 @@ +#ifndef ____IMAP_APPEND_h__ +# define ____IMAP_APPEND_h__ + +# include "IMAPCommand.h" +# include "IMAPSession.h" + +namespace mail { + + class __IMAP_APPEND : public IMAPCommand { + + int processCommand(coreutils::PString request, IMAPSession &session, std::stringstream &data) { + data << "250 OK" << CRLF; + } + + }; + +} + +#endif diff --git a/__IMAP_AUTHENTICATE.h b/__IMAP_AUTHENTICATE.h new file mode 100644 index 0000000..bacf7a6 --- /dev/null +++ b/__IMAP_AUTHENTICATE.h @@ -0,0 +1,19 @@ +#ifndef ____IMAP_AUTHENTICATE_h__ +# define ____IMAP_AUTHENTICATE_h__ + +# include "IMAPCommand.h" +# include "IMAPSession.h" + +namespace mail { + + class __IMAP_AUTHENTICATE : public IMAPCommand { + + int processCommand(coreutils::PString request, IMAPSession &session, std::stringstream &data) { + data << "250 OK" << CRLF; + } + + }; + +} + +#endif diff --git a/__IMAP_CHECK.h b/__IMAP_CHECK.h new file mode 100644 index 0000000..52d9194 --- /dev/null +++ b/__IMAP_CHECK.h @@ -0,0 +1,19 @@ +#ifndef ____IMAP_CHECK_h__ +# define ____IMAP_CHECK_h__ + +# include "IMAPCommand.h" +# include "IMAPSession.h" + +namespace mail { + + class __IMAP_CHECK : public IMAPCommand { + + int processCommand(coreutils::PString request, IMAPSession &session, std::stringstream &data) { + data << "250 OK" << CRLF; + } + + }; + +} + +#endif diff --git a/__IMAP_CLOSE.h b/__IMAP_CLOSE.h new file mode 100644 index 0000000..ba9eaa3 --- /dev/null +++ b/__IMAP_CLOSE.h @@ -0,0 +1,19 @@ +#ifndef ____IMAP_CLOSE_h__ +# define ____IMAP_CLOSE_h__ + +# include "IMAPCommand.h" +# include "IMAPSession.h" + +namespace mail { + + class __IMAP_CLOSE : public IMAPCommand { + + int processCommand(coreutils::PString request, IMAPSession &session, std::stringstream &data) { + data << "250 OK" << CRLF; + } + + }; + +} + +#endif diff --git a/__IMAP_COPY.h b/__IMAP_COPY.h new file mode 100644 index 0000000..bf83189 --- /dev/null +++ b/__IMAP_COPY.h @@ -0,0 +1,19 @@ +#ifndef ____IMAP_COPY_h__ +# define ____IMAP_COPY_h__ + +# include "IMAPCommand.h" +# include "IMAPSession.h" + +namespace mail { + + class __IMAP_COPY : public IMAPCommand { + + int processCommand(coreutils::PString request, IMAPSession &session, std::stringstream &data) { + data << "250 OK" << CRLF; + } + + }; + +} + +#endif diff --git a/__IMAP_CREATE.h b/__IMAP_CREATE.h new file mode 100644 index 0000000..ca6c007 --- /dev/null +++ b/__IMAP_CREATE.h @@ -0,0 +1,19 @@ +#ifndef ____IMAP_CREATE_h__ +# define ____IMAP_CREATE_h__ + +# include "IMAPCommand.h" +# include "IMAPSession.h" + +namespace mail { + + class __IMAP_CREATE : public IMAPCommand { + + int processCommand(coreutils::PString request, IMAPSession &session, std::stringstream &data) { + data << "250 OK" << CRLF; + } + + }; + +} + +#endif diff --git a/__IMAP_DELETE.h b/__IMAP_DELETE.h new file mode 100644 index 0000000..2ef78de --- /dev/null +++ b/__IMAP_DELETE.h @@ -0,0 +1,19 @@ +#ifndef ____IMAP_DELETE_h__ +# define ____IMAP_DELETE_h__ + +# include "IMAPCommand.h" +# include "IMAPSession.h" + +namespace mail { + + class __IMAP_DELETE : public IMAPCommand { + + int processCommand(coreutils::PString request, IMAPSession &session, std::stringstream &data) { + data << "250 OK" << CRLF; + } + + }; + +} + +#endif diff --git a/__IMAP_EXAMINE.h b/__IMAP_EXAMINE.h new file mode 100644 index 0000000..2d2795c --- /dev/null +++ b/__IMAP_EXAMINE.h @@ -0,0 +1,19 @@ +#ifndef ____IMAP_EXAMINE_h__ +# define ____IMAP_EXAMINE_h__ + +# include "IMAPCommand.h" +# include "IMAPSession.h" + +namespace mail { + + class __IMAP_EXAMINE : public IMAPCommand { + + int processCommand(coreutils::PString request, IMAPSession &session, std::stringstream &data) { + data << "250 OK" << CRLF; + } + + }; + +} + +#endif diff --git a/__IMAP_EXPUNGE.h b/__IMAP_EXPUNGE.h new file mode 100644 index 0000000..2fb5b25 --- /dev/null +++ b/__IMAP_EXPUNGE.h @@ -0,0 +1,19 @@ +#ifndef ____IMAP_EXPUNGE_h__ +# define ____IMAP_EXPUNGE_h__ + +# include "IMAPCommand.h" +# include "IMAPSession.h" + +namespace mail { + + class __IMAP_EXPUNGE : public IMAPCommand { + + int processCommand(coreutils::PString request, IMAPSession &session, std::stringstream &data) { + data << "250 OK" << CRLF; + } + + }; + +} + +#endif diff --git a/__IMAP_FETCH.h b/__IMAP_FETCH.h new file mode 100644 index 0000000..b2e15c5 --- /dev/null +++ b/__IMAP_FETCH.h @@ -0,0 +1,19 @@ +#ifndef ____IMAP_FETCH_h__ +# define ____IMAP_FETCH_h__ + +# include "IMAPCommand.h" +# include "IMAPSession.h" + +namespace mail { + + class __IMAP_FETCH : public IMAPCommand { + + int processCommand(coreutils::PString request, IMAPSession &session, std::stringstream &data) { + data << "250 OK" << CRLF; + } + + }; + +} + +#endif diff --git a/__IMAP_LIST.h b/__IMAP_LIST.h new file mode 100644 index 0000000..9122240 --- /dev/null +++ b/__IMAP_LIST.h @@ -0,0 +1,19 @@ +#ifndef ____IMAP_LIST_h__ +# define ____IMAP_LIST_h__ + +# include "IMAPCommand.h" +# include "IMAPSession.h" + +namespace mail { + + class __IMAP_LIST : public IMAPCommand { + + int processCommand(coreutils::PString request, IMAPSession &session, std::stringstream &data) { + data << "250 OK" << CRLF; + } + + }; + +} + +#endif diff --git a/__IMAP_LOGIN.h b/__IMAP_LOGIN.h new file mode 100644 index 0000000..582edcf --- /dev/null +++ b/__IMAP_LOGIN.h @@ -0,0 +1,19 @@ +#ifndef ____IMAP_LOGIN_h__ +# define ____IMAP_LOGIN_h__ + +# include "IMAPCommand.h" +# include "IMAPSession.h" + +namespace mail { + + class __IMAP_LOGIN : public IMAPCommand { + + int processCommand(coreutils::PString request, IMAPSession &session, std::stringstream &data) { + data << "250 OK" << CRLF; + } + + }; + +} + +#endif diff --git a/__IMAP_LSUB.h b/__IMAP_LSUB.h new file mode 100644 index 0000000..1282085 --- /dev/null +++ b/__IMAP_LSUB.h @@ -0,0 +1,19 @@ +#ifndef ____IMAP_LSUB_h__ +# define ____IMAP_LSUB_h__ + +# include "IMAPCommand.h" +# include "IMAPSession.h" + +namespace mail { + + class __IMAP_LSUB : public IMAPCommand { + + int processCommand(coreutils::PString request, IMAPSession &session, std::stringstream &data) { + data << "250 OK" << CRLF; + } + + }; + +} + +#endif diff --git a/__IMAP_RENAME.h b/__IMAP_RENAME.h new file mode 100644 index 0000000..20e57cb --- /dev/null +++ b/__IMAP_RENAME.h @@ -0,0 +1,19 @@ +#ifndef ____IMAP_RENAME_h__ +# define ____IMAP_RENAME_h__ + +# include "IMAPCommand.h" +# include "IMAPSession.h" + +namespace mail { + + class __IMAP_RENAME : public IMAPCommand { + + int processCommand(coreutils::PString request, IMAPSession &session, std::stringstream &data) { + data << "250 OK" << CRLF; + } + + }; + +} + +#endif diff --git a/__IMAP_SEARCH.h b/__IMAP_SEARCH.h new file mode 100644 index 0000000..9520c3d --- /dev/null +++ b/__IMAP_SEARCH.h @@ -0,0 +1,19 @@ +#ifndef ____IMAP_SEARCH_h__ +# define ____IMAP_SEARCH_h__ + +# include "IMAPCommand.h" +# include "IMAPSession.h" + +namespace mail { + + class __IMAP_SEARCH : public IMAPCommand { + + int processCommand(coreutils::PString request, IMAPSession &session, std::stringstream &data) { + data << "250 OK" << CRLF; + } + + }; + +} + +#endif diff --git a/__IMAP_SELECT.h b/__IMAP_SELECT.h new file mode 100644 index 0000000..9cb7de5 --- /dev/null +++ b/__IMAP_SELECT.h @@ -0,0 +1,19 @@ +#ifndef ____IMAP_SELECT_h__ +# define ____IMAP_SELECT_h__ + +# include "IMAPCommand.h" +# include "IMAPSession.h" + +namespace mail { + + class __IMAP_SELECT : public IMAPCommand { + + int processCommand(coreutils::PString request, IMAPSession &session, std::stringstream &data) { + data << "250 OK" << CRLF; + } + + }; + +} + +#endif diff --git a/__IMAP_STARTTLS.h b/__IMAP_STARTTLS.h new file mode 100644 index 0000000..60a58f5 --- /dev/null +++ b/__IMAP_STARTTLS.h @@ -0,0 +1,19 @@ +#ifndef ____IMAP_STARTTLS_h__ +# define ____IMAP_STARTTLS_h__ + +# include "IMAPCommand.h" +# include "IMAPSession.h" + +namespace mail { + + class __IMAP_STARTTLS : public IMAPCommand { + + int processCommand(coreutils::PString request, IMAPSession &session, std::stringstream &data) { + data << "250 OK" << CRLF; + } + + }; + +} + +#endif diff --git a/__IMAP_STATUS.h b/__IMAP_STATUS.h new file mode 100644 index 0000000..b226f51 --- /dev/null +++ b/__IMAP_STATUS.h @@ -0,0 +1,19 @@ +#ifndef ____IMAP_STATUS_h__ +# define ____IMAP_STATUS_h__ + +# include "IMAPCommand.h" +# include "IMAPSession.h" + +namespace mail { + + class __IMAP_STATUS : public IMAPCommand { + + int processCommand(coreutils::PString request, IMAPSession &session, std::stringstream &data) { + data << "250 OK" << CRLF; + } + + }; + +} + +#endif diff --git a/__IMAP_STORE.h b/__IMAP_STORE.h new file mode 100644 index 0000000..0e997d7 --- /dev/null +++ b/__IMAP_STORE.h @@ -0,0 +1,19 @@ +#ifndef ____IMAP_STORE_h__ +# define ____IMAP_STORE_h__ + +# include "IMAPCommand.h" +# include "IMAPSession.h" + +namespace mail { + + class __IMAP_STORE : public IMAPCommand { + + int processCommand(coreutils::PString request, IMAPSession &session, std::stringstream &data) { + data << "250 OK" << CRLF; + } + + }; + +} + +#endif diff --git a/__IMAP_SUBSCRIBE.h b/__IMAP_SUBSCRIBE.h new file mode 100644 index 0000000..de3d551 --- /dev/null +++ b/__IMAP_SUBSCRIBE.h @@ -0,0 +1,19 @@ +#ifndef ____IMAP_SUBSCRIBE_h__ +# define ____IMAP_SUBSCRIBE_h__ + +# include "IMAPCommand.h" +# include "IMAPSession.h" + +namespace mail { + + class __IMAP_SUBSCRIBE : public IMAPCommand { + + int processCommand(coreutils::PString request, IMAPSession &session, std::stringstream &data) { + data << "250 OK" << CRLF; + } + + }; + +} + +#endif diff --git a/__IMAP_UID.h b/__IMAP_UID.h new file mode 100644 index 0000000..e09d892 --- /dev/null +++ b/__IMAP_UID.h @@ -0,0 +1,19 @@ +#ifndef ____IMAP_UID_h__ +# define ____IMAP_UID_h__ + +# include "IMAPCommand.h" +# include "IMAPSession.h" + +namespace mail { + + class __IMAP_UID : public IMAPCommand { + + int processCommand(coreutils::PString request, IMAPSession &session, std::stringstream &data) { + data << "250 OK" << CRLF; + } + + }; + +} + +#endif diff --git a/__IMAP_UNSUBSCRIBE.h b/__IMAP_UNSUBSCRIBE.h new file mode 100644 index 0000000..4984ce5 --- /dev/null +++ b/__IMAP_UNSUBSCRIBE.h @@ -0,0 +1,19 @@ +#ifndef ____IMAP_UNSUBSCRIBE_h__ +# define ____IMAP_UNSUBSCRIBE_h__ + +# include "IMAPCommand.h" +# include "IMAPSession.h" + +namespace mail { + + class __IMAP_UNSUBSCRIBE : public IMAPCommand { + + int processCommand(coreutils::PString request, IMAPSession &session, std::stringstream &data) { + data << "250 OK" << CRLF; + } + + }; + +} + +#endif diff --git a/__POP3_DELE.h b/__POP3_DELE.h new file mode 100644 index 0000000..ce2c8a3 --- /dev/null +++ b/__POP3_DELE.h @@ -0,0 +1,19 @@ +#ifndef ____POP3_DELE_h__ +# define ____POP3_DELE_h__ + +# include "POP3Command.h" +# include "POP3Session.h" + +namespace mail { + + class __POP3_DELE : public POP3Command { + + int processCommand(coreutils::PString request, POP3Session &session, std::stringstream &data) { + data << "250 OK" << CRLF; + } + + }; + +} + +#endif diff --git a/__POP3_LAST.h b/__POP3_LAST.h new file mode 100644 index 0000000..5b915de --- /dev/null +++ b/__POP3_LAST.h @@ -0,0 +1,19 @@ +#ifndef ____POP3_LAST_h__ +# define ____POP3_LAST_h__ + +# include "POP3Command.h" +# include "POP3Session.h" + +namespace mail { + + class __POP3_LAST : public POP3Command { + + int processCommand(coreutils::PString request, POP3Session &session, std::stringstream &data) { + data << "250 OK" << CRLF; + } + + }; + +} + +#endif diff --git a/__POP3_LIST.h b/__POP3_LIST.h new file mode 100644 index 0000000..ce44506 --- /dev/null +++ b/__POP3_LIST.h @@ -0,0 +1,19 @@ +#ifndef ____POP3_LIST_h__ +# define ____POP3_LIST_h__ + +# include "POP3Command.h" +# include "POP3Session.h" + +namespace mail { + + class __POP3_LIST : public POP3Command { + + int processCommand(coreutils::PString request, POP3Session &session, std::stringstream &data) { + data << "250 OK" << CRLF; + } + + }; + +} + +#endif diff --git a/__POP3_NOOP.h b/__POP3_NOOP.h new file mode 100644 index 0000000..7c248a6 --- /dev/null +++ b/__POP3_NOOP.h @@ -0,0 +1,19 @@ +#ifndef ____POP3_NOOP_h__ +# define ____POP3_NOOP_h__ + +# include "POP3Command.h" +# include "POP3Session.h" + +namespace mail { + + class __POP3_NOOP : public POP3Command { + + int processCommand(coreutils::PString request, POP3Session &session, std::stringstream &data) { + data << "250 OK" << CRLF; + } + + }; + +} + +#endif diff --git a/__POP3_PASS.h b/__POP3_PASS.h new file mode 100644 index 0000000..3746337 --- /dev/null +++ b/__POP3_PASS.h @@ -0,0 +1,19 @@ +#ifndef ____POP3_PASS_h__ +# define ____POP3_PASS_h__ + +# include "POP3Command.h" +# include "POP3Session.h" + +namespace mail { + + class __POP3_PASS : public POP3Command { + + int processCommand(coreutils::PString request, POP3Session &session, std::stringstream &data) { + data << "250 OK" << CRLF; + } + + }; + +} + +#endif diff --git a/__POP3_QUIT.h b/__POP3_QUIT.h new file mode 100644 index 0000000..991ec03 --- /dev/null +++ b/__POP3_QUIT.h @@ -0,0 +1,19 @@ +#ifndef ____POP3_QUIT_h__ +# define ____POP3_QUIT_h__ + +# include "POP3Command.h" +# include "POP3Session.h" + +namespace mail { + + class __POP3_QUIT : public POP3Command { + + int processCommand(coreutils::PString request, POP3Session &session, std::stringstream &data) { + data << "250 OK" << CRLF; + } + + }; + +} + +#endif diff --git a/__POP3_RETR.h b/__POP3_RETR.h new file mode 100644 index 0000000..6d1d30f --- /dev/null +++ b/__POP3_RETR.h @@ -0,0 +1,19 @@ +#ifndef ____POP3_RETR_h__ +# define ____POP3_RETR_h__ + +# include "POP3Command.h" +# include "POP3Session.h" + +namespace mail { + + class __POP3_RETR : public POP3Command { + + int processCommand(coreutils::PString request, POP3Session &session, std::stringstream &data) { + data << "250 OK" << CRLF; + } + + }; + +} + +#endif diff --git a/__POP3_RPOP.h b/__POP3_RPOP.h new file mode 100644 index 0000000..3b5252a --- /dev/null +++ b/__POP3_RPOP.h @@ -0,0 +1,19 @@ +#ifndef ____POP3_RPOP_h__ +# define ____POP3_RPOP_h__ + +# include "POP3Command.h" +# include "POP3Session.h" + +namespace mail { + + class __POP3_RPOP : public POP3Command { + + int processCommand(coreutils::PString request, POP3Session &session, std::stringstream &data) { + data << "250 OK" << CRLF; + } + + }; + +} + +#endif diff --git a/__POP3_RSET.h b/__POP3_RSET.h new file mode 100644 index 0000000..6fc4f89 --- /dev/null +++ b/__POP3_RSET.h @@ -0,0 +1,19 @@ +#ifndef ____POP3_RSET_h__ +# define ____POP3_RSET_h__ + +# include "POP3Command.h" +# include "POP3Session.h" + +namespace mail { + + class __POP3_RSET : public POP3Command { + + int processCommand(coreutils::PString request, POP3Session &session, std::stringstream &data) { + data << "250 OK" << CRLF; + } + + }; + +} + +#endif diff --git a/__POP3_STAT.h b/__POP3_STAT.h new file mode 100644 index 0000000..5b4bfc7 --- /dev/null +++ b/__POP3_STAT.h @@ -0,0 +1,19 @@ +#ifndef ____POP3_STAT_h__ +# define ____POP3_STAT_h__ + +# include "POP3Command.h" +# include "POP3Session.h" + +namespace mail { + + class __POP3_STAT : public POP3Command { + + int processCommand(coreutils::PString request, POP3Session &session, std::stringstream &data) { + data << "250 OK" << CRLF; + } + + }; + +} + +#endif diff --git a/__POP3_TOP.h b/__POP3_TOP.h new file mode 100644 index 0000000..b046c8a --- /dev/null +++ b/__POP3_TOP.h @@ -0,0 +1,19 @@ +#ifndef ____POP3_TOP_h__ +# define ____POP3_TOP_h__ + +# include "POP3Command.h" +# include "POP3Session.h" + +namespace mail { + + class __POP3_TOP : public POP3Command { + + int processCommand(coreutils::PString request, POP3Session &session, std::stringstream &data) { + data << "250 OK" << CRLF; + } + + }; + +} + +#endif diff --git a/__POP3_USER.h b/__POP3_USER.h new file mode 100644 index 0000000..e69a9f9 --- /dev/null +++ b/__POP3_USER.h @@ -0,0 +1,19 @@ +#ifndef ____POP3_USER_h__ +# define ____POP3_USER_h__ + +# include "POP3Command.h" +# include "POP3Session.h" + +namespace mail { + + class __POP3_USER : public POP3Command { + + int processCommand(coreutils::PString request, POP3Session &session, std::stringstream &data) { + data << "250 OK" << CRLF; + } + + }; + +} + +#endif diff --git a/__SMTP_AUTH.cpp b/__SMTP_AUTH.cpp new file mode 100644 index 0000000..6595872 --- /dev/null +++ b/__SMTP_AUTH.cpp @@ -0,0 +1,70 @@ +#include "__SMTP_AUTH.h" +#include "SMTPServer.h" +#include "Base64.h" + +namespace mail { + + int __SMTP_AUTH::processCommand(coreutils::PString request, SMTPSession &session, SMTPServer &server, std::stringstream &data) { + + switch(session.authState) { + + case USER_UNKNOWN: + if(request[1].str() == "LOGIN") { + + data << "334 VXNlcm5hbWU6" << CRLF; + + // setTimer(10.0f); + + session.authState = USER_QUERY; + session.server.commands.grabInput(&session, *this); + } + else { + data << "504 AUTH method not supported." << CRLF; + } + return 1; + + case USER_QUERY: + + session.userName = request[0].str(); + + // setTimer(0.0f); + + data << "334 UGFzc3dvcmQ6" << CRLF; + + // setTimer(10.0f); + session.authState = USER_SECRET_QUERY; + return 1; + + case USER_SECRET_QUERY: + + session.password = request[0].str(); + + // setTimer(0.0f); + + coreutils::Base64 base64; + + if(authLogin(session.userName, session.password, server)) { + data << "235 2.7.0 Authentication successful" << CRLF; + session.relay = true; + session.authState = USER_KNOWN; + session.server.commands.clearGrab(&session); + } + + else { + data << "530 Login was unsuccessful." << CRLF; + } + return 1; + } + + return 0; + } + + bool __SMTP_AUTH::authLogin(std::string userName, std::string password, SMTPServer &server) { + + std::string secretPath = server.mailFileSystem.getMailBoxPath(userName) + "/.password"; + coreutils::File secret(secretPath); + secret.read(); + return secret.asString() == password; + } + +} diff --git a/__SMTP_AUTH.h b/__SMTP_AUTH.h index 512dd68..5c8e1be 100644 --- a/__SMTP_AUTH.h +++ b/__SMTP_AUTH.h @@ -1,98 +1,22 @@ #ifndef ____SMTP_AUTH_h__ -#define ____SMTP_AUTH_h__ +# define ____SMTP_AUTH_h__ -#include "Command.h" +# include "SMTPCommand.h" +# include "SMTPSession.h" namespace mail { - - class __SMTP_AUTH : public core::Command { + + class SMTPServer; + + class __SMTP_AUTH : public SMTPCommand { - int processCommand(std::string request, Session *session, std::stringstream &data); - - data << "" << std::endl; - - - //--------------------------------------------------------------------------- - // AUTH command request handling. - //--------------------------------------------------------------------------- - - else if(command(input) == "AUTH") { - - if(input.length() > 5) { - string method = input.substr(5); - - string userName; - string password; - - //-------------------------------- - // Check for AUTH LOGIN method. - //-------------------------------- - - if(method == "LOGIN") { - - cout << "334 VXNlcm5hbWU6" << CRLF; - - alarm(10); - - if(!getline(cin, userName)) { - return -1; - } - - alarm(0); - - if(userName[userName.length() - 1] == '\r') - userName.erase(userName.length() - 1); - - cout << "334 UGFzc3dvcmQ6" << CRLF; - - alarm(10); - - if(!getline(cin, password)) { - return -1; - } - alarm(0); - - if(password[password.length() - 1] == '\r') - password.erase(password.length() - 1); - - BASE64 base64; - - log.message("Logging in with user '" + base64.decode(userName) + "' using password '" + base64.decode(password) + "'."); - - if(authLogin(base64.decode(userName), base64.decode(password))) { - cout << "235 Authentication successful" << CRLF; - log.message("Response: 235 Authentication successful."); - relay = true; - } - - else { - cout << "530 Login was unsuccessful." << CRLF; - log.message("Response: 530 Login was unsuccessful."); - } - } - - else { - cout << "530 AUTH method not supported." << CRLF; - log.message("Response: 530 AUTH method not supported."); - } - - } - - else { - - - } - - } + public: + int processCommand(coreutils::PString request, SMTPSession &session, SMTPServer &server, std::stringstream &data); + bool authLogin(std::string userName, std::string password, SMTPServer &server); - httpRequest.response.addHeader("Content-Type", "script/javascript"); - - return 0; - } - }; - + } #endif diff --git a/__SMTP_DATA.cpp b/__SMTP_DATA.cpp new file mode 100644 index 0000000..d956fa0 --- /dev/null +++ b/__SMTP_DATA.cpp @@ -0,0 +1,89 @@ +#include "__SMTP_DATA.h" +#include "SMTPServer.h" +#include "Log.h" +#include +#include + +namespace mail { + + int __SMTP_DATA::processCommand(coreutils::PString request, SMTPSession &session, SMTPServer &server, std::stringstream &data) { + + switch(session.mode) { + + case WAIT_FOR_DATA: + + switch(session.state) { + + case RCPT: + data << "354 Enter the mail message terminated by ." << CRLF; + session.mailData.str(""); + session.mode = RECEIVE_DATA; + session.server.commands.grabInput(&session, *this); + // setTimer(120.0f); + break; + + case MAIL: + data << "503 Please use RCPT first" << CRLF; + break; + + default: + data << "503 Please use MAIL first" << CRLF; + break; + + } + break; + + case RECEIVE_DATA: + if(request.str() != ".") + session.mailData << request.str() << CRLF; + else { + session.mode = WAIT_FOR_DATA; + session.state = READY; + session.server.commands.clearGrab(&session); + // if(filterMessage(session.mailData)) { + if(session.recipientList.size() > 0) { + if(session.mailData.str().size() > 0) { + std::string ID = queueMail(server, session.sender, session.recipientList, session.mailData); + if(ID != "") { + coreutils::Log(coreutils::LOG_INFO) << "Queued message " << ID << "."; + data << "250 OK Queued message " << ID << CRLF; + } + else + data << "550 Mail message too big" << CRLF; + } else + data << "550 Mail message was empty" << CRLF; + } else + data << "250 OK Queued message " << CRLF; + // } else + // data << "550 Message is probably spam" << CRLF; + } + break; + } + } + + std::string __SMTP_DATA::generateMailFileName() { + std::stringstream temp; + struct timespec timex; + clock_gettime(CLOCK_REALTIME, &timex); + temp << timex.tv_sec << "." << std::setfill('0') << std::setw(9) << timex.tv_nsec; + return temp.str(); + } + + std::string __SMTP_DATA::queueMail(SMTPServer &server, std::string sender, std::vector recipientList, std::stringstream &mailData) { + std::string fileName = server.mailFileSystem.getMailPath() + "/.queue/" + generateMailFileName(); + coreutils::File mailFile(fileName, O_CREAT | O_WRONLY, 0660); + mailFile.write(mailData.str()); + + for(std::string recipient: recipientList) { + std::string newName = fileName + recipient; + link(fileName.c_str(), newName.c_str()); + } + + unlink(fileName.c_str()); + + return fileName; + } + +} + + \ No newline at end of file diff --git a/__SMTP_DATA.h b/__SMTP_DATA.h index ceae133..ff31e70 100644 --- a/__SMTP_DATA.h +++ b/__SMTP_DATA.h @@ -1,177 +1,24 @@ #ifndef ____SMTP_DATA_h__ -#define ____SMTP_DATA_h__ +# define ____SMTP_DATA_h__ -#include "Command.h" +# include "SMTPCommand.h" +# include "SMTPSession.h" namespace mail { - - class __SMTP_DATA : public core::Command { + + class SMTPServer; + + class __SMTP_DATA : public SMTPCommand { - int processCommand(std::string request, Session *session, std::stringstream &data); - - data << "" << std::endl; - - //--------------------------------------------------------------------------- - // DATA command request handling. - //--------------------------------------------------------------------------- - - else if(command(input) == "DATA") { - - //-------------------------------------------------------------- - // We must have recipients before we can send data. - //-------------------------------------------------------------- - - if(state == "RCPT") { - - //--------------------------------------------------------- - // Prompt for client to begin entering mail message data. - //--------------------------------------------------------- - - cout << "354 Enter the mail message terminated by ." << CRLF; - - mailData = ""; - - //----------------------------------------------------------- - // Receive mail message one line at a time and keep an eye - // out for the terminating period character. - //----------------------------------------------------------- - - do { - - alarm(120); - - if(!getline(cin, input)) { - return -1; - } - - if(input[input.length() - 1] == '\r') - input.erase(input.length() - 1); - - alarm(0); - if(input != ".") { - - //-------------------------------------------------------------- - // If there was a period for the first character but it wasn't - // the only character then remove and ignore the first period. - // This is the transparency mode capability. - //-------------------------------------------------------------- - - if(input[0] == '.') { - mailData += input.substr(1) + CRLF; - } - - else { - mailData += input + CRLF; - } - - } - - } while(input != "."); - - //------------------------------------------------------------------ - // Run the received message through an external filter program if - // one is configured into the system settings. - //------------------------------------------------------------------ - - string ID; - - if(filterMessage(mailData)) { - - if(recipientList != "") { - - if(mailData.length() > 0) { - - //------------------------------------------------------------------ - // We have the message and we have a list of recipients. Send the - // message to the queue since we know everyone in the recipient - // list has passed the test. - //------------------------------------------------------------------ - - ID = queueMail(sender, recipientList, mailData, clientIP, log, sql, "N"); - - if(ID != "") { - - log.message("Response: 250 OK Queued message " + ID); - - //------------------------------ - // Tell the client we sent it. - //------------------------------ - - cout << "250 OK Queued message " << ID << CRLF; - } - - else { - - log.message("Response: 550 Mail message too big."); - - //--------------------------------- - // Tell the client it was too big. - //--------------------------------- - - cout << "550 Mail message too big" << CRLF; - } - - } - - //------------------------------------------------------------------------ - // The mail message is empty so we are going to error out. We don't like - // getting empty messages. - //------------------------------------------------------------------------ - - else { - - log.message("Response: 550 Mail message was empty."); - cout << "550 Mail message was empty" << CRLF; - - } - - } - - else { - - log.message("Response: 250 OK Queued message. (We actually discarded it due to empty recipient list)"); - - //------------------------------ - // Tell the client we sent it. - //------------------------------ - - cout << "250 OK Queued message " << ID << CRLF; - - } - - } - - //---------------------------------------------------- - // Error out cause it did not pass the filter test. - //---------------------------------------------------- - - else { - - cout << "550 Message is probably spam" << CRLF; - log.message("Response: 550 Message is probably spam."); - } - - //---------------------------- - // Return to the READY state. - //---------------------------- - - state = "READY"; - } - //-------------------------------------------------------- - // Generate an error cause we are not in the right state. - //-------------------------------------------------------- - - else { - - if(state == "MAIL") { - cout << "503 Please use RCPT first" << CRLF; - log.message("Response: 503 Please use RCPT first."); - } - - else { - cout << "503 Please use MAIL first" << CRLF; - log.message("Response: 503 Please use MAIL first."); - } - - } - } + public: + int processCommand(coreutils::PString request, SMTPSession &session, SMTPServer &server, std::stringstream &data); + + std::string generateMailFileName(); + std::string queueMail(SMTPServer &server, std::string sender, std::vector recipientList, std::stringstream &mailData); + + }; + +} + +#endif + \ No newline at end of file diff --git a/__SMTP_EHLO.cpp b/__SMTP_EHLO.cpp new file mode 100644 index 0000000..2a7b538 --- /dev/null +++ b/__SMTP_EHLO.cpp @@ -0,0 +1,19 @@ +#include "__SMTP_EHLO.h" +#include "SMTPServer.h" + +namespace mail { + + int __SMTP_EHLO::processCommand(coreutils::PString request, SMTPSession &session, SMTPServer &server, std::stringstream &data) { + + session.clientDomainName = request[1].str(); + + data << "250-" << server.hostName << CRLF; + // cout << "250-STARTTLS" << CRLF; + // cout << "250-PIPELINING" << CRLF; + // cout << "250-8BITMIME" << CRLF; + data << "250-AUTH LOGIN" << CRLF; + data << "250 HELP" << CRLF; + session.state = READY; + } + +} diff --git a/__SMTP_EHLO.h b/__SMTP_EHLO.h index 8691769..3704d85 100644 --- a/__SMTP_EHLO.h +++ b/__SMTP_EHLO.h @@ -1,30 +1,20 @@ #ifndef ____SMTP_EHLO_h__ -#define ____SMTP_EHLO_h__ +# define ____SMTP_EHLO_h__ -#include "Command.h" +# include "SMTPCommand.h" +# include "SMTPSession.h" namespace mail { - - class __SMTP_EHLO : public core::Command { + + class SMTPServer; + + class __SMTP_EHLO : public SMTPCommand { - int processCommand(std::string request, Session *session, std::stringstream &data); + public: + int processCommand(coreutils::PString request, SMTPSession &session, SMTPServer &server, std::stringstream &data); + + }; + +} - if(input.length() > 5) { - string hostName = input.substr(5); - } - - else { - - // TODO: Provide error message demanding identity here. - // - } - - data << "250-" << getHostName() << CRLF; - // cout << "250-STARTTLS" << CRLF; - // cout << "250-PIPELINING" << CRLF; - // cout << "250-8BITMIME" << CRLF; - data << "250-AUTH LOGIN" << CRLF; - data << "250 HELP" << CRLF; - session->state = "READY"; - } - \ No newline at end of file +#endif diff --git a/__SMTP_EXPN.cpp b/__SMTP_EXPN.cpp new file mode 100644 index 0000000..3fa8a24 --- /dev/null +++ b/__SMTP_EXPN.cpp @@ -0,0 +1,11 @@ +#include "__SMTP_EXPN.h" +#include "SMTPServer.h" + +namespace mail { + + int __SMTP_EXPN::processCommand(coreutils::PString request, SMTPSession &session, SMTPServer &server, std::stringstream &data) { + data << "252 You must know recipient." << CRLF; + session.state = READY; + } + +} diff --git a/__SMTP_EXPN.h b/__SMTP_EXPN.h new file mode 100644 index 0000000..1cdc303 --- /dev/null +++ b/__SMTP_EXPN.h @@ -0,0 +1,19 @@ +#ifndef ____SMTP_EXPN_h__ +# define ____SMTP_EXPN_h__ + +# include "SMTPCommand.h" +# include "SMTPSession.h" + +namespace mail { + + class SMTPServer; + + class __SMTP_EXPN : public SMTPCommand { + + public: + int processCommand(coreutils::PString request, SMTPSession &session, SMTPServer &server, std::stringstream &data); + + }; +} + +#endif diff --git a/__SMTP_HELO.cpp b/__SMTP_HELO.cpp new file mode 100644 index 0000000..dfb1b49 --- /dev/null +++ b/__SMTP_HELO.cpp @@ -0,0 +1,15 @@ +#include "__SMTP_HELO.h" +#include "SMTPServer.h" + +namespace mail { + + int __SMTP_HELO::processCommand(coreutils::PString request, SMTPSession &session, SMTPServer &server, std::stringstream &data) { + + std::string clientName = request[1].str(); + + data << "250 " << server.hostName << CRLF; + session.state = READY; + } + +} + diff --git a/__SMTP_HELO.h b/__SMTP_HELO.h index 85065f2..260def0 100644 --- a/__SMTP_HELO.h +++ b/__SMTP_HELO.h @@ -1,32 +1,20 @@ #ifndef ____SMTP_HELO_h__ -#define ____SMTP_HELO_h__ +# define ____SMTP_HELO_h__ -#include "Command.h" +# include "SMTPCommand.h" +# include "SMTPSession.h" namespace mail { - - class __SMTP_HELO : public core::Command { + + class SMTPServer; + + class __SMTP_HELO : public SMTPCommand { - int processCommand(std::string request, Session *session, std::stringstream &data); + public: + int processCommand(coreutils::PString request, SMTPSession &session, SMTPServer &server, std::stringstream &data); + + }; + +} - data << "" << std::endl; - - //--------------------------------------------------------------------------- - // HELO command request handling. - //--------------------------------------------------------------------------- - - if(command(input) == "HELO") { - - if(input.length() > 5) { - string hostName = input.substr(5); - } - - else { - - // TODO: Provide error message demanding identity here. - // - } - - cout << "250 " << getHostName() << CRLF; - state = "READY"; - } \ No newline at end of file +#endif diff --git a/__SMTP_HELP.cpp b/__SMTP_HELP.cpp new file mode 100644 index 0000000..9236d95 --- /dev/null +++ b/__SMTP_HELP.cpp @@ -0,0 +1,12 @@ +#include "__SMTP_HELP.h" +#include "SMTPServer.h" + +namespace mail { + + int __SMTP_HELP::processCommand(coreutils::PString request, SMTPSession &session, SMTPServer &server, std::stringstream &data) { + + data << "250 Sure you need help." << CRLF; + session.state = READY; + } + +} diff --git a/__SMTP_HELP.h b/__SMTP_HELP.h new file mode 100644 index 0000000..68bc347 --- /dev/null +++ b/__SMTP_HELP.h @@ -0,0 +1,19 @@ +#ifndef ____SMTP_HELP_h__ +# define ____SMTP_HELP_h__ + +# include "SMTPCommand.h" +# include "SMTPSession.h" + +namespace mail { + + class SMTPServer; + + class __SMTP_HELP : public SMTPCommand { + + int processCommand(coreutils::PString request, SMTPSession &session, SMTPServer &server, std::stringstream &data); + + }; + +} + +#endif diff --git a/__SMTP_MAIL.cpp b/__SMTP_MAIL.cpp new file mode 100644 index 0000000..0763160 --- /dev/null +++ b/__SMTP_MAIL.cpp @@ -0,0 +1,32 @@ +#include "__SMTP_MAIL.h" +#include "SMTPServer.h" + +namespace mail { + + int __SMTP_MAIL::processCommand(coreutils::PString request, SMTPSession &session, SMTPServer &server, std::stringstream &data) { + + if(request.ifNext("MAIL FROM:")) { + request.skipWhitespace(); + if(request.ifNext("<")) { + session.sender = request.getTokenExclude(">"); + if(session.authState = USER_KNOWN) { + data << "250 OK" << CRLF; + session.recipientList.clear(); + session.state = MAIL; + } + } else + data << "550 Usage: MAIL FROM:" << CRLF; + } else + data << "550 Usage: MAIL FROM:" << CRLF; + + return 1; + } + + std::string domainOnly(std::string email) { + coreutils::PString split(email); + split.split("@"); + return split[1].str(); + } + +} + diff --git a/__SMTP_MAIL.h b/__SMTP_MAIL.h index 6274ac8..f1d85be 100644 --- a/__SMTP_MAIL.h +++ b/__SMTP_MAIL.h @@ -1,38 +1,21 @@ #ifndef ____SMTP_MAIL_h__ -#define ____SMTP_MAIL_h__ +# define ____SMTP_MAIL_h__ -#include "Command.h" +# include "SMTPCommand.h" +# include "SMTPSession.h" namespace mail { - - class __SMTP_MAIL : public core::Command { + + class SMTPServer; + + class __SMTP_MAIL : public SMTPCommand { - int processCommand(std::string request, Session *session, std::stringstream &data); + public: + + int processCommand(coreutils::PString request, SMTPSession &session, SMTPServer &server, std::stringstream &data); + + }; + +} - data << "" << std::endl; - - //--------------------------------------------------------------------------- - // MAIL command request handling. - //--------------------------------------------------------------------------- - - else if(command(input) == "MAIL") { - - sender = cleanEMail(input.substr(5)); - - //------------------------------------------------------------- - // Verify that the senders domain name resolves to an address - // with an MX record. If not and there is a bounce then we - // will not be able to return the bounce message so it is - // probably a spammer anyway. - //------------------------------------------------------------- - - if(verifyDomainMX(domainOnly(sender))) { - - cout << "250 OK" << CRLF; - log.message("Response: 250 OK."); - recipientList = ""; - state = "MAIL"; - } - - - } +#endif diff --git a/__SMTP_NOOP.cpp b/__SMTP_NOOP.cpp new file mode 100644 index 0000000..378c0ca --- /dev/null +++ b/__SMTP_NOOP.cpp @@ -0,0 +1,20 @@ +#ifndef ____SMTP_NOOP_h__ +# define ____SMTP_NOOP_h__ + +# include "SMTPCommand.h" +# include "SMTPSession.h" +# include "PString.h" + +namespace mail { + + class __SMTP_NOOP : public SMTPCommand { + + int processCommand(coreutils::PString request, SMTPSession &session, std::stringstream &data) { + data << "250 OK" << CRLF; + } + + }; + +} + +#endif diff --git a/__SMTP_NOOP.h b/__SMTP_NOOP.h index 57e35bb..378c0ca 100644 --- a/__SMTP_NOOP.h +++ b/__SMTP_NOOP.h @@ -1,12 +1,20 @@ #ifndef ____SMTP_NOOP_h__ -#define ____SMTP_NOOP_h__ +# define ____SMTP_NOOP_h__ -#include "Command.h" +# include "SMTPCommand.h" +# include "SMTPSession.h" +# include "PString.h" namespace mail { - - class __SMTP_NOOP : public core::Command { + + class __SMTP_NOOP : public SMTPCommand { - int processCommand(std::string request, Session *session, std::stringstream &data); + int processCommand(coreutils::PString request, SMTPSession &session, std::stringstream &data) { data << "250 OK" << CRLF; } + + }; + +} + +#endif diff --git a/__SMTP_QUIT.cpp b/__SMTP_QUIT.cpp new file mode 100644 index 0000000..fdeb81b --- /dev/null +++ b/__SMTP_QUIT.cpp @@ -0,0 +1,12 @@ +# include "__SMTP_QUIT.h" +# include "SMTPServer.h" + +namespace mail { + + int __SMTP_QUIT::processCommand(coreutils::PString request, SMTPSession &session, SMTPServer &server, std::stringstream &data) { + data << "221 " << server.hostName << CRLF; + session.shutdown("quit request"); + } + +} + diff --git a/__SMTP_QUIT.h b/__SMTP_QUIT.h index b1d06de..c98a93d 100644 --- a/__SMTP_QUIT.h +++ b/__SMTP_QUIT.h @@ -1,17 +1,21 @@ #ifndef ____SMTP_QUIT_h__ -#define ____SMTP_QUIT_h__ +# define ____SMTP_QUIT_h__ -#include "Command.h" +# include "SMTPCommand.h" +# include "SMTPSession.h" namespace mail { - class __SMTP_QUIT : public core::Command { + class SMTPServer; + + class __SMTP_QUIT : public SMTPCommand { + + public: + + int processCommand(coreutils::PString request, SMTPSession &session, SMTPServer &server, std::stringstream &data); - int processCommand(std::string request, Session *session, std::stringstream &data); - data << "221 " << getHostName() << CRLF; - session->shutdown(); - } - }; - + } + +#endif diff --git a/__SMTP_RCPT.cpp b/__SMTP_RCPT.cpp new file mode 100644 index 0000000..7857454 --- /dev/null +++ b/__SMTP_RCPT.cpp @@ -0,0 +1,34 @@ +# include "__SMTP_RCPT.h" +# include "SMTPServer.h" + +namespace mail { + + int __SMTP_RCPT::processCommand(coreutils::PString request, SMTPSession &session, SMTPServer &server, std::stringstream &data) { + + if((session.state == MAIL) || (session.state == RCPT)) { + std::string recipient; + if(request.ifNext("RCPT TO:")) { + request.skipWhitespace(); + if(request.ifNext("<")) { + recipient = request.getTokenExclude(">"); + if(server.mailFileSystem.ifMailBoxExists(recipient)) { + session.recipientList.push_back(recipient); + data << "250 OK" << CRLF; + session.state = RCPT; + } else if(session.relay) { + session.recipientList.push_back(recipient); + data << "250 OK" << CRLF; + session.state = RCPT; + } else + data << "550 Mailbox does not exist" << CRLF; + } else + data << "550 Usage: RCPT TO:" << CRLF; + } else + data << "550 Usage: RCPT TO:" << CRLF; + } else + data << "503 Please use MAIL first" << CRLF; + + return 1; + } + +} diff --git a/__SMTP_RCPT.h b/__SMTP_RCPT.h index 844e789..77c8b47 100644 --- a/__SMTP_RCPT.h +++ b/__SMTP_RCPT.h @@ -1,162 +1,21 @@ #ifndef ____SMTP_RCPT_h__ -#define ____SMTP_RCPT_h__ +# define ____SMTP_RCPT_h__ -#include "Command.h" +# include "SMTPCommand.h" +# include "MailFileSystem.h" +# include "SMTPSession.h" namespace mail { - class __SMTP_RCPT : public core::Command { + class SMTPServer; + + class __SMTP_RCPT : public SMTPCommand { - int processCommand(std::string request, Session *session, std::stringstream &data); - - if((state == "MAIL") || (state == "RCPT")) { - - bool done = false; - - //-------------------------------------- - // Obtain the recipient's email address. - //-------------------------------------- - - string recipient = input.substr(5); - - //----------------------------------------------- - // Fetch the recipient list for the alias. - //----------------------------------------------- - - string aliasRecipients; - - if(getAliasList(cleanEMail(recipient), aliasRecipients)) { - - //----------------------------------------------- - // If the list is not blank then add the list - // to the recipient list and accept the request. - //----------------------------------------------- - - recipientList += aliasRecipients; - data << "250 OK" << CRLF; - state = "RCPT"; - done = true; - } - //------------------------------------------------- - // No alias entry for the mailbox so check if it - // is a hard mailbox. - //------------------------------------------------- - - if(!done) { - - //-------------------------------------- - // Check to see if the user is a local - // address to deliver to. - //-------------------------------------- - - if(localUser(cleanEMail(recipient))) { - - //------------------------------------------ - // They're local so lets queue it for them. - //------------------------------------------ - - recipientList += cleanEMail(recipient) + " "; - data << "250 OK" << CRLF; - state = "RCPT"; - done = true; - } - - } - - //-------------------------------------------------- - // There is no mailbox either so do domain check. - //-------------------------------------------------- - - if(!done) { - - //--------------------------------------------------- - // Check to see if the domain is good at least and - // if there is a default mailbox address.. - //--------------------------------------------------- - string defaultMailbox; - - if(localDomain(domainOnly(cleanEMail(recipient)), defaultMailbox)) { - - //-------------------------------------------------- - // The domain is local so if there is a default - // mailbox then let's send it to the queue with the - // default address attached instead. - //-------------------------------------------------- - - if(defaultMailbox != "*NONE") { - - //--------------------------------------------------------- - // If the default mailbox is *DISCARD then we do not want - // to add the mailbox to the recipient list but we still - // want to say we have a mailbox. - //--------------------------------------------------------- - - if(defaultMailbox != "*DISCARD") - recipientList += defaultMailbox + " "; - - cout << "250 OK" << CRLF; - log.message("Response: 250 OK."); - - state = "RCPT"; - done = true; - } - - //-------------------------------------------------- - // If there is no default address then we will tell - // the client that the mailbox does not exist. - //-------------------------------------------------- - - else { - - cout << "553 Mailbox does not exist" << CRLF; - log.message("Response: 553 Mailbox does not exist."); - - done = true; - } - - } - - } - - //-------------------------------------------------------------- - // If we are not done then this is a relay request. - //-------------------------------------------------------------- - - if (!done) { - - //--------------------------------------------------------- - // If relaying is enabled for this conversation then - // queue the mail. - //--------------------------------------------------------- - - if(relay) { - recipientList += cleanEMail(recipient) + " "; - cout << "250 OK" << CRLF; - log.message("Response: 250 OK."); - state = "RCPT"; - } - - //---------------------------------------- - // Otherwise send an error. - //---------------------------------------- - - else { - cout << "553 Server requires authentication to relay" << CRLF; - log.message("Response: 553 Server requires authentication to relay."); - } - - } - - } - else { - cout << "503 Please use MAIL first" << CRLF; - log.message("Response: 503 Please use MAIL first."); - } - return 0; - } - + public: + int processCommand(coreutils::PString request, SMTPSession &session, SMTPServer &server, std::stringstream &data); + }; - + } #endif diff --git a/__SMTP_RSET.cpp b/__SMTP_RSET.cpp new file mode 100644 index 0000000..ce3815d --- /dev/null +++ b/__SMTP_RSET.cpp @@ -0,0 +1,20 @@ +#ifndef ____SMTP_RSET_h__ +#define ____SMTP_RSET_h__ + +#include "SMTPCommand.h" + +namespace mail { + + class __SMTP_RSET : public SMTPCommand { + + int processCommand(coreutils::PString request, SMTPSession &session, std::stringstream &data) { + session.state = READY; + data << "250 OK" << CRLF; + return 0; + } + + }; + +} + +#endif diff --git a/__SMTP_RSET.h b/__SMTP_RSET.h index ae40248..ce3815d 100644 --- a/__SMTP_RSET.h +++ b/__SMTP_RSET.h @@ -1,20 +1,20 @@ #ifndef ____SMTP_RSET_h__ #define ____SMTP_RSET_h__ -#include "Command.h" +#include "SMTPCommand.h" namespace mail { - class __SMTP_RSET : public core::Command { + class __SMTP_RSET : public SMTPCommand { - int processCommand(std::string request, Session *session, std::stringstream &data); - state = "READY"; + int processCommand(coreutils::PString request, SMTPSession &session, std::stringstream &data) { + session.state = READY; data << "250 OK" << CRLF; return 0; } - + }; - + } #endif diff --git a/__SMTP_VRFY.cpp b/__SMTP_VRFY.cpp new file mode 100644 index 0000000..856c91f --- /dev/null +++ b/__SMTP_VRFY.cpp @@ -0,0 +1,11 @@ +#include "__SMTP_VRFY.h" + +namespace mail { + + int __SMTP_VRFY::processCommand(coreutils::PString request, SMTPSession &session, std::stringstream &data) { + data << "252 You must know who the mail is for" << CRLF; + return 0; + } + +} + diff --git a/__SMTP_VRFY.h b/__SMTP_VRFY.h index a9d9fae..6dc44d9 100644 --- a/__SMTP_VRFY.h +++ b/__SMTP_VRFY.h @@ -1,19 +1,17 @@ #ifndef ____SMTP_VRFY_h__ -#define ____SMTP_VRFY_h__ +# define ____SMTP_VRFY_h__ -#include "Command.h" +# include "SMTPCommand.h" +# include "PString.h" namespace mail { - - class __SMTP_VRFY : public core::Command { + + class __SMTP_VRFY : public SMTPCommand { + + int processCommand(coreutils::PString request, SMTPSession &session, std::stringstream &data); - int processCommand(std::string request, Session *session, std::stringstream &data) { - data << "252 You must know who the mail is for" << CRLF; - return 0; - } - }; - + } #endif diff --git a/compile b/compile new file mode 100755 index 0000000..387b4b8 --- /dev/null +++ b/compile @@ -0,0 +1,29 @@ +#!/bin/bash + +for file in *.cpp +do + filename="${file%.*}" + list="$list $filename.o" + echo -n "Compiling $filename..." + g++ -g -c -std=c++17 -I../CoreUtils -I../ServerCore $file + if [ $? = '0' ] + then + echo "OK" + else + echo "ERROR" + exit -1 + fi +done + +wait +echo -n "Building executable BMAMail..." +g++ -g -std=c++17 -o BMAMail $list -L../CoreUtils -lCoreUtils -L../ServerCore -lServerCore -lpthread -luuid -lssl -lcrypto +if [ $? = '0' ] +then + echo "OK" +else + echo "ERROR" + exit -1 +fi + + diff --git a/docs/Doxyfile b/docs/Doxyfile new file mode 100644 index 0000000..b7873d0 --- /dev/null +++ b/docs/Doxyfile @@ -0,0 +1,2494 @@ +# Doxyfile 1.8.13 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all text +# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv +# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv +# for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = BMAMail + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = 1.0.0 + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = "E-Mail System" + +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = /home/bradarant/barant/BMAMail/docs + +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines. + +ALIASES = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, Javascript, +# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: +# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: +# Fortran. In the later case the parser tries to guess whether the code is fixed +# or free formatted code, this is the default for Fortran type files), VHDL. For +# instance to make doxygen treat .inc files as Fortran files (default is PHP), +# and .f files as C (default is Fortran), use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up +# to that level are automatically included in the table of contents, even if +# they do not have an id attribute. +# Note: This feature currently applies only to Markdown headings. +# Minimum value: 0, maximum value: 99, default value: 0. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 0 + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = YES + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. If set to YES, local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO, only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# (class|struct|union) declarations. If set to NO, these declarations will be +# included in the documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES, upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. +# The default value is: system dependent. + +CASE_SENSE_NAMES = NO + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES, the +# list will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, doxygen will only warn about wrong or incomplete +# parameter documentation, but not about the absence of documentation. +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. +# The default value is: NO. + +WARN_AS_ERROR = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. + +INPUT = /home/bradarant/barant/BMAMail + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: http://www.gnu.org/software/libiconv) for the list of +# possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by doxygen. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, +# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, +# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, +# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, +# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf. + +FILE_PATTERNS = *.c \ + *.cc \ + *.cxx \ + *.cpp \ + *.c++ \ + *.java \ + *.ii \ + *.ixx \ + *.ipp \ + *.i++ \ + *.inl \ + *.idl \ + *.ddl \ + *.odl \ + *.h \ + *.hh \ + *.hxx \ + *.hpp \ + *.h++ \ + *.cs \ + *.d \ + *.php \ + *.php4 \ + *.php5 \ + *.phtml \ + *.inc \ + *.m \ + *.markdown \ + *.md \ + *.mm \ + *.dox \ + *.py \ + *.pyw \ + *.f90 \ + *.f95 \ + *.f03 \ + *.f08 \ + *.f \ + *.for \ + *.tcl \ + *.vhd \ + *.vhdl \ + *.ucf \ + *.qsf + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = NO + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = * + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# function all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see http://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the config file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the +# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the +# cost of reduced performance. This can be particularly helpful with template +# rich C++ code for which doxygen's built-in parser lacks the necessary type +# information. +# Note: The availability of this option depends on whether or not doxygen was +# generated with the -Duse-libclang=ON option for CMake. +# The default value is: NO. + +CLANG_ASSISTED_PARSING = NO + +# If clang assisted parsing is enabled you can provide the compiler with command +# line options that you would normally use when invoking the compiler. Note that +# the include paths will already be set by doxygen for the files and directories +# specified with INPUT and INCLUDE_PATH. +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. + +CLANG_OPTIONS = + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). For an example see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# http://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to YES can help to show when doxygen was last run and thus if the +# documentation is up to date. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = NO + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: http://developer.apple.com/tools/xcode/), introduced with +# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a +# Makefile in the HTML output directory. Running make will produce the docset in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the master .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location of Qt's +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the +# generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# http://www.mathjax.org) which uses client side Javascript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from http://www.mathjax.org before deployment. +# The default value is: http://cdn.mathjax.org/mathjax/latest. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /