-
Notifications
You must be signed in to change notification settings - Fork 4
docs: mail master documentation #38
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
bhushan-nemade-dt
wants to merge
6
commits into
devtron-labs:main
Choose a base branch
from
bhushan-nemade-dt:mail-master
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
19bd2ca
gcs-create-bucket plugin doc
bhushan-nemade-dt 3368563
fix
bhushan-nemade-dt 3596dda
Merge remote-tracking branch 'upstream/main'
bhushan-nemade-dt 725eb6d
GKE plugin update
bhushan-nemade-dt 22a68a3
doc for mail master plugin
bhushan-nemade-dt 6523669
minor changes at steps
bhushan-nemade-dt File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,68 @@ | ||||||
| # Mail Master | ||||||
|
|
||||||
| ## Introduction | ||||||
| The Mail Master plugin by Devtron streamlines email communication by enabling automated bulk email notifications through your configured SMTP server. It helps keep all stakeholders informed throughout the application lifecycle, ensuring seamless communication for workflow events. When integrated into Devtron's post-CD stage, this plugin can automatically notify multiple team members, project managers, clients, and other stakeholders about new application deployments. To ensure that everyone stays informed about the latest changes and features. | ||||||
|
|
||||||
| ### Prerequisites | ||||||
| Before integrating the **Mail Master** plugin, you must ensure that you have properly configured SMTP notifications in your Devtron setup. | ||||||
|
|
||||||
| --- | ||||||
|
|
||||||
| ## Steps | ||||||
| 1. Go to **Applications** → **Devtron Apps**. | ||||||
| 2. Click your application. | ||||||
| 3. Go to **App Configuration** → **Workflow Editor**. | ||||||
| 4. Click **New Workflow** and navigate to the **Build and Deploy from Source Code**. | ||||||
| 5. Fill the required fields in the **Create deploy pipeline** window and navigate to the **Post-deploy stage**. | ||||||
|
|
||||||
| {% hint style="warning" %} | ||||||
| If you have already configured workflow, edit deployment pipeline, and navigate to **Post-deploy stage**. | ||||||
| {% endhint %} | ||||||
|
|
||||||
| 6. Under 'TASKS', click the **+ Add task** button. | ||||||
| 7. Click the **Mail Master** plugin. | ||||||
| 8. Enter the following [user inputs](#user-inputs) with appropriate values. | ||||||
|
|
||||||
| --- | ||||||
|
|
||||||
| ## User Inputs | ||||||
|
|
||||||
| ### Task Name | ||||||
| Enter the name of your task | ||||||
|
|
||||||
| e.g., `Mail Master` | ||||||
|
|
||||||
| ### Description | ||||||
| Add a brief explanation of the task and the reason for choosing the plugin. Include information for someone else to understand the purpose of the task. | ||||||
|
|
||||||
| e.g., `The Mail Master plugin is integrated for sending bulk automated email notifications to relevant stakeholders.` | ||||||
|
|
||||||
| ### Input Variables | ||||||
| | Variable | Format | Description | Sample Value | | ||||||
| | ------------------------ | ------------ | ----------- | ------------ | | ||||||
| | SmtpServer | STRING | The host name of SMTP server | smtp.gmail.com | | ||||||
| | SmtpUsername | STRING | The username of SMTP connection | user@example.com | | ||||||
| | SmtpPassword | STRING | Password of SMTP connection | mysecretpassword | | ||||||
| | SenderEmail | STRING | Sender's email address | sender@example.com | | ||||||
| | EmailContentFile | STRING | Provide path of email content file | /path/to/emailContent.html | | ||||||
| | SmtpPort | NUMBER | Port that will be used for SMTP connection. Default port is 587 | 433 | | ||||||
| | RecipientConfigFile | STRING | Provide path of config.json, that contains list of recipients | /path/to/recipientsConfig.json | | ||||||
| | EmailSubject | STRING | Provide subject for the email. Subject can also be provided in `EmailContentFile` after "Subject" | "Monthly Release" | | ||||||
| | BatchSize | NUMBER | Number of emails that should be sent per batch. The default number is 10 | 200 | | ||||||
| | BatchDelayTime | NUMBER | Time to wait in two batch (in seconds) | 15 | | ||||||
|
||||||
| | BatchDelayTime | NUMBER | Time to wait in two batch (in seconds) | 15 | | |
| | BatchDelayTime | NUMBER | Time to wait between two batches (in seconds) | 15 | |
Copilot
AI
Oct 8, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Corrected spelling of 'seprated' to 'separated'.
Suggested change
| | Recipients | STRING | Emails of recipients seprated by "," if user is not specified in config.json file | recipient1@example.com,recipient2@example.com | | |
| | Recipients | STRING | Emails of recipients separated by "," if user is not specified in config.json file | recipient1@example.com,recipient2@example.com | |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's inconsistent whitespace formatting with a tab character before the sample value. Should use consistent spacing like other rows in the table.