mir-mailer-with-file-plugin

Overview

The mir-mailer-with-file-plugin extends MyCoRe/MIR with the ability to send emails directly from the frontend. A dedicated servlet processes form submissions, validates captchas, handles optional file uploads, and executes configurable form submission handlers.

Key Features

• Validates captchas on form submission
• Supports file uploads
• Allows configurable form submission handlers per action
• Template-based mail body rendering
• Filters unwanted sender domains
• Unified servlet backend for all mail forms

Installation

• Copy jar to ~/.mycore/(dev-)mir/lib/
• Configure mycore.properties if necessary

Configuration

Required Properties

• MIR.MailerWithFileServlet.DisallowedEmailDomains
  A list of blocked sender domains.

---

Configuring a from submission handler for an action

Each action is associated with a dedicated FormSubmissionHandler. Optionally, captcha validation can be activated. Example configuration:

# Enable captcha validation
MIR.MailerWithFileServlet.submit_request.CaptchaRequired=true
# FormSubmissionHandler for action "submit_request"
MIR.MailerWithFileServlet.submit_request.FormSubmissionHandler.Class=org.mycore.mir.handler.MIRFormSubmissionMailHandler
# Sender (e.g., '<name> [email protected]' or '[email protected]' or '<[email protected]>')
MIR.MailerWithFileServlet.submit_request.FormSubmissionHandler.Sender=%MCR.mir-module.EditorMail%
# Comma seperated recipients (e.g. 'a,b,c'), see .Sender for format
MIR.MailerWithFileServlet.submit_request.FormSubmissionHandler.Recipients=%MCR.mir-module.EditorMail%
# Body renderer for the mail
MIR.MailerWithFileServlet.submit_request.FormSubmissionHandler.BodyRenderer.Class=org.mycore.mir.handler.MIRStringTemplateMailBodyRenderer
MIR.MailerWithFileServlet.submit_request.FormSubmissionHandler.BodyRenderer.TemplatePath=/submit_request_template.txt
# Mail subject
MIR.MailerWithFileServlet.submit_request.FormSubmissionHandler.Subject=[PublicationServer] - Online Submission
# Comma seperated extra required field names (optional)
MIR.MailerWithFileServlet.submit_request.FormSubmissionHandler.RequiredFieldNames=
# Attachment upload path
MIR.MailerWithFileServlet.submit_request.FormSubmissionHandler.Attachment.UploadPath=%MCR.datadir%/fileupload
# Attachment min count (optional)
#MIR.MailerWithFileServlet.submit_request.FormSubmissionHandler.Attachment.MinCount=1
# Attachment max count (optional)
#MIR.MailerWithFileServlet.submit_request.FormSubmissionHandler.Attachment.MaxCount=1
# Attachment max file size in bytes (optional)
#MIR.MailerWithFileServlet.submit_request.FormSubmissionHandler.Attachment.MaxFileSize=
# Attachment max total count in bytes (optional)
#MIR.MailerWithFileServlet.submit_request.FormSubmissionHandler.Attachment.MaxTotalCount=

Frontend Integration

The plugin provides the MIRMailerWithFileServlet, which processes different actions and recognizes special form fields. The servlet handles captcha or maps the action to a defined form submission handler.

Actions

Path	Purpose
captcha	Returns a captcha image
captcha-play	Returns an audio with captcha content
<handler>	Executes the configured form submission handler for <handler>

---

Reserved Form Fields

These fields are interpreted and processed specially by the servlet:

Field Name	Purpose	Default	Required
action	Determines which form submission handler to invoke	null	yes
name	Sender's name	null	yes
mail	Sender's email	null	yes
captcha	User input used for captcha validation	null	yes
file	Uploaded file	null	no
copy	Send a copy to the sender (boolean)	false	no

---

Example HTML Form

<form method="post" enctype="multipart/form-data" action="/servlets/MIRMailerWithFileServlet">
  <input type="hidden" name="action" value="submit_request">
    
  <label>Name: <input type="text" name="name"></label>
  <label>Email: <input type="email" name="mail"></label>
  <label>File: <input type="file" name="file"></label>
    
  <img id="captcha-image" src="/servlets/MIRMailerWithFile?action=captcha" alt="captcha" />
  <a href="#" id="captcha-refresh">Refresh captcha</a>
  <a href="#play" id="captcha-play">Play captcha audio</a>
  <a href="#stop" id="captcha-stop" class="d-none">Stop captcha audio</a>

  <input type="text" id="captcha-input" name="captcha" required />
    
  <label><input type="checkbox" name="copy" value="true"> Send me a copy</label>
  
  <button type="submit" id="save">Submit</button>
</form>

<script src="/js/captcha.js" type="text/javascript" />
<script src="/js/mailer-with-file.js" type="text/javascript" />