LudyandGitHub
52f09f1840
# Description of Changes - **What was changed** - Updated controller methods to use strongly‐typed primitives (`int`, `long`, `boolean`) instead of `String` for numeric and boolean parameters, eliminating calls to `Integer.parseInt`/`Long.parseLong` and improving null‐safety (`Boolean.TRUE.equals(...)`). - Enhanced all API request model classes with richer Swagger/OpenAPI annotations: added `requiredMode`, `defaultValue`, `allowableValues`, `format`, `pattern`, and tightened schema descriptions for all fields. - Refactored HTML form templates for “Remove Blank Pages” to include `min`, `max`, and `step` attributes on numeric inputs, matching the updated validation rules. - **Why the change was made** - **Type safety & robustness**: Shifting from `String` to native types prevents runtime parsing errors, simplifies controller logic, and makes default values explicit. - **Better API documentation & validation**: Enriching the Swagger annotations ensures generated docs accurately reflect required fields, default values, and permitted ranges, which improves client code generation and developer experience. - **Consistency across codebase**: Aligning all request models and controllers enforces a uniform coding style and reduces bugs. #3406 --- ## 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.
65 lines
2.7 KiB
Java
65 lines
2.7 KiB
Java
package stirling.software.SPDF.controller.api;
|
|
|
|
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
|
|
import org.springframework.http.HttpStatus;
|
|
import org.springframework.http.ResponseEntity;
|
|
import org.springframework.web.bind.annotation.ModelAttribute;
|
|
import org.springframework.web.bind.annotation.PostMapping;
|
|
import org.springframework.web.bind.annotation.RequestMapping;
|
|
import org.springframework.web.bind.annotation.RestController;
|
|
|
|
import io.swagger.v3.oas.annotations.Operation;
|
|
import io.swagger.v3.oas.annotations.tags.Tag;
|
|
|
|
import jakarta.mail.MessagingException;
|
|
import jakarta.validation.Valid;
|
|
|
|
import lombok.RequiredArgsConstructor;
|
|
import lombok.extern.slf4j.Slf4j;
|
|
|
|
import stirling.software.SPDF.config.security.mail.EmailService;
|
|
import stirling.software.SPDF.model.api.Email;
|
|
|
|
/**
|
|
* Controller for handling email-related API requests. This controller exposes an endpoint for
|
|
* sending emails with attachments.
|
|
*/
|
|
@RestController
|
|
@RequestMapping("/api/v1/general")
|
|
@RequiredArgsConstructor
|
|
@Slf4j
|
|
@Tag(name = "General", description = "General APIs")
|
|
@ConditionalOnProperty(value = "mail.enabled", havingValue = "true", matchIfMissing = false)
|
|
public class EmailController {
|
|
private final EmailService emailService;
|
|
|
|
/**
|
|
* Endpoint to send an email with an attachment. This method consumes a multipart/form-data
|
|
* request containing the email details and attachment.
|
|
*
|
|
* @param email The Email object containing recipient address, subject, body, and file
|
|
* attachment.
|
|
* @return ResponseEntity with success or error message.
|
|
*/
|
|
@PostMapping(consumes = "multipart/form-data", value = "/send-email")
|
|
@Operation(
|
|
summary = "Send an email with an attachment",
|
|
description =
|
|
"This endpoint sends an email with an attachment. Input:PDF"
|
|
+ " Output:Success/Failure Type:MISO")
|
|
public ResponseEntity<String> sendEmailWithAttachment(@Valid @ModelAttribute Email email) {
|
|
log.info("Sending email to: {}", email.toString());
|
|
try {
|
|
// Calls the service to send the email with attachment
|
|
emailService.sendEmailWithAttachment(email);
|
|
return ResponseEntity.ok("Email sent successfully");
|
|
} catch (MessagingException e) {
|
|
// Catches any messaging exception (e.g., invalid email address, SMTP server issues)
|
|
String errorMsg = "Failed to send email: " + e.getMessage();
|
|
log.error(errorMsg, e); // Logging the detailed error
|
|
// Returns an error response with status 500 (Internal Server Error)
|
|
return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(errorMsg);
|
|
}
|
|
}
|
|
}
|