How Do I Configure Email in a Full Development Environment

 

Introduction
Configuring email in a full development environment for Oracle APEX is essential for testing and validating the application's ability to send notifications, confirmations, and alerts. Unlike production environments, development environments require flexible, secure, and test-friendly SMTP setups. This includes configuring SMTP parameters, enabling the APEX_MAIL package, and using tools like mail traps or staging email servers to avoid sending real emails during development.

 

1. Sign in to Oracle APEX Administration Services.

2. Go to "Manage Instance" and select "Instance Settings".

3. Navigate to the Email section under "Storage".

4. Enter the required SMTP settings and save the changes.

To configure email in a full development environment for Oracle APEX, you need to set up an email delivery path that mimics production but is safe for testing. This means connecting Oracle APEX to a valid SMTP server or using a mail trap service to catch outgoing emails without actually sending them to real users. This setup helps developers test APEX features like password resets, contact forms, and workflow alerts in a controlled, secure way.

Here’s a detailed breakdown of how to configure email in a full development environment:

1. Choose a Mail Server or Mail Trap
   In a development environment, you can use one of the following:

   • A test SMTP service like MailHog, Papercut, or smtp4dev running locally.

   • A cloud-based trap like Mailtrap.io, Mailosaur, or SendGrid in sandbox mode.

   • Your organization’s test SMTP server, isolated from production.

2. Configure SMTP Settings for APEX
   Oracle APEX relies on SMTP settings configured in the environment. How you configure these depends on your APEX setup:

   • APEX on ORDS (On-Premise):
     In your ORDS config directory (typically under config/ords/standalone/ or similar), locate or create the file ords.defaults.properties and add:

     mail.smtp.host=smtp.mailtrap.io
     mail.smtp.port=2525
     mail.smtp.username=your_username
     mail.smtp.password=your_password
     mail.smtp.auth=true
     mail.smtp.starttls.enable=true
     

     Restart ORDS after making changes.

   • APEX on Oracle Cloud or Autonomous Database:
     Go to Manage Instance > Instance Settings > Email from the APEX Administration Services and enter the SMTP host, port, username, and password.

3. Grant Access to APEX_MAIL Package
   Ensure your application schema can use the APEX mail features:

   GRANT EXECUTE ON APEX_MAIL TO your_schema;
   

4. Send a Test Email Using PL/SQL
   In your application (e.g., in a page process or button click event), test email delivery:

   BEGIN
     APEX_MAIL.SEND(
       p_to        => 'developer@fakeemail.com',
       p_from      => 'noreply@yourdevapp.com',
       p_subj      => 'Development Test Email',
       p_body      => 'This is a plain text email for testing.',
       p_body_html => '<p>This is an <strong>HTML</strong> test email from development.</p>'
     );
   
     APEX_MAIL.PUSH_QUEUE;
   END;
   

   After running this, check your test mailbox or mail trap to confirm delivery.

5. Push the Mail Queue in Development
   If the environment does not automatically process the mail queue, use:

   BEGIN
     APEX_MAIL.PUSH_QUEUE;
   END;
   

   This manually triggers the queue to send pending emails.

6. Use Test-Friendly Email Addresses
   Never use real customer email addresses in development. Use dummy addresses or those controlled by your development team to avoid accidental delivery.

7. Monitor and Debug

   • Use the APEX_MAIL_LOG to view email status:

     SELECT * FROM APEX_MAIL_LOG ORDER BY SENT_DATE DESC;
     

   • Use the APEX_MAIL_QUEUE to view emails waiting to be sent:

     SELECT * FROM APEX_MAIL_QUEUE;
     

8. Secure Your Configuration

   • Keep credentials out of version-controlled files.

   • Use environment variables or encrypted properties for storing SMTP credentials.

   • Do not expose your test SMTP credentials to public-facing applications.

9. Automate Email Testing in Dev
   Consider building a simple test page in your APEX app where developers can send test emails using sample data. This speeds up verification without triggering real workflows.

10. Use Application Items for Dynamic Testing
    For greater flexibility, use APEX application items to hold test email addresses or formats. This lets you change values without editing PL/SQL code.

By setting up a safe and controlled email configuration in your Oracle APEX development environment, you ensure that email features are fully tested without the risk of accidentally contacting real users. This practice leads to smoother rollouts and reliable communication when your application goes live.

 Conclusion
Setting up email in a full development environment allows developers to simulate and verify email functionality without risking unintended communication. With proper SMTP configuration, secure handling of credentials, and tools for email testing, you can ensure that all messaging features work correctly before deploying to production—resulting in a smoother, safer development process.