test mode logging support

Author: 4kimov

CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+**v0.1.0-alpha.3:**
+- `README.md`: notice about test mode
+- Support for test mode logging
+
 **v0.1.0-alpha.2:**
 - `README.md` cleanup (listing of components)
 - Added `examples/confirm_email`

README.md

@@ -40,7 +40,7 @@ It's perfect for SaaS, web apps, mobile apps, scripts and anywhere you have to s
 Use go get:
 
 ```bash
-go get github.com/templateless/[email protected].2
+go get github.com/templateless/[email protected].3
 ```
 
 Then import the package into your own code:
@@ -97,6 +97,18 @@ There are more Go examples in the [examples](examples) folder ✨
 > [!NOTE]
 > 🚧 **The SDK is not stable yet.** This API might change as more features are added. Please watch the repo for the changes in the [CHANGELOG](CHANGELOG.md).
 
+## 🏗 Debugging
+
+You can generate _test API keys_ by activating the **Test Mode** in your dashboard. By using these keys, you'll be able to view your fully rendered emails without actually sending them.
+
+When you use a test API key in your SDK, the following output will appear in your logs when you try to send an email:
+
+```log
+Templateless [TEST MODE]: Emailed [email protected], preview: https://tmpl.sh/ATMxHLX4r9aE
+```
+
+The preview link will display the email, but you must be logged in to Templateless to view it.
+
 ## 🔳 Components
 
 Emails are crafted programmatically by making function calls. There's no dealing with HTML or drag-and-drop builders.
@@ -248,7 +260,7 @@ If you'd like your recipients to be able to read the email in a browser, you can
 
 You can optionally provide the text for the link. If none is provided, default is used: "View in browser"
 
-**This will make the email public to anyone that has access to the link.**
+**Anyone who knows the link will be able to see the email.**
 
 ```go
 templateless.NewContent().

examples/simple/main.go

@@ -24,7 +24,7 @@ func main() {
 
 	email, _ := templateless.NewEmail().
 		To(*templateless.NewEmailAddress(emailAddress)).
-		Subject("Hello 👋").
+		Subject("Hello").
 		Content(*content).
 		Build()
 

templateless.go

@@ -5,14 +5,21 @@ import (
 	"encoding/json"
 	"fmt"
 	"io"
+	"log"
 	"net/http"
 	"os"
 )
 
 type ObjectId = string
 
+type EmailResponsePreview struct {
+	Email   string `json:"email"`
+	Preview string `json:"preview"`
+}
+
 type EmailResponse struct {
-	Emails []ObjectId
+	Emails   []ObjectId              `json:"emails"`
+	Previews *[]EmailResponsePreview `json:"previews"`
 }
 
 type Templateless struct {
@@ -109,6 +116,13 @@ func (t *Templateless) SendMany(emails []Email) ([]ObjectId, *CustomError) {
 			return nil, UnknownError()
 		}
 
+		if emailResponse.Previews != nil {
+			for _, preview := range *emailResponse.Previews {
+				log.Printf("Templateless [TEST MODE]: Emailed %s, preview: https://tmpl.sh/%s\n",
+					preview.Email, preview.Preview)
+			}
+		}
+
 		return emailResponse.Emails, nil
 	default:
 		return nil, UnknownError()