MAIL::MAIL 1g 2024-03-12 laplante@plcb.ca GOWEB/MAIL

title: “MAIL::MAIL” author: “laplante@plcb.ca” date: 2024-03-12 version: “1.0.2” section: “1g”

category: “GOWEB/MAIL”

Name

mail::mail — Send an email

Synopsis

mail::mail(from: string, to: string [, format: “goweb”, charset: string, ct: string, encoding: string, port: int, host: string, username: string, password: string, cc: string, bcc: string, message: string, subject: string, error: variable, content: array])

Description

The mail::mail function is used to send emails.
It supports plain text, HTML, attachments, and multipart content.

Parameters

from : Sender email address.
to : Recipient email address.
host : Mail server host.
port : Mail server port (e.g., 25, 465, 587).
username / password : Credentials for SMTP authentication.
subject : Email subject line.
message : Main email body.
cc : Carbon copy recipients.
bcc : Blind carbon copy recipients.
error : Captures any error message.
charset : Character set (default: UTF-8).
ct : Content type (default: text/plain). If set to "guess", the system attempts to determine the type automatically.
encoding : Content encoding (default: none). Supported value: "base64". Other values are ignored.
format : If "goweb", the message body is processed by goweb before being sent. Default is "goweb".
content : Defines multipart content as an array of sections. Each part can include:

content: [
  { charset: string, encoding: string, format: text|goweb, file: string|inline: string, ct: string },
  ...
]

This allows sending inline content, attachments, or multipart alternatives (e.g., plain text + HTML).

Examples

mail(
    from: "goweb@plcb.ca",
    host: "eris",
    password: "...",
    port: 587,
    to: "laplante@plcb.ca",
    subject: "Test with content Example été",
    ct: "text/html",
    cc: "laplante.p@gmail.com",
    encoding: "base64",
    message: "<div dir=\"ltr\"><b>TEST MAC éèçÉÈÇâ {{ datetime() }}</b></div>",
    format: "goweb",
    content: [
        { "message": "Content part inline1" },
        { "format": "goweb", "message": "Content part inline2 {{ datetime(); }}" },
        { "ct": "guess", "file": "moi.png" },
        [
          { "ct": "text/plain", "message": "Content multipart inline3" },
          { "ct": "text/html", "message": "<h1>Content multipart inline3</h1>" }
        ]
    ]
);

Author

laplante@plcb.ca

Version

1.0.2 — 2024-03-12, added charset, encoding, and ct
1.0.1 — 2024-03-02, added cc and bcc
1.0.0 — 2023-12-25, initial version