mail

Implement, configure, and debug email delivery in OrangeHRM.

1.1k|746|Updated Jan 5, 2017
One-click install
npx skills add https://github.com/orangehrm/orangehrm --skill mail-orangehrm
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: mail
Source: https://github.com/orangehrm/orangehrm/tree/main/.agents/skills/mail
Command: npx skills add https://github.com/orangehrm/orangehrm --skill mail-orangehrm

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill eliminates the complexity of implementing, configuring, and debugging email functionality in OrangeHRM, removing the need to manually manage low-level mailer logic, queue draining, or template fallbacks.

Core Features & Use Cases

  • Event-Triggered Email Automation: Queue and send emails triggered by domain events (leave approvals, password resets, employee updates) using OrangeHRM's standard queue-and-deferred pattern to avoid blocking user requests with SMTP latency.
  • Template Management: Create and localize Twig email templates per event and locale, with automatic fallback to English for missing translations.
  • SMTP Configuration & Debugging: Configure encrypted SMTP or sendmail settings, troubleshoot undelivered emails, and send test emails to verify delivery.
  • Use Case: When an employee submits a leave request, the Skill automatically queues a confirmation email to the employee and a notice to their supervisor, sent after the user receives their request confirmation to avoid delays.

Quick Start

Use this skill to set up a new email notification that sends an immediate password reset link to users when they request a password change, ensuring the email is delivered before the user navigates away from the request page.

Frequently Asked Questions about mail

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I configure OrangeHRM email notifications for leave approvals?

OrangeHRM email notifications for leave approvals use an event-triggered queue-and-deferred pattern to avoid blocking user requests with SMTP latency. Domain events automatically queue confirmation emails to employees and notices to supervisors for delayed processing.

How do I add a new localized email template in OrangeHRM?

Adding localized email templates in OrangeHRM involves creating Twig templates per event and locale. The system automatically falls back to English templates for missing translations, ensuring consistent email delivery across different languages.

Why are my OrangeHRM emails not being delivered to users?

Undelivered OrangeHRM emails often require troubleshooting encrypted SMTP or sendmail settings and verifying the ohrm_email_queue table. Sending test emails helps verify delivery configuration and identify whether messages are failing at the queue or transport level.

Can I send an immediate password reset email without using the OrangeHRM queue?

OrangeHRM supports immediate direct sends for password reset links alongside the standard queue-and-deferred pattern. This ensures time-sensitive emails are delivered before the user navigates away from the request page, bypassing queue latency.

How does event-subscriber email handling work in OrangeHRM?

Event-subscriber email handling in OrangeHRM uses MailerSubscriber components to listen for domain events like employee updates or leave approvals. The EmailService then processes these events to queue or directly send messages using configured Twig templates.

Do I need encrypted SMTP credentials to set up email delivery in OrangeHRM?

OrangeHRM email configuration requires handling encrypted SMTP credentials within the EmailConfiguration entity. This ensures secure storage and transmission of mail server authentication details when configuring SMTP or sendmail delivery methods.