email-tracker-go

KO | EN

gitlite — search

#javascript #python #go #rust #macos #nodejs #windows #awesome #cli #awesome-list #pytorch #security #ios #open-source

email-tracker-go

(★ 11)

Email tracker that i will be using to track email that i send for MindKeeper AI and in general

email-tracker-go Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Email Tracker Service

A Go service for sending and tracking emails using Redis for storage and Gin for the web framework.

## Features

- Send emails to multiple recipients (TO, CC, BCC)
- Track email opens using pixel tracking
- Custom HTML templates with variable substitution
- Redis-based tracking storage
- Configurable tracking expiration

## Setup

### Prerequisites

- Go 1.16+
- Redis server
- SMTP server access

### Environment Variables

```bash
SMTP_HOST=smtp.example.com
SMTP_PORT=587
SMTP_USERNAME=your-username
SMTP_PASSWORD=your-password
REDIS_ADDR=localhost:6379
TRACKING_DOMAIN=https://your-domain.com
TRACKING_ID_EXPIRATION=86400  # 1 day in seconds
PORT=8080  # Optional, defaults to 8080
```

### Installation

```bash
go mod download
go run main.go
```

## API Endpoints

### 1. Send Email

`POST /send`

Sends emails to multiple recipients with optional tracking.

#### Request Body:

```json
{
  "recipients": {
    "receivers": [
      {
        "email": "test@example.com",
        "tracking_id": "",
        "want_to_track": true,
        "type": "to"  // "to", "cc", or "bcc"
      }
    ],
    "from": "sender@yourdomain.com"
  },
  "email_body": {
    "html_template": "<!DOCTYPE html><html><body>Hello {{ name }}!</body></html>",
    "subject": "Test Email",
    "parameters": {
      "test@example.com": {
        "name": "John Doe"
      }
    }
  }
}
```

#### Response:

```json
{
  "status": {
    "test@example.com": "Success:tracking_id:12345-uuid"
  }
}
```

### 2. Track Email Opens

`GET /pixel/:tracking_id`

Endpoint for the tracking pixel. Returns a 1x1 transparent PNG and logs the email open.

#### Response:

- Returns a transparent 1x1 pixel image
- Status: 200 OK if tracking ID exists, 404 if not found

### 3. Check Tracking Status

`GET /status/:tracking_id`

Get the current status of an email tracking ID.

#### Response:

```json
{
  "tracking_id": "12345-uuid",
  "email": "recipient@example.com",
  "count": 2,
  "last_opened": "2025-01-18T15:04:05Z",
  "created_at": "2025-01-18T10:00:00Z"
}
```

### 4. Health Check

`GET /ping`

Simple health check endpoint.

#### Response:

```json
{
  "message": "pong"
}
```

## Template Variables

The HTML template supports variable substitution using the `{{ variable_name }}` syntax. Variables are defined per recipient in the `parameters` field of the request.

## Error Handling

- All endpoints return appropriate HTTP status codes
- Detailed error messages are included in the response
- Tracking IDs expire after the configured duration (default: 1 day)

## Examples

### Sending a Test Email

```bash
curl -X POST http://localhost:8080/send \
  -H "Content-Type: application/json" \
  -d '{
    "recipients": {
      "receivers": [
        {
          "email": "test@example.com",
          "tracking_id": "",
          "want_to_track": true,
          "type": "to"
        }
      ],
      "from": "sender@yourdomain.com"
    },
    "email_body": {
      "html_template": "<!DOCTYPE html><html><body><h1>Hello {{ name }}!</h1></body></html>",
      "subject": "Test Email",
      "parameters": {
        "test@example.com": {
          "name": "John Doe"
        }
      }
    }
  }'
```

### Checking Email Status

```bash
curl http://localhost:8080/status/your-tracking-id
```

## Security Considerations

- SMTP credentials should be kept secure
- Consider implementing rate limiting for tracking endpoints
- Add authentication for status endpoint in production
- Use HTTPS in production environments

## Contributing

Hey there! 👋 Thanks for considering contributing to this project. While it might look complex at first, it's actually quite straightforward to get started!

### Getting Started

Don't let the codebase intimidate you - most issues are suitable for beginners (even if they're not explicitly tagged as good-first-issues). Whether you're new to Go, want to build a client, or improve the code quality, there's something for everyone.

### How to Contribute

1. Look through the issues
2. Find one that interests you (they're all beginner-friendly!)
3. Comment on the issue saying you'd like to work on it
4. I'll guide you through the process

### Need Help?

- Comment on any issue you're interested in - I'm happy to provide guidance
- Don't worry if you're new to Go or open source
- No question is too basic - we all start somewhere!

### Before You Dive In

- The project uses Go for backend and Redis for storage
- Basic understanding of REST APIs is helpful
- That's it! Everything else we can figure out together

Remember: The best contribution is the one that gets made. Don't hesitate to start small!

email-tracker-go

email-tracker-go Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

email-tracker-go

email-tracker-go Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README