Notify User via Email - Documentation

Overview

The Notify User via Email functionality allows users to send email notifications by clicking the Notify button. A dialog box appears, prompting the user to enter email details, including the sender's email, password, and email service provider. Upon clicking Send, the backend API processes the email request and delivers it to the recipient.

Features

User-friendly Interface: Provides an intuitive dialog box for email input.
Secure Processing: Handles credentials securely.
Supports Multiple Providers: Compatible with common email services (e.g., Gmail, Outlook).
Real-time Feedback: Displays success or failure messages.

User Flow

Trigger Notification: The user clicks the Notify button.
Enter Email Details: A dialog box appears with fields for:
- Sender Email Address
- Password
- SMTP Provider (Dropdown: Gmail, Outlook)
- Recipient Email Address
- Subject
- Message Body
- Attachment
Submit Request: The user clicks Send, triggering the backend API.
Processing & Delivery: The backend verifies credentials, connects to the email provider, and sends the email.
Confirmation: The system displays a success or error message.

API Endpoints

1. Send Email

Endpoint: POST /api/notify

Request Body:

{
  "senderEmail": "user@example.com",
  "password": "securepassword",
  "smtpProvider": "Gmail",
  "recipientEmail": "recipient@example.com",
  "subject": "Notification Subject",
  "message": "This is the email body."
}

Response:

{
  "status": "success",
  "message": "Email sent successfully."
}

Security Considerations

Encryption: Ensure sensitive credentials (passwords) are encrypted during transmission.

Space Level Notify

The Space Level Notify feature includes all pages containing findings. This ensures that notifications are sent based on specific reports or updates across various sections of the platform. Users can configure notifications to cover:

Comprehensive Reports: Send notifications for all findings across different pages.
User Notify: Ensure notifications are sent based on user entered email.

This functionality enhances communication by keeping relevant stakeholders informed of critical findings.

On clicking "Notify," a dialog box will open prompting you to enter email details, including fields and a findings attachment.

Page Level Notify

The Page Level Notify feature allows users to send notifications related to specific pages containing findings. This ensures that notifications are more targeted and relevant. Users can configure notifications to include:

Specific Page Findings: Notify users about findings on a selected page.
User-Specific Notifications: Send alerts to specific users based on page-level.

This feature ensures that the right information reaches the right people at the right time, improving workflow efficiency and issue resolution.

Clicking on a space in the main dashboard table will open a dialog displaying all page findings. For each page, you can send a notification and attach the findings using the email notification dialog.

As like the space level same notify dialog will open upon clicking of Notify button.

Conclusion

The Notify User via Email feature provides a seamless way to send notifications via email. With secure authentication, real-time feedback, and multi-provider support, it ensures efficient and reliable email communication.

Note: Confirmation is required at one level of notification, either at the page level or the space level.

Atlassian Apps - Internal

Security App || Confluence || Feature Enhancement - Notify

Analytics