module
Version:
v0.0.0-...-ca9cc58
Opens a new window with list of versions in this module.
Published: Jul 17, 2023
License: Apache-2.0
Opens a new window with license information.
README
¶
ET
Email Tracker
Notify you when someone opens the email.
Status
Design
- Users provide their email address to receive notifications.
- Server generate an uniq
track ID
and returns to user,
in the format of a 1x1 pixel png link.
- User insert the png link into the email waiting to send.
- When someone opens the link (
/t/xxxx-xxxx-xxxx
), server will send
a notification email to the email address provided.
- Since there is no way to identify the target's name, user can optionally
set a target username or some comments to the
track task
.
- Allow user to extend the notify times since the user could click
the link by mistake.
- Allow user to check the task status by the
track ID
in case
of notify email failed to sent.
API
- GET
/
Index page, provide a beautiful task submit portal.
- GET
/t/****
Track task handler, always returns a 1x1 pixel png file.
Server will do something according to the track ID.
/api/
Raw API entrypoint, user can check task status, submit tasks
and so on.
/api/task/
- POST
../submit
submit a new track task
- POST
../resume?id=****
resume the stopped task
- GET
../get?id=****
get task status, all notifications sent
/api/status
- GET
../task?total
return a status badge of total task handled
- GET
../task?daily
return a status badge of daily task handled
- GET
../notified?total
return a status badge of total email sent
- GET
../notified?daily
return a status badge of daily email sent
Constraints
- Same IP address can submit 10 tasks daily(per 24 hours).
Can do this in memory, not a big deal.
- After sent 5 emails, automatically stop this task,
user can resume the task once.
- Validate notifier's email, same email address can
only receive 50 emails pre day.
Directories
¶
Click to show internal directories.
Click to hide internal directories.