ExamPlatform delivers notifications through two distinct channels: automated system emails triggered by platform events, and on-demand email announcements that admins can broadcast to targeted audiences. Individual users can personalise which automated emails they receive through their account Settings page. This reference covers every preference available to users, the admin announcement tool, the delivery log, and all automated emails the platform sends.Documentation Index
Fetch the complete documentation index at: https://mintlify.com/Saurabh-07586/examplatform/llms.txt
Use this file to discover all available pages before exploring further.
User Notification Preferences
Each user — student or examiner — can manage their own notification settings from Settings → Notifications. Changes take effect immediately for all future events.When enabled, the user receives an email whenever an exam they are enrolled in (or assigned to as an examiner) has its
start_time, end_time, or duration_minutes modified by an administrator. Recommended for all students to ensure they are always aware of the current exam schedule.When enabled, the platform sends automated reminder emails at 24 hours and 1 hour before the student’s next scheduled exam start time. Reminders include the exam title, subject, start time, and a direct link to the exam dashboard.
The language used for all ExamPlatform emails and the UI. Selecting a language here localises both the platform interface and all system-generated email content.
| Value | Language |
|---|---|
en | English |
hi | Hindi |
mr | Marathi |
ml | Malayalam |
ta | Tamil |
bn | Bengali |
te | Telugu |
kn | Kannada |
Controls the visual theme of the ExamPlatform interface for this user. The internal key for this preference is
User.theme_preference.| Value | Behaviour |
|---|---|
system | Follows the operating system’s light/dark mode setting |
light | Always use the light theme |
dark | Always use the dark theme |
Admin Email Announcements
Administrators can compose and send a one-time email blast to any audience directly from Admin → Announcements → New Announcement. Use this tool to share important updates, policy changes, or reminders that fall outside the automated notification schedule.Composing an Announcement
The recipient audience for this announcement.
| Value | Label | Recipients |
|---|---|---|
all_students | All students | Every student account on the platform |
all_examiners | All examiners | Every examiner account on the platform |
everyone | Everyone | All students and all examiners |
The email subject line. Keep it concise and specific — recipients see this before opening the email.
The body of the announcement email. Plain text is supported. Use clear, actionable language and include any relevant links or deadlines.
Delivery Log
Every announcement sent through the Admin tool is recorded in the Delivery Log, accessible at Admin → Announcements → Delivery Log. Use this log to confirm delivery status and troubleshoot failed sends.| Column | Description |
|---|---|
| Recipient | The email address the message was sent to |
| Subject | The subject line of the announcement or system email |
| Type | Whether the email was an admin Announcement or an automated System email |
| Status | Current delivery status: Delivered, Pending, or Failed |
| Sent | The UTC timestamp at which the message was dispatched by the platform |
Automated System Emails
ExamPlatform sends the following emails automatically based on platform events. These emails are not configurable by admins — they are triggered by the system and respect each user’slanguage_preference setting.
| Trigger | Recipient | |
|---|---|---|
| Account Creation Confirmation | A new user account is created | The new user |
| Password Reset Link | A user requests a password reset | The requesting user |
| Exam Reminder | 24 hours before exam start time | Enrolled students (if email_exam_reminders is enabled) |
| Exam Reminder | 1 hour before exam start time | Enrolled students (if email_exam_reminders is enabled) |
| Results Published | An administrator publishes exam results | Enrolled students |