.. _auto_mailer:

*MAILS CONTENT TO A USER*
=========================

Sends an email to one or more recipients via PHPMailer, supporting optional SMTP configuration, CC/BCC addressing, and file attachments. Use this worker to deliver workflow notifications, reports, or any generated content to users from within a d3VIEW pipeline.

When to use
-----------

Tagged: ``"``, ``]``, ``a``, ``c``, ``e``, ``f``, ``h``, ``i``.

Inputs
------

.. list-table::
   :header-rows: 1
   :widths: 20 20 20 20 20 20

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - To Address
     - to_address
     - text
     - —
     - ✓
     - Recipient email address(es); accepts a single address or a comma-separated list for multiple recipients.
   * - Subject
     - subject
     - text
     - —
     - ✓
     - Plain-text subject line of the email.
   * - Body
     - body
     - textarea
     - —
     - ✓
     - Full email body content; supports HTML or plain text and can be authored in the built-in code editor.
   * - Files
     - files
     - file
     - —
     - 
     - Optional file attachment(s) to include with the email; reference by uploaded file name or platform attachment identifier.
   * - CC
     - mail_cc
     - text
     - —
     - 
     - Optional comma-separated list of email addresses to carbon-copy (CC) on the message.
   * - BCC
     - mail_bcc
     - text
     - —
     - 
     - Optional comma-separated list of email addresses to blind-carbon-copy (BCC) on the message.
   * - SMTP Host
     - smtp_host
     - text
     - —
     - 
     - Optional SMTP server hostname (e.g. smtp.example.com); leave blank to use the platform default mail transport.
   * - SMTP Port
     - smtp_port
     - text
     - —
     - 
     - Optional SMTP server port number (e.g. 465 for SSL, 587 for STARTTLS); leave blank when using the platform default.
   * - SMTP Auth Type
     - smtp_auth
     - text
     - ssl
     - 
     - SMTP authentication type; defaults to 'ssl' — set when a custom SMTP host requires authenticated connections.
   * - SMTP User
     - smtp_user
     - text
     - —
     - 
     - Username credential for SMTP authentication; required only when a custom smtp_host with auth is configured.
   * - SMTP Password
     - smtp_password
     - text
     - —
     - 
     - Password credential for SMTP authentication; required only when a custom smtp_host with auth is configured.
   * - From Email Address
     - from_email
     - text
     - noreply@d3view.com
     - 
     - Sender email address shown in the From field; defaults to noreply@d3view.com when left blank.
   * - From Name
     - from_name
     - text
     - d3VIEW Notifications
     - 
     - Display name shown alongside the sender address; defaults to 'd3VIEW Notifications' when left blank.

Outputs
-------

.. list-table::
   :header-rows: 1
   :widths: 20 20 20 20

   * - Label
     - ID
     - Type
     - Description
   * - Status
     - status
     - text
     - Delivery outcome indicator; returns 'error' on failure or is absent/empty on success — check alongside 'message' for details.

Disciplines
-----------

- platform.notification

.. raw:: html

   <hr style="margin-top:2em">
   <p style="font-size:11px;color:#888">
   Auto-generated from <code>platform</code> schema. Worker id: <code>mailer</code>. Schema hash: <code>1b2c36a27d7c</code>. Hand-curated docs in <code>workerexamples/</code> override this page when present.
   </p>