Fix IMAP's file name and decoding issues

mobizt · mobizt · commit 6d1b900e1534 · 2025-05-26T15:56:23.000+07:00
diff --git a/README.md b/README.md
@@ -66,7 +66,7 @@ ssl_client.setInsecure();
 
 auto statusCallback = [](SMTPStatus status){ Serial.println(status.text); };
 
-smtp.connect("smtp host here", 465, "127.0.0.1", statusCallback);
+smtp.connect("smtp host here", 465, statusCallback);
 if (smtp.isConnected())
 {
     smtp.authenticate("sender email here", "sender email password here", readymail_auth_password);
@@ -120,9 +120,13 @@ Plese check the library's [examples](/examples/Sending/) for the changes.
 **Host/Domain or Public IP**
 
 User should provides the host name or you public IPv4 or IPv6 to the third parameter of `SMTPClient::connect()` function.
+
 This information is the part of `EHLO/HELO` SMTP command to identify the client system to prevent connection rejection.
 
-If host name or public IP is not available, ignore this or use the loopback address `127.0.0.1`. This library will set the loopback address `127.0.0.1` to the `EHLO/HELO` SMTP command for the case that user provides blank, invalid host and IP to this parameter.
+If host name or public IP is not available, ignore this or use the loopback address `127.0.0.1`. This library will set the loopback address `127.0.0.1` to the `EHLO/HELO` SMTP command for the case that user provides blank, invalid host and IP to this parameter or setting `SMTPResponseCallback` as the third parameter.
+
+Note that, for general use case, the domain/ip was ignored by setting `SMTPResponseCallback` as the third parameter of `SMTPClient::connect()` in all library SMTP examples and example codes that showed in this document.
+
 
 **Date Header**
 
@@ -471,7 +475,7 @@ WiFiClient basic_client; // Network client
 SMTPClient smtp(basic_client);
 
 auto statusCallback = [](IMAPStatus status){ Serial.println(status.text);};
-smtp.connect("smtp host", 25, "127.0.0.1", statusCallback, false /* non-secure */);
+smtp.connect("smtp host", 25, statusCallback, false /* non-secure */);
 
 ```
 **IMAP Port 143**
@@ -515,7 +519,7 @@ ssl_client.setClient(&basic_client, false /* starts connection in plain text */)
 ssl_client.setInsecure();
 
 auto statusCallback = [](IMAPStatus status){ Serial.println(status.text);};
-smtp.connect("smtp host", 587, "127.0.0.1", statusCallback);
+smtp.connect("smtp host", 587, statusCallback);
 
 ```
 
@@ -532,7 +536,7 @@ ssl_client.setInsecure();
 ssl_client.setPlainStart();
 
 auto statusCallback = [](IMAPStatus status){ Serial.println(status.text);};
-smtp.connect("smtp host", 587, "127.0.0.1", statusCallback);
+smtp.connect("smtp host", 587, statusCallback);
 
 ```
 
@@ -593,7 +597,7 @@ ssl_client.setClient(&basic_client);
 ssl_client.setInsecure();
 
 auto statusCallback = [](IMAPStatus status){ Serial.println(status.text); };
-smtp.connect("smtp host", 465, "127.0.0.1", statusCallback);
+smtp.connect("smtp host", 465, statusCallback);
 
 ```
 
@@ -607,7 +611,7 @@ WiFiClientSecure ssl_client;
 SMTPClient smtp(ssl_client);
 
 auto statusCallback = [](IMAPStatus status){ Serial.println(status.text); };
-smtp.connect("smtp host", 465, "127.0.0.1", statusCallback);
+smtp.connect("smtp host", 465, statusCallback);
 
 ```
 
diff --git a/examples/Network/AutoClient/AutoClient.ino b/examples/Network/AutoClient/AutoClient.ino
@@ -28,7 +28,6 @@
 #include <ReadyMail.h>
 
 #define SMTP_HOST "_______"
-#define DOMAIN_OR_IP "127.0.0.1"
 #define AUTHOR_EMAIL "_______"
 #define AUTHOR_PASSWORD "_______"
 #define RECIPIENT_EMAIL "_______"
@@ -59,7 +58,7 @@ void smtpCb(SMTPStatus status)
 void sendEmail(int port)
 {
 
-    smtp.connect(SMTP_HOST, port, "127.0.0.1", smtpCb);
+    smtp.connect(SMTP_HOST, port, smtpCb);
     if (!smtp.isConnected())
         return;
 
diff --git a/examples/Network/AutoPort/AutoPort.ino b/examples/Network/AutoPort/AutoPort.ino
@@ -13,7 +13,6 @@
 #include <ReadyMail.h>
 
 #define SMTP_HOST "_______"
-#define DOMAIN_OR_IP "127.0.0.1"
 #define AUTHOR_EMAIL "_______"
 #define AUTHOR_PASSWORD "_______"
 #define RECIPIENT_EMAIL "_______"
@@ -61,7 +60,7 @@ void sendEmail(int port)
 
   // Everytime you call connect(), the previouse session will stop.
   // If you want to reuse the session, just skipping the connect() and authenticate().
-  smtp.connect(SMTP_HOST, port, "127.0.0.1", smtpCb, ssl);
+  smtp.connect(SMTP_HOST, port, smtpCb, ssl);
   if (!smtp.isConnected())
     return;
 
diff --git a/examples/Network/EthernetClient/EthernetClient.ino b/examples/Network/EthernetClient/EthernetClient.ino
@@ -28,7 +28,6 @@ EthernetClient basic_client;
 
 #define SMTP_HOST "_______"
 #define SMTP_PORT 465
-#define DOMAIN_OR_IP "127.0.0.1"
 
 // https://github.com/mobizt/ESP_SSLClient
 ESP_SSLClient ssl_client;
@@ -94,7 +93,7 @@ void setup()
 
     // In case ESP8266 crashes, please see https://bit.ly/4iX1NkO
 
-    smtp.connect(SMTP_HOST, SMTP_PORT, DOMAIN_OR_IP, smtpCb);
+    smtp.connect(SMTP_HOST, SMTP_PORT, smtpCb);
     if (!smtp.isConnected())
         return;
 }
diff --git a/examples/Network/GSMClient/GSMClient.ino b/examples/Network/GSMClient/GSMClient.ino
@@ -40,7 +40,6 @@ const char gprsPass[] = "";
 
 #define SMTP_HOST "_______"
 #define SMTP_PORT 465
-#define DOMAIN_OR_IP "127.0.0.1"
 
 TinyGsm modem(SerialAT);
 TinyGsmClient basic_client(modem);
@@ -136,7 +135,7 @@ void setup()
 
     // In case ESP8266 crashes, please see https://bit.ly/4iX1NkO
 
-    smtp.connect(SMTP_HOST, SMTP_PORT, DOMAIN_OR_IP, smtpCb);
+    smtp.connect(SMTP_HOST, SMTP_PORT, smtpCb);
     if (!smtp.isConnected())
         return;
 }
diff --git a/examples/Sending/Attachment/Attachment.ino b/examples/Sending/Attachment/Attachment.ino
@@ -14,7 +14,6 @@
 
 #define SMTP_HOST "_______"
 #define SMTP_PORT 465 // SSL or 587 for STARTTLS
-#define DOMAIN_OR_IP "127.0.0.1"
 #define AUTHOR_EMAIL "_______"
 #define AUTHOR_PASSWORD "_______"
 #define RECIPIENT_EMAIL "_______"
@@ -134,7 +133,7 @@ void setup()
 
     // In case ESP8266 crashes, please see https://bit.ly/4iX1NkO
 
-    smtp.connect(SMTP_HOST, SMTP_PORT, DOMAIN_OR_IP, smtpCb);
+    smtp.connect(SMTP_HOST, SMTP_PORT, smtpCb);
     if (!smtp.isConnected())
         return;
 
diff --git a/examples/Sending/ESP32Camera/ESP32Camera.ino b/examples/Sending/ESP32Camera/ESP32Camera.ino
@@ -36,7 +36,6 @@
 
 #define SMTP_HOST "_______"
 #define SMTP_PORT 465 // SSL or 587 for STARTTLS
-#define DOMAIN_OR_IP "127.0.0.1"
 #define AUTHOR_EMAIL "_______"
 #define AUTHOR_PASSWORD "_______"
 #define RECIPIENT_EMAIL "_______"
@@ -127,7 +126,7 @@ void setup()
 
     Serial.println("ReadyMail, version " + String(READYMAIL_VERSION));
 
-    smtp.connect(SMTP_HOST, SMTP_PORT, DOMAIN_OR_IP, smtpCb);
+    smtp.connect(SMTP_HOST, SMTP_PORT, smtpCb);
     if (!smtp.isConnected())
         return;
 
diff --git a/examples/Sending/InlineImage/InlineImage.ino b/examples/Sending/InlineImage/InlineImage.ino
@@ -13,7 +13,6 @@
 
 #define SMTP_HOST "_______"
 #define SMTP_PORT 465 // SSL or 587 for STARTTLS
-#define DOMAIN_OR_IP "127.0.0.1"
 #define AUTHOR_EMAIL "_______"
 #define AUTHOR_PASSWORD "_______"
 #define RECIPIENT_EMAIL "_______"
@@ -84,7 +83,7 @@ void setup()
 
     // In case ESP8266 crashes, please see https://bit.ly/4iX1NkO
 
-    smtp.connect(SMTP_HOST, SMTP_PORT, DOMAIN_OR_IP, smtpCb);
+    smtp.connect(SMTP_HOST, SMTP_PORT, smtpCb);
     if (!smtp.isConnected())
         return;
 
diff --git a/examples/Sending/RFC822Message/RFC822Message.ino b/examples/Sending/RFC822Message/RFC822Message.ino
@@ -13,7 +13,6 @@
 
 #define SMTP_HOST "_______"
 #define SMTP_PORT 465 // SSL or 587 for STARTTLS
-#define DOMAIN_OR_IP "127.0.0.1"
 #define AUTHOR_EMAIL "_______"
 #define AUTHOR_PASSWORD "_______"
 #define RECIPIENT_EMAIL "_______"
@@ -152,7 +151,7 @@ void setup()
 
     // In case ESP8266 crashes, please see https://bit.ly/4iX1NkO
 
-    smtp.connect(SMTP_HOST, SMTP_PORT, DOMAIN_OR_IP, smtpCb, SSL_MODE);
+    smtp.connect(SMTP_HOST, SMTP_PORT, smtpCb, SSL_MODE);
     if (!smtp.isConnected())
         return;
 
diff --git a/examples/Sending/SendAsync/SendAsync.ino b/examples/Sending/SendAsync/SendAsync.ino
@@ -13,7 +13,6 @@
 
 #define SMTP_HOST "_______"
 #define SMTP_PORT 465 // SSL or 587 for STARTTLS
-#define DOMAIN_OR_IP "127.0.0.1"
 #define AUTHOR_EMAIL "_______"
 #define AUTHOR_PASSWORD "_______"
 #define RECIPIENT_EMAIL "_______"
@@ -110,7 +109,7 @@ void setup()
     // In case ESP8266 crashes, please see https://bit.ly/4iX1NkO
 
     // Setting AWAIT_MODE parameter with false
-    smtp.connect(SMTP_HOST, SMTP_PORT, DOMAIN_OR_IP, smtpCb, SSL_MODE, AWAIT_MODE);
+    smtp.connect(SMTP_HOST, SMTP_PORT, smtpCb, SSL_MODE, AWAIT_MODE);
 }
 
 void loop()
diff --git a/examples/Sending/SimpleText/SimpleText.ino b/examples/Sending/SimpleText/SimpleText.ino
@@ -13,7 +13,6 @@
 
 #define SMTP_HOST "_______"
 #define SMTP_PORT 465 // SSL or 587 for STARTTLS
-#define DOMAIN_OR_IP "127.0.0.1"
 #define AUTHOR_EMAIL "_______"
 #define AUTHOR_PASSWORD "_______"
 #define RECIPIENT_EMAIL "_______"
@@ -64,7 +63,7 @@ void setup()
 
     // In case ESP8266 crashes, please see https://bit.ly/4iX1NkO
 
-    smtp.connect(SMTP_HOST, SMTP_PORT, DOMAIN_OR_IP, smtpCb, SSL_MODE);
+    smtp.connect(SMTP_HOST, SMTP_PORT, smtpCb, SSL_MODE);
     if (!smtp.isConnected())
         return;
 
diff --git a/examples/Sending/StaticText/StaticText.ino b/examples/Sending/StaticText/StaticText.ino
@@ -14,7 +14,6 @@
 
 #define SMTP_HOST "_______"
 #define SMTP_PORT 465 // SSL or 587 for STARTTLS
-#define DOMAIN_OR_IP "127.0.0.1"
 #define AUTHOR_EMAIL "_______"
 #define AUTHOR_PASSWORD "_______"
 #define RECIPIENT_EMAIL "_______"
@@ -119,7 +118,7 @@ void setup()
 
     // In case ESP8266 crashes, please see https://bit.ly/4iX1NkO
 
-    smtp.connect(SMTP_HOST, SMTP_PORT, DOMAIN_OR_IP, smtpCb);
+    smtp.connect(SMTP_HOST, SMTP_PORT, smtpCb);
     if (!smtp.isConnected())
         return;
 
diff --git a/library.json b/library.json
@@ -1,6 +1,6 @@
 {
   "name": "ReadyMail",
-  "version": "0.2.6",
+  "version": "0.2.7",
   "keywords": "communication, email, imap, smtp, esp32, esp8266, samd, arduino",
   "description": "The fast and lightweight async Email client library for Arduino.",
   "repository": {
diff --git a/library.properties b/library.properties
@@ -1,6 +1,6 @@
 name=ReadyMail
 
-version=0.2.6
+version=0.2.7
 
 author=Mobizt
 
diff --git a/src/ReadyMail.h b/src/ReadyMail.h
@@ -25,8 +25,8 @@
 #include "./core/ReadyCodec.h"
 #include "./core/Utils.h"
 
-#define READYMAIL_VERSION "0.2.6"
-#define READYMAIL_TIMESTAMP 1747494775
+#define READYMAIL_VERSION "0.2.7"
+#define READYMAIL_TIMESTAMP 1748248112
 #define READYMAIL_LOOPBACK_IPV4 "127.0.0.1"
 
 #if defined(READYMAIL_DEBUG_PORT)
@@ -156,7 +156,7 @@ class ReadyMailClass
     String base64Encode(const String &str)
     {
         String buf;
-        char *enc = rd_b64_enc(rd_cast<$cu *>(str.c_str()), str.length());
+        char *enc = rd_b64_enc(rd_cast<const unsigned char *>(str.c_str()), str.length());
         if (enc)
         {
             buf = enc;
diff --git a/src/core/QBDecoder.h b/src/core/QBDecoder.h
@@ -11,11 +11,6 @@
 
 #if defined(ENABLE_IMAP) || defined(ENABLE_SMTP)
 
-#if defined($cu)
-#undef $cu
-#endif
-#define $cu const unsigned char
-
 // Renesas devices
 #if defined(ARDUINO_UNOWIFIR4) || defined(ARDUINO_MINIMA) || defined(ARDUINO_PORTENTA_C33)
 #define XMAILER_STRSEP strsepImpl
diff --git a/src/core/ReadyCodec.h b/src/core/ReadyCodec.h
@@ -88,7 +88,7 @@ struct src_data_ctx
     }
 };
 
-static $cu rd_b64_map[65] = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
+static const unsigned char rd_b64_map[65] = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
 
 static void __attribute__((used)) sys_yield()
 {
@@ -126,7 +126,7 @@ static unsigned char rd_b64_lookup(char c)
     return -1;
 }
 
-static void rd_a4_to_a3(unsigned char *a3, $cu *a4)
+static void rd_a4_to_a3(unsigned char *a3, unsigned char *a4)
 {
     a3[0] = (a4[0] << 2) + ((a4[1] & 0x30) >> 4);
     a3[1] = ((a4[1] & 0xf) << 4) + ((a4[2] & 0x3c) >> 2);
@@ -186,7 +186,7 @@ static char *rd_b64_dec(const char *encoded)
     return raw;
 }
 
-static char *rd_b64_enc($cu *raw, int len)
+static char *rd_b64_enc(const unsigned char *raw, int len)
 {
     uint8_t count = 0;
     char buffer[3];
@@ -421,7 +421,7 @@ static String rd_qb_encode_chunk(src_data_ctx &src, int &index, int mode, bool f
         {
             if (mode == 3 /* xenc_base64 */)
             {
-                char *enc = rd_b64_enc(rd_cast<$cu *>(buf.c_str()), buf.length());
+                char *enc = rd_b64_enc(rd_cast<const unsigned char *>(buf.c_str()), buf.length());
                 line = enc;
                 rd_free(&enc);
             }
@@ -444,7 +444,7 @@ String rd_enc_oauth(const String &email, const String &accessToken)
     String out;
     String raw;
     rd_print_to(raw, email.length() + accessToken.length() + 30, "user=%s\1auth=Bearer %s\1\1", email.c_str(), accessToken.c_str());
-    char *enc = rd_b64_enc(rd_cast<$cu *>(raw.c_str()), raw.length());
+    char *enc = rd_b64_enc(rd_cast<const unsigned char *>(raw.c_str()), raw.length());
     if (enc)
     {
         out = enc;
@@ -519,7 +519,7 @@ static int rd_encode_unicode_utf8(char *out, uint32_t utf)
     }
 }
 
-static void rd_dec_tis620_utf8(char *out, $cu *in, size_t len)
+static void rd_dec_tis620_utf8(char *out, const char *in, size_t len)
 {
     // output is the 3-byte value UTF-8
     int j = 0;
@@ -565,7 +565,7 @@ static void rd_dec_qp_utf8(const char *src, char *out)
     }
 }
 
-static char *rd_dec_7bit_utf8($cu *src)
+static char *rd_dec_7bit_utf8(const char *src)
 {
     String s;
 
@@ -607,13 +607,13 @@ static char *rd_dec_8bit_utf8(const char *src)
     return decoded;
 }
 
-static int rd_dec_latin1_utf8(unsigned char *out, int *outlen, $cu *in, int *inlen)
+static int rd_dec_latin1_utf8(unsigned char *out, int *outlen, const unsigned char *in, int *inlen)
 {
-    $cu *outstart = out;
-    $cu *base = in;
-    $cu *processed = in;
-    $cu *outend = out + *outlen;
-    $cu *inend;
+    unsigned char *outstart = out;
+    const unsigned char *base = in;
+    const unsigned char *processed = in;
+    unsigned char *outend = out + *outlen;
+    const unsigned char *inend;
     int bits;
 
     inend = in + (*inlen);
@@ -641,7 +641,7 @@ static int rd_dec_latin1_utf8(unsigned char *out, int *outlen, $cu *in, int *inl
                 break;
             *out++ = ((c >> bits) & 0x3F) | 0x80;
         }
-        processed = rd_cast<$cu *>(in);
+        processed = rd_cast<const unsigned char *>(in);
     }
     *outlen = out - outstart;
     *inlen = processed - base;
diff --git a/src/imap/IMAPConnection.h b/src/imap/IMAPConnection.h
diff --git a/src/imap/IMAPResponse.h b/src/imap/IMAPResponse.h
diff --git a/src/imap/IMAPSend.h b/src/imap/IMAPSend.h
diff --git a/src/imap/Parser.h b/src/imap/Parser.h
diff --git a/src/smtp/SMTPConnection.h b/src/smtp/SMTPConnection.h
diff --git a/src/smtp/SMTPMessage.h b/src/smtp/SMTPMessage.h
