thisis-vishal / Email-Tracking

Home Page:https://email-tracking-five.vercel.app

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Email-Tracking

Description

This following API is used to track whether email has been opened by user or not. This can help various businesses to find out analytics of there email campaign

This is an open to contribute project feel free to connect

I am using Pixels technology to make this project

Follow this url to learn about pixels


Pre Requisite

  • asgiref==3.7.1
  • Django==4.1.9
  • django-cors-headers==4.0.0
  • djangorestframework==3.14.0
  • djongo==1.3.6
  • dnspython==2.3.0
  • Pillow==9.5.0
  • pymongo==3.12.1
  • python-decouple==3.8
  • pytz==2023.3
  • sqlparse==0.2.4
  • typing_extensions==4.6.2
  • tzdata==2023.3
  • python==3.9

How to Use

API endpoint: https://email-tracking-five.vercel.app/

Use send API call to send email to users:

use /send API to send emails, Prameters fro send API are:

"recipient_list" : one should enter the list of email strings

"subject" : one should enter the subject of email

postmanimg

The result will be stored in mongodb database like below image:

compassimg


To contribute

Change DATABASE parameters in settings.py

`DATABASES = {

    'default': {

    'ENGINE': 'djongo',

    "CLIENT": {

    "host": f"mongodb+srv://{os.getenv('mongouserid')}:{os.getenv('mongopass')}@cluster0.b1vrwir.mongodb.net/?retryWrites=true&w=majority",

    "username": os.getenv('mongouserid'),

    "password": os.getenv('mongopass'),

    "name": "emailtrack",

    "authMechanism": "SCRAM-SHA-1",

    },
}

}`

Enter your cluster details by creating one on mongoDB Atlas

Then add your email id details you are using for sending emails

EMAIL_HOST = 'smtp.gmail.com' EMAIL_HOST_USER = os.getenv('id') EMAIL_HOST_PASSWORD =os.getenv('apppass') EMAIL_PORT = 587 EMAIL_USE_TLS = True EMAIL_TIMEOUT = 300 # in seconds DEFAULT_FROM_EMAIL = 'tt0367816@gmail.com'

First make an email which allow to send email through 3rd party application

Follow this to make TEST email


After successfully following above steps you can create API to send and track email

Important Note : You can only use these kind of APIs once after deploying it on any deployment servers

About

https://email-tracking-five.vercel.app


Languages

Language:HTML 50.2%Language:Python 49.8%