Send Email With Lua And The Esp32

About the project

In this tutorial, we delve into sending emails with the ESP32-S3 using Lua, focusing on the Xedge IDE's built-in SMTP configuration feature

Project info

Difficulty: Easy

Platforms: Seeed Studio

Estimated time: 1 hour

License: GNU Lesser General Public License version 3 or later (LGPL3+)

Items used in this project

Hardware components

Seeed Studio XIAO ESP32S3 Sense Seeed Studio XIAO ESP32S3 Sense x 1

Software apps and online services

Xedge32 Xedge32

Story

Sending emails, especially those with attachments and inline images, can be a cumbersome task. However, the Xedge IDE simplifies this process through its user-friendly configuration dialog. This tutorial will guide you through setting up and using the Xedge SMTP configuration to enhance your email sending capabilities securely.

The Xedge IDE offers an easy-to-use configuration dialog for sending emails, including those with attachments and inline images. While you can send emails without this built-in feature, leveraging the Xedge SMTP configuration provides a significant advantage: it encrypts your email settings and credentials within the "xedge.conf" file for enhanced security when used on platforms such as Xedge32.

Before reading the remainder, be sure to subscribe and support the channel if you have not!

Subscribe:

Youtube

Support:

https://www.buymeacoffee.com/mmshilleh

Hire me at UpWork to build your IoT projects:

https://www.upwork.com/freelancers/~017060e77e9d8a1157

Step 1: Accessing the SMTP Configuration
  • Open the Xedge IDE.
  • Click the three dots in the upper right to reveal the menu.
  • Select "SMTP Server" to launch the configuration dialog.

Here’s what the SMTP configuration dialog looks like:

Xedge SMTP Configuration

This dialog also activates the optional built-in email log function, xedge.elog(), which is useful for sending log messages, such as detailed stack traces and error messages, if your Lua scripts encounter issues.

Step 2: Entering SMTP Settings

After accessing the SMTP configuration dialog, enter your SMTP settings. Here's a breakdown of the settings for popular email providers:

SMTP Settings for Hotmail and Outlook
  • SMTP Server: smtp.office365.com
  • SMTP Username: Your complete Outlook email address
  • SMTP Password: Your Outlook account password
  • SMTP Port: 587
  • Connection Security: STARTTLS

SMTP Settings for Gmail
  • SMTP Server: smtp.gmail.com
  • SMTP Username: Your full Gmail address
  • SMTP Password: Your Gmail App Password (details below)
  • SMTP Port: 465
  • Connection Security: TLS

Generating an App Password for Gmail

Gmail users need an App Password instead of their regular account password for SMTP settings. Follow these steps to generate an App Password:

  • Access your Google Account and navigate to the 'Security' section.
  • Under 'Signing in to Google, ' select '2-Step Verification' and proceed with the setup if not already activated.
  • Once 2-Step Verification is enabled, return to the 'Security' page and select 'App Passwords.'
  • In the 'Select app' dropdown, choose 'Mail.' For 'Select device, ' pick 'Other' and label it as 'Xedge.'
  • Click 'Generate' to receive a 16-digit App Password.

Use this App Password as the authentication method for Xedge to send emails through your Gmail account.

Step 3: Testing the Email Functions

With your SMTP settings configured, test the email functions by sending a few emails. Follow these steps:

  • Click the three dots in the upper right to reveal the menu.
  • Select "Lua Shell" to launch the REPL.

Example 1: Sending a Simple Text Message

Copy and paste the following code into the REPL, changing the "to" address:

local op={
to="info@realtimelogic.com",
subject="Hello",
body="What's up?"
}
xedge.sendmail(op, function(ok,err) trace(ok,err) end)

Example 2: Sending an HTML Email with an Inlined Image
lua
Copy code
local image=[[
<svg xmlns="http://www.w3.org/2000/svg" width="400" height="400">
<circle cx="100" cy="100" r="50" stroke="black" stroke-width="5" fill="red"/>
</svg>
]]

local op={
to="info@realtimelogic.com",
subject="A Circle",
htmlbody=[[
<html>
<body>
<h1>SVG</h1>
<img src="cid:the-unique-id" alt="circle">
</body>
</html>
]],
htmlimg={
id="the-unique-id",
name="circle.svg",
source=image
}
}

xedge.sendmail(op, function(ok,err) trace(ok,err) end)

Conclusion

Congratulations! You have successfully configured your SMTP settings and tested email functions using Xedge IDE. For more details on using the xedge.sendmail() function, refer to the Xedge Documentation.

Additionally, if you need to log messages via email, check out the tutorial: Logging for Testing and Production Mode: Maximizing Efficiency with Xedge.

For further assistance, explore our extensive collection of embedded web server and IoT tutorials tailored to guide you through each step. If you're pressed for time or need expert guidance, consider our consulting services to manage the complexities of networking, security, and device management.

Happy emailing with Xedge!

Credits

Photo of mahmood-m-shilleh

mahmood-m-shilleh

Mechanical and Software Engineering Background. University at Buffalo 2019 Texas A&M 2021 I make data pipelines for my day job. Outside of work, I participate in online communities regarding Full Stack Engineering, Microelectronics, and more. You can find more details about me on my Youtube Channel. https://www.youtube.com/@mmshilleh Feel free to reach out!

   

Leave your feedback...