mirror of
https://github.com/Stirling-Tools/Stirling-PDF.git
synced 2025-05-11 16:55:54 +00:00

# Description of Changes Please provide a summary of the changes, including: - **What was changed** - Introduced a new `EmailService` for asynchronous email delivery with attachment support. - Added `MailConfig` to configure a `JavaMailSender` bean using SMTP settings from `ApplicationProperties`. - Created `EmailController` endpoint (`/api/v1/general/send-email`) to accept multipart/form-data requests for sending emails. - Defined an `Email` API model to encapsulate recipient, subject, body, and file input. - Extended `ApplicationProperties` to include a nested `Mail` class for SMTP host, port, username/password, and sender address. - Updated `settings.yml.template` to include SMTP configuration placeholders. - Enhanced `.github/labeler-config.yml` to cover all new security- and API-related source files for automated labeling. - **Why the change was made** - To enable Stirling-PDF to notify users via email—particularly useful for sending generated PDFs or alerts—directly from the application. - To centralize mail server configuration in application properties and streamline onboarding for new environments. --- ## Checklist ### General - [x] I have read the [Contribution Guidelines](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/CONTRIBUTING.md) - [x] I have read the [Stirling-PDF Developer Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/DeveloperGuide.md) (if applicable) - [ ] I have read the [How to add new languages to Stirling-PDF](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/HowToAddNewLanguage.md) (if applicable) - [x] I have performed a self-review of my own code - [x] My changes generate no new warnings ### Documentation - [ ] I have updated relevant docs on [Stirling-PDF's doc repo](https://github.com/Stirling-Tools/Stirling-Tools.github.io/blob/main/docs/) (if functionality has heavily changed) - [ ] I have read the section [Add New Translation Tags](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/HowToAddNewLanguage.md#add-new-translation-tags) (for new translation tags only) ### UI Changes (if applicable) - [ ] Screenshots or videos demonstrating the UI changes are attached (e.g., as comments or direct attachments in the PR) ### Testing (if applicable) - [ ] I have tested my changes locally. Refer to the [Testing Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/DeveloperGuide.md#6-testing) for more details.
100 lines
5.0 KiB
YAML
100 lines
5.0 KiB
YAML
Translation:
|
|
- changed-files:
|
|
- any-glob-to-any-file: 'src/main/resources/messages_*_*.properties'
|
|
- any-glob-to-any-file: 'scripts/ignore_translation.toml'
|
|
- any-glob-to-any-file: 'src/main/resources/templates/fragments/languages.html'
|
|
|
|
Front End:
|
|
- changed-files:
|
|
- any-glob-to-any-file: 'src/main/resources/templates/**/*'
|
|
- any-glob-to-any-file: 'src/main/resources/static/**/*'
|
|
- any-glob-to-any-file: 'src/main/java/stirling/software/SPDF/controller/web/**'
|
|
- any-glob-to-any-file: 'src/main/java/stirling/software/SPDF/UI/**/*'
|
|
|
|
Java:
|
|
- changed-files:
|
|
- any-glob-to-any-file: 'src/main/java/**/*.java'
|
|
|
|
Back End:
|
|
- changed-files:
|
|
- any-glob-to-any-file: 'src/main/java/stirling/software/SPDF/config/**/*'
|
|
- any-glob-to-any-file: 'src/main/java/stirling/software/SPDF/controller/**/*'
|
|
- any-glob-to-any-file: 'src/main/resources/settings.yml.template'
|
|
- any-glob-to-any-file: 'src/main/resources/application.properties'
|
|
- any-glob-to-any-file: 'src/main/resources/banner.txt'
|
|
- any-glob-to-any-file: 'scripts/png_to_webp.py'
|
|
- any-glob-to-any-file: 'split_photos.py'
|
|
|
|
Security:
|
|
- changed-files:
|
|
- any-glob-to-any-file: 'src/main/java/stirling/software/SPDF/config/interfaces/DatabaseInterface.java'
|
|
- any-glob-to-any-file: 'src/main/java/stirling/software/SPDF/config/security/**/*'
|
|
- any-glob-to-any-file: 'src/main/java/stirling/software/SPDF/controller/api/DatabaseController.java'
|
|
- any-glob-to-any-file: 'src/main/java/stirling/software/SPDF/controller/api/EmailController.java'
|
|
- any-glob-to-any-file: 'src/main/java/stirling/software/SPDF/controller/api/H2SQLController.java'
|
|
- any-glob-to-any-file: 'src/main/java/stirling/software/SPDF/controller/web/AccountWebController.java'
|
|
- any-glob-to-any-file: 'src/main/java/stirling/software/SPDF/controller/web/DatabaseWebController.java'
|
|
- any-glob-to-any-file: 'src/main/java/stirling/software/SPDF/controller/api/UserController.java'
|
|
- any-glob-to-any-file: 'src/main/java/stirling/software/SPDF/model/api/Email.java'
|
|
- any-glob-to-any-file: 'src/main/java/stirling/software/SPDF/model/exception/BackupNotFoundException.java'
|
|
- any-glob-to-any-file: 'src/main/java/stirling/software/SPDF/model/exception/NoProviderFoundExceptionjava'
|
|
- any-glob-to-any-file: 'src/main/java/stirling/software/SPDF/model/provider/**/*'
|
|
- any-glob-to-any-file: 'src/main/java/stirling/software/SPDF/model/AuthenticationType.java'
|
|
- any-glob-to-any-file: 'src/main/java/stirling/software/SPDF/model/ApiKeyAuthenticationToken.java'
|
|
- any-glob-to-any-file: 'src/main/java/stirling/software/SPDF/model/AttemptCounter.java'
|
|
- any-glob-to-any-file: 'src/main/java/stirling/software/SPDF/model/Authority.java'
|
|
- any-glob-to-any-file: 'src/main/java/stirling/software/SPDF/model/PersistentLogin.java'
|
|
- any-glob-to-any-file: 'src/main/java/stirling/software/SPDF/model/SessionEntity.java'
|
|
- any-glob-to-any-file: 'scripts/download-security-jar.sh'
|
|
- any-glob-to-any-file: '.github/workflows/dependency-review.yml'
|
|
- any-glob-to-any-file: '.github/workflows/scorecards.yml'
|
|
|
|
API:
|
|
- changed-files:
|
|
- any-glob-to-any-file: 'src/main/java/stirling/software/SPDF/config/OpenApiConfig.java'
|
|
- any-glob-to-any-file: 'src/main/java/stirling/software/SPDF/controller/web/MetricsController.java'
|
|
- any-glob-to-any-file: 'src/main/java/stirling/software/SPDF/controller/api/**/*'
|
|
- any-glob-to-any-file: 'src/main/java/stirling/software/SPDF/model/api/**/*'
|
|
- any-glob-to-any-file: 'scripts/png_to_webp.py'
|
|
- any-glob-to-any-file: 'split_photos.py'
|
|
- any-glob-to-any-file: '.github/workflows/swagger.yml'
|
|
|
|
Documentation:
|
|
- changed-files:
|
|
- any-glob-to-any-file: '**/*.md'
|
|
- any-glob-to-any-file: 'scripts/counter_translation.py'
|
|
- any-glob-to-any-file: 'scripts/ignore_translation.toml'
|
|
|
|
Docker:
|
|
- changed-files:
|
|
- any-glob-to-any-file: '.github/workflows/build.yml'
|
|
- any-glob-to-any-file: '.github/workflows/push-docker.yml'
|
|
- any-glob-to-any-file: 'Dockerfile'
|
|
- any-glob-to-any-file: 'Dockerfile.fat'
|
|
- any-glob-to-any-file: 'Dockerfile.ultra-lite'
|
|
- any-glob-to-any-file: 'exampleYmlFiles/*.yml'
|
|
- any-glob-to-any-file: 'scripts/download-security-jar.sh'
|
|
- any-glob-to-any-file: 'scripts/init.sh'
|
|
- any-glob-to-any-file: 'scripts/init-without-ocr.sh'
|
|
- any-glob-to-any-file: 'scripts/installFonts.sh'
|
|
- any-glob-to-any-file: 'test.sh'
|
|
- any-glob-to-any-file: 'test2.sh'
|
|
|
|
Devtools:
|
|
- changed-files:
|
|
- any-glob-to-any-file: '.devcontainer/**/*'
|
|
- any-glob-to-any-file: 'Dockerfile.dev'
|
|
|
|
Test:
|
|
- changed-files:
|
|
- any-glob-to-any-file: 'cucumber/**/*'
|
|
- any-glob-to-any-file: 'src/test/**/*'
|
|
- any-glob-to-any-file: 'src/testing/**/*'
|
|
- any-glob-to-any-file: '.pre-commit-config'
|
|
- any-glob-to-any-file: '.github/workflows/pre_commit.yml'
|
|
- any-glob-to-any-file: '.github/workflows/scorecards.yml'
|
|
|
|
Github:
|
|
- changed-files:
|
|
- any-glob-to-any-file: '.github/**/*'
|