Merge pull request #30 from jeremydumais/version_1_1_8

Version 1.1.8

.github/workflows/cmake.yml

@@ -19,7 +19,7 @@ jobs:
 
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
 
     # Install OS specific dependencies
     - name: Install Windows dependencies

CHANGELOG.md

@@ -2,6 +2,30 @@
 
 All notable changes to this project will be documented in this file
 
+## [1.1.8]
+
+## Enhancement / Bug fixes
+- Some SMTP server send their list of supported extensions in multiple
+buffers like Zoho Mail. The EHLO command when in uncrypted mode, now supports
+receiving multiple buffers. In return, a delay of one second must be added for
+each segment sent by the SMTP server. For SMTP servers that send the list of
+supported extensions in a single segment like Gmail and Live, no additional
+delay is added for the EHLO command. This doesn't affect the other commands.
+- Now when we send an email to multiple recipients (to or cc), the recipients
+appears as a single mail header instead of multiple headers. The old method was
+not RFC 5322 compliant.
+
+  Before:
+
+  To: [email protected]
+
+  To: [email protected]
+
+  After:
+
+  To: [email protected], [email protected]
+
+
 ## [1.1.7]
 
 ### Added

CMakeLists.txt

@@ -97,6 +97,7 @@ set(PROJECT_SOURCE_FILES ${SRC_PATH}/attachment.cpp
     ${SRC_PATH}/securesmtpclientbase.cpp
     ${SRC_PATH}/opportunisticsecuresmtpclient.cpp
     ${SRC_PATH}/forcedsecuresmtpclient.cpp
+    ${SRC_PATH}/serveroptionsanalyzer.cpp
     ${SRC_PATH}/stringutils.cpp
     ${SRC_PATH}/errorresolver.cpp
     ${SRC_PATH}/cpp/attachment.cpp
@@ -148,7 +149,8 @@ if ("${CMAKE_CXX_COMPILER_ID}" STREQUAL "MSVC")
     add_library(${PROJECT_NAME} SHARED
         ${PROJECT_SOURCE_FILES} ${VersionFilesOutputVariable})
     add_definitions(-D_CRT_SECURE_NO_WARNINGS)
-    target_compile_options(${PROJECT_NAME} PRIVATE /W4 /WX)
+    add_compile_options(/EHsc)
+    target_compile_options(${PROJECT_NAME} PRIVATE /W3 /WX)
     target_compile_definitions(${PROJECT_NAME}
         PRIVATE SMTPCLIENT_EXPORTS
         INTERFACE NOMINMAX # avoid Win macro definition of min/max, use std one
@@ -250,6 +252,7 @@ if (BUILD_TESTING)
         ${TEST_SRC_PATH}/opportunisticsecuresmtpclient_unittest.cpp
         ${TEST_SRC_PATH}/smtpclientbase_unittest.cpp
         ${TEST_SRC_PATH}/smtpclient_unittest.cpp
+        ${TEST_SRC_PATH}/serveroptionsanalyzer_unittest.cpp
         ${TEST_SRC_PATH}/errorresolver_unittest.cpp)
 
     target_link_libraries(${PROJECT_UNITTEST_NAME} ${PROJECT_NAME} gtest gtest_main ${PTHREAD})

README.md

@@ -85,6 +85,16 @@ for previous versions.
 
 ## 📰 What's new
 
+- Version 1.1.8:
+    - Some SMTP server send their list of supported extensions in multiple
+buffers like Zoho Mail. The EHLO command when in uncrypted mode, now supports
+receiving multiple buffers. In return, a delay of one second must be added for
+each segment sent by the SMTP server. For SMTP servers that send the list of
+supported extensions in a single segment like Gmail and Live, no additional
+delay is added for the EHLO command. This doesn't affect the other commands.
+    - Now when we send an email to multiple recipients (to or cc), the recipients
+appears as a single mail header instead of multiple headers. The old method was
+not RFC 5322 compliant.
 - Version 1.1.7:
     - Added support for the XOAUTH2 authentication method.
 This change has been made by rcosnita (https://github.com/rcosnita).

src/forcedsecuresmtpclient.cpp

@@ -83,7 +83,7 @@ int ForcedSecureSMTPClient::checkServerGreetings() {
     unsigned int waitTime = 0;
     ssize_t bytes_received = 0;
     while ((bytes_received = BIO_read(getBIO(), outbuf, SERVERRESPONSE_BUFFER_LENGTH)) <= 0 && waitTime < getCommandTimeout()) {
-        sleep(1);
+        crossPlatformSleep(1);
         waitTime += 1;
     }
     if (waitTime < getCommandTimeout()) {

src/securesmtpclientbase.cpp

@@ -3,6 +3,7 @@
 #include <openssl/x509_vfy.h>
 #include <string>
 #include <utility>
+#include "serveroptionsanalyzer.h"
 #include "smtpclienterrors.h"
 #include "socketerrors.h"
 #include "sslerrors.h"
@@ -268,8 +269,20 @@ int SecureSMTPClientBase::getServerSecureIdentification() {
     if (tls_command_return_code != EHLO_SUCCESS_CODE) {
         return tls_command_return_code;
     }
+    std::string returnedOptions = getLastServerResponse();
+    // Check that the last returned option has no hyphen otherwise options are
+    // still missing from the server.
+    while (!ServerOptionsAnalyzer::containsAllOptions(returnedOptions)) {
+        int replyCode = getServerReply();
+        if (replyCode == -1) {
+            return SSL_CLIENT_INITSECURECLIENT_TIMEOUT;
+        } else if (replyCode != EHLO_SUCCESS_CODE) {
+            return replyCode;
+        }
+        returnedOptions += "\n" + std::string(getLastServerResponse());
+    }
     // Inspect the returned values for authentication options
-    setAuthenticationOptions(SMTPClientBase::extractAuthenticationOptions(getLastServerResponse()));
+    setAuthenticationOptions(SMTPClientBase::extractAuthenticationOptions(returnedOptions.c_str()));
     return EHLO_SUCCESS_CODE;
 }
 
@@ -283,10 +296,6 @@ int SecureSMTPClientBase::sendCommand(const char *pCommand, int pErrorCode) {
 }
 
 int SecureSMTPClientBase::sendCommandWithFeedback(const char *pCommand, int pErrorCode, int pTimeoutCode) {
-    unsigned int waitTime {0};
-    int bytes_received {0};
-    char outbuf[SERVERRESPONSE_BUFFER_LENGTH];
-
     // Check if we are in the TLS mode of before it
     if (mBIO == nullptr) {
         return sendRawCommand(pCommand, pErrorCode, pTimeoutCode);
@@ -297,8 +306,21 @@ int SecureSMTPClientBase::sendCommandWithFeedback(const char *pCommand, int pErr
         return pErrorCode;
     }
 
+    int serverReplyCode = getServerReply();
+    if (serverReplyCode != -1) {
+        return serverReplyCode;
+    }
+
+    cleanup();
+    return pTimeoutCode;
+}
+
+int SecureSMTPClientBase::getServerReply() {
+    unsigned int waitTime {0};
+    int bytes_received {0};
+    char outbuf[SERVERRESPONSE_BUFFER_LENGTH];
     while ((bytes_received = BIO_read(mBIO, outbuf, SERVERRESPONSE_BUFFER_LENGTH)) <= 0 && waitTime < getCommandTimeout()) {
-        sleep(1);
+        crossPlatformSleep(1);
         waitTime += 1;
     }
     if (waitTime < getCommandTimeout()) {
@@ -307,7 +329,5 @@ int SecureSMTPClientBase::sendCommandWithFeedback(const char *pCommand, int pErr
         addCommunicationLogItem(outbuf, "s");
         return extractReturnCode(outbuf);
     }
-
-    cleanup();
-    return pTimeoutCode;
+    return -1;
 }

src/securesmtpclientbase.h

@@ -65,6 +65,7 @@ class SECURESMTPCLIENTBASE_API SecureSMTPClientBase : public SMTPClientBase {
     // Methods to send commands to the server
     int sendCommand(const char *pCommand, int pErrorCode) override;
     int sendCommandWithFeedback(const char *pCommand, int pErrorCode, int pTimeoutCode) override;
+    int getServerReply() override;
 
  private:
     // Attributes used to communicate with the server

src/serveroptionsanalyzer.cpp

@@ -0,0 +1,24 @@
+#include "serveroptionsanalyzer.h"
+
+using namespace jed_utils;
+
+// Trim from start
+bool ServerOptionsAnalyzer::containsAllOptions(const std::string &optionsStr) {
+    std::string sanitizedOptionsStr = [&optionsStr]() {
+        if (optionsStr.size() >= 2 && optionsStr.substr(optionsStr.size() - 2) == "\r\n") {
+            return optionsStr.substr(0, optionsStr.size() - 2);
+        } else {
+            return optionsStr;
+        }
+    }();
+    size_t lastLineStart = sanitizedOptionsStr.rfind("\r\n");
+    if (lastLineStart == std::string::npos) {
+        lastLineStart = 0;
+    } else {
+        lastLineStart += 2;  // Move past the \r\n
+    }
+    if (sanitizedOptionsStr.substr(lastLineStart, 4) == "250 ") {
+        return true;
+    }
+    return false;
+}

src/serveroptionsanalyzer.h

@@ -0,0 +1,33 @@
+#ifndef SERVEROPTIONSANALYZER_H
+#define SERVEROPTIONSANALYZER_H
+
+#include <string>
+
+#ifdef _WIN32
+    #ifdef SMTPCLIENT_EXPORTS
+        #define SERVEROPTIONSANALYZER_API __declspec(dllexport)
+    #else
+        #define SERVEROPTIONSANALYZER_API __declspec(dllimport)
+    #endif
+#else
+    #define SERVEROPTIONSANALYZER_API
+#endif
+
+namespace jed_utils {
+/** @brief The ServerOptionsAnalyzer class provides utility fonctions to
+ * analyzer the SMTP options that are available by the server.
+*/
+class SERVEROPTIONSANALYZER_API ServerOptionsAnalyzer {
+ public:
+    /**
+     *  @brief Indicate if the server has returned all it's available options
+     *  or of there still a reply with other options to come.
+     *  @param optionsStr The string that contains the option list returned by
+     *  the SMTP server.
+     */
+    static bool containsAllOptions(const std::string &optionsStr);
+};
+}  // namespace jed_utils
+
+
+#endif  // SERVEROPTIONSANALYZER_H

src/smtpclient.cpp

@@ -104,3 +104,7 @@ int SmtpClient::sendCommand(const char *pCommand, int pErrorCode) {
 int SmtpClient::sendCommandWithFeedback(const char *pCommand, int pErrorCode, int pTimeoutCode) {
     return sendRawCommand(pCommand, pErrorCode, pTimeoutCode);
 }
+
+int SmtpClient::getServerReply() {
+    return getRawCommandReply();
+}

src/smtpclient.h

@@ -51,6 +51,7 @@ class SMTPCLIENT_API SmtpClient : public SMTPClientBase {
     // Methods to send commands to the server
     int sendCommand(const char *pCommand, int pErrorCode) override;
     int sendCommandWithFeedback(const char *pCommand, int pErrorCode, int pTimeoutCode) override;
+    int getServerReply() override;
 };
 }  // namespace jed_utils