<?php
// ==============================
//            CONTENTS            
// ==============================
// PHP_MAIL_MAIL - BEGIN
// OFFLINE | PHP_MAIL_MAIL_EZMLM_HASH - int php_mail_mail_ezmlm_hash(string $addr)
// PHP_MAIL_MAIL_MAIL - bool php_mail_mail_mail(string $to, string $subject, string $message, array|string $additional_headers = array(), string $additional_params = "")
// PHP_MAIL_MAIL - END
// ==============================


// ============================== BEGIN
//          REQUIREMENTS          
// ============================== SUPPORT
// PHP_4 - PHP_8
// ============================== INSTALLATION
// CORE (No installation needed to use these functions; they are part of the PHP core)
// ============================== USING FUNCTIONS (2)
// OFFLINE | ezmlm_hash() - PHP_4 >= PHP_4_0_2, PHP_5, PHP_7
// mail() - PHP_4, PHP_5, PHP_7, PHP_8
// ============================== USING CLASSES (0)
// ============================== USING DATA_TYPES (4)
// bool
// string
// array
// int
// ============================== END
//          REQUIREMENTS          
// ==============================


// ============================== BEGIN
//         PHP_MAIL_MAIL         
// ============================== ABOUT
// PHP Manual / Function Reference / Mail Related Extensions / Mail
// URL: https://www.php.net/manual/en/book.mail.php
// ============================== DESCRIPTION
// MAIL
// 
// MAIL - BEGIN
// Mail
// 
// INTRODUCTION
// INSTALLING_CONFIGURING
// PREDEFINED_CONSTANTS
// MAIL_FUNCTIONS
// 
// INTRODUCTION - BEGIN
// Introduction
// 
// The mail() function allows you to send mail.
// 
// LITERATURE_SOURCES
// * PHP_NET (2023-09-06)
// URL: https://www.php.net/manual/en/intro.mail.php
// INTRODUCTION - END
// 
// INSTALLING_CONFIGURING - BEGIN
// Installing/Configuring
// 
// REQUIREMENTS
// INSTALLATION
// RUNTIME_CONFIGURATION
// RESOURCE_TYPES
// 
// REQUIREMENTS - BEGIN
// Requirements
// 
// For the Mail functions to be available, PHP must have access to the sendmail binary on your system during compile time. If you use another mail program, such as qmail or postfix, be sure to use the appropriate sendmail wrappers that come with them. PHP will first look for sendmail in your PATH, and then in the following: /usr/bin:/usr/sbin:/usr/etc:/etc:/usr/ucblib:/usr/lib. It's highly recommended to have sendmail available from your PATH. Also, the user that compiled PHP must have permission to access the sendmail binary.
// 
// LITERATURE_SOURCES
// * PHP_NET (2023-09-06)
// URL: https://www.php.net/manual/en/mail.requirements.php
// REQUIREMENTS - END
// 
// INSTALLATION - BEGIN
// Installation
// 
// There is no installation needed to use these functions; they are part of the PHP core.
// 
// LITERATURE_SOURCES
// * PHP_NET (2023-09-06)
// URL: https://www.php.net/manual/en/mail.installation.php
// INSTALLATION - END
// 
// RUNTIME_CONFIGURATION - BEGIN
// Runtime Configuration
// 
// The behaviour of these functions is affected by settings in php.ini.
// 
// Mail configuration options
// Name                        | Default                    | Changeable                    | Changelog
// mail.add_x_header           | "0"                        | PHP_INI_PERDIR                |
// mail.log                    | NULL                       | PHP_INI_SYSTEM|PHP_INI_PERDIR |
// mail.force_extra_parameters | NULL                       | PHP_INI_SYSTEM|PHP_INI_PERDIR |
// SMTP                        | "localhost"                | PHP_INI_ALL                   |
// smtp_port                   | "25"                       | PHP_INI_ALL                   |
// sendmail_from               | NULL                       | PHP_INI_ALL                   |
// sendmail_path               | "/usr/sbin/sendmail -t -i" | PHP_INI_SYSTEM                |
// 
// For further details and definitions of the PHP_INI_* modes, see the Where a configuration setting may be set.
// Here's a short explanation of the configuration directives.
// 
// mail.add_x_header bool             - Add X-PHP-Originating-Script that will include UID of the script followed by the filename.
// mail.log string                    - The path to a log file that will log all mail() calls. Log entries include the full path of the script, line number, To address and headers.
// mail.force_extra_parameters string - Force the addition of the specified parameters to be passed as extra parameters to the sendmail binary. These parameters will always replace the value of the 5th parameter to mail().
// SMTP string                        - Used under Windows only: host name or IP address of the SMTP server PHP should use for mail sent with the mail() function.
// smtp_port int                      - Used under Windows only: Number of the port to connect to the server specified with the SMTP setting when sending mail with mail(); defaults to 25.
// sendmail_from string               - Which "From:" mail address should be used in mail sent directly via SMTP (Windows only). This directive also sets the "Return-Path:" header.
// sendmail_path string               - Where the sendmail program can be found, usually /usr/sbin/sendmail or /usr/lib/sendmail. configure does an honest attempt of locating this one for you and set a default, but if it fails, you can set it here.
// Systems not using sendmail should set this directive to the sendmail wrapper/replacement their mail system offers, if any. For example, > Qmail users can normally set it to /var/qmail/bin/sendmail or /var/qmail/bin/qmail-inject.
// qmail-inject does not require any option to process mail correctly.
// This directive works also under Windows. If set, smtp, smtp_port and sendmail_from are ignored and the specified command is executed.
// 
// LITERATURE_SOURCES
// * PHP_NET (2023-09-06)
// URL: https://www.php.net/manual/en/mail.configuration.php
// RUNTIME_CONFIGURATION - END
// 
// RESOURCE_TYPES - BEGIN
// Resource Types
// 
// This extension has no resource types defined.
// 
// LITERATURE_SOURCES
// * PHP_NET (2023-09-06)
// URL: https://www.php.net/manual/en/mail.resources.php
// RESOURCE_TYPES - END
// 
// LITERATURE_SOURCES
// * PHP_NET (2023-09-06)
// URL: https://www.php.net/manual/en/mail.setup.php
// INSTALLING_CONFIGURING - END
// 
// PREDEFINED_CONSTANTS - BEGIN
// Predefined Constants
// 
// This extension has no constants defined.
// 
// LITERATURE_SOURCES
// * PHP_NET (2023-09-06)
// URL: https://www.php.net/manual/en/mail.constants.php
// PREDEFINED_CONSTANTS - END
// 
// MAIL_FUNCTIONS - BEGIN
// Mail Functions
// 
// Table of Contents
// * ezmlm_hash - Calculate the hash value needed by EZMLM
// * mail       - Send mail
// 
// LITERATURE_SOURCES
// * PHP_NET (2023-09-06)
// URL: https://www.php.net/manual/en/ref.mail.php
// MAIL_FUNCTIONS - END
// 
// LITERATURE_SOURCES
// * PHP_NET (2023-09-06)
// URL: https://www.php.net/manual/en/book.mail.php
// MAIL - END
// ==============================


// ============================== BEGIN
//    PHP_MAIL_MAIL_EZMLM_HASH    
// ============================== OFFLINE
// ============================== ABOUT
// Calculate the hash value needed by EZMLM.
// 
// Warning: This function has been DEPRECATED as of PHP 7.4.0, and REMOVED as of PHP 8.0.0. Relying on this function is highly discouraged.
// ============================== SUPPORT
// PHP_4 - PHP_7
// ============================== USING FUNCTIONS (1)
// ezmlm_hash() - PHP_4 >= PHP_4_0_2, PHP_5, PHP_7
// ============================== CODE
/*
function php_mail_mail_ezmlm_hash($addr)
{
$return_ezmlm_hash = 0;

// ========== EZMLM_HASH - BEGIN
// ===== ABOUT
// Calculate the hash value needed by EZMLM
// Warning: This function has been DEPRECATED as of PHP 7.4.0, and REMOVED as of PHP 8.0.0. Relying on this function is highly discouraged.
// ===== DESCRIPTION
// ezmlm_hash() calculates the hash value needed when keeping EZMLM mailing lists in a MySQL database.
// ===== SUPPORTED
// PHP_4 >= PHP_4_0_2, PHP_5, PHP_7
// ===== SYNTAX
// ezmlm_hash(string $addr): int
// ===== CODE
$return_ezmlm_hash = ezmlm_hash(

$addr // string addr - The email address that's being hashed.

); // Return Values
// The hash value of addr.
// 
// [examples]
// Examples
// [example]
// Example #1 Calculating the hash and subscribing a user
// [php]
// 
// $user = "joecool@example.com";
// $hash = ezmlm_hash($user);
// $query = sprintf("INSERT INTO sample VALUES (%s, '%s')", $hash, $user);
// $db->query($query); // using PHPLIB db interface
// 
// [/php]
// [/example]
// [/examples]
// ===== LITERATURE_SOURCES
// * PHP_NET (2023-09-06)
// URL: https://www.php.net/manual/en/function.ezmlm-hash.php
// ========== EZMLM_HASH - END

// SYNTAX:
// int ezmlm_hash(string $addr)

return $return_ezmlm_hash; // int
}
*/
// ============================== END
//    PHP_MAIL_MAIL_EZMLM_HASH    
// ==============================


// ============================== BEGIN
//       PHP_MAIL_MAIL_MAIL       
// ============================== PUBLIC
// ============================== ABOUT
// Send mail.
// ============================== SUPPORT
// PHP_4 - PHP_8
// ============================== USING FUNCTIONS (1)
// mail() - PHP_4, PHP_5, PHP_7, PHP_8
// ============================== CODE
function php_mail_mail_mail($to, $subject, $message, $additional_headers = array(), $additional_params = "")
{
$return_mail = false;

// ========== MAIL - BEGIN
// ===== ABOUT
// Send mail
// ===== DESCRIPTION
// Sends an email.
// ===== SUPPORTED
// PHP_4, PHP_5, PHP_7, PHP_8
// ===== SYNTAX
// mail(
//     string $to,
//     string $subject,
//     string $message,
//     array|string $additional_headers = [],
//     string $additional_params = ""
// ): bool
// ===== CODE
$return_mail = mail(

$to, // string to - Receiver, or receivers of the mail.
// The formatting of this string must comply with > RFC 2822. Some examples are:
// * user@example.com
// * user@example.com, anotheruser@example.com
// * User <user@example.com>
// * User <user@example.com>, Another User <anotheruser@example.com>

$subject, // string subject - Subject of the email to be sent.
// Caution: Subject must satisfy > RFC 2047.

$message, // string message - Message to be sent.
// Each line should be separated with a CRLF (\r\n). Lines should not be larger than 70 characters.
//  Caution:
//  (Windows only) When PHP is talking to a SMTP server directly, if a full stop is found on the start of a line, it is removed. To counter-act this, replace these occurrences with a double dot.
//  [php]
//  $text = str_replace("\n.", "\n..", $text);
//  [/php]

$additional_headers, // array|string additional_headers (optional) - String or array to be inserted at the end of the email header.
// This is typically used to add extra headers (From, Cc, and Bcc). Multiple extra headers should be separated with a CRLF (\r\n). If outside data are used to compose this header, the data should be sanitized so that no unwanted headers could be injected.
// If an array is passed, its keys are the header names and its values are the respective header values.
// Note: Before PHP 5.4.42 and 5.5.27, repectively, additional_headers did not have mail header injection protection. Therefore, users must make sure specified headers are safe and contains headers only. i.e. Never start mail body by putting multiple newlines.
//  Note:
//  When sending mail, the mail must contain a From header. This can be set with the additional_headers parameter, or a default can be set in php.ini.
//  Failing to do this will result in an error message similar to Warning: mail(): "sendmail_from" not set in php.ini or custom "From:" header missing. The From header sets also Return-Path when sending directly via SMTP (Windows only).
// Note: If messages are not received, try using a LF (\n) only. Some Unix mail transfer agents (most notably > qmail) replace LF by CRLF automatically (which leads to doubling CR if CRLF is used). This should be a last resort, as it does not comply with > RFC 2822.

$additional_params // string additional_params (optional) - The additional_params parameter can be used to pass additional flags as command line options to the program configured to be used when sending mail, as defined by the sendmail_path configuration setting. For example, this can be used to set the envelope sender address when using sendmail with the -f sendmail option.
// This parameter is escaped by escapeshellcmd() internally to prevent command execution. escapeshellcmd() prevents command execution, but allows to add additional parameters. For security reasons, it is recommended for the user to sanitize this parameter to avoid adding unwanted parameters to the shell command.
// Since escapeshellcmd() is applied automatically, some characters that are allowed as email addresses by internet RFCs cannot be used. mail() can not allow such characters, so in programs where the use of such characters is required, alternative means of sending emails (such as using a framework or a library) is recommended.
// The user that the webserver runs as should be added as a trusted user to the sendmail configuration to prevent a 'X-Warning' header from being added to the message when the envelope sender (-f) is set using this method. For sendmail users, this file is /etc/mail/trusted-users.

); // Return Values
// Returns true if the mail was successfully accepted for delivery, false otherwise.
// It is important to note that just because the mail was accepted for delivery, it does NOT mean the mail will actually reach the intended destination.
// 
// Changelog
// Version - Description
// 7.2.0   - The additional_headers parameter now also accepts an array.
// 
// [examples]
// Examples
// [example]
// Example #1 Sending mail.
// Using mail() to send a simple email:
// [php]
// // The message
// $message = "Line 1\r\nLine 2\r\nLine 3";
// 
// // In case any of our lines are larger than 70 characters, we should use wordwrap()
// $message = wordwrap($message, 70, "\r\n");
// 
// // Send
// mail('caffeinated@example.com', 'My Subject', $message);
// [/php]
// [/example]
// [example]
// Example #2 Sending mail with extra headers.
// The addition of basic headers, telling the MUA the From and Reply-To addresses:
// [php]
// $to      = 'nobody@example.com';
// $subject = 'the subject';
// $message = 'hello';
// $headers = 'From: webmaster@example.com' . "\r\n" .
//     'Reply-To: webmaster@example.com' . "\r\n" .
//     'X-Mailer: PHP/' . phpversion();
// 
// mail($to, $subject, $message, $headers);
// [/php]
// [/example]
// [example]
// Example #3 Sending mail with extra headers as array
// This example sends the same mail as the example immediately above, but passes the additional headers as array (available as of PHP 7.2.0).
// [php]
// $to      = 'nobody@example.com';
// $subject = 'the subject';
// $message = 'hello';
// $headers = array(
//     'From' => 'webmaster@example.com',
//     'Reply-To' => 'webmaster@example.com',
//     'X-Mailer' => 'PHP/' . phpversion()
// );
// 
// mail($to, $subject, $message, $headers);
// [/php]
// [/example]
// [example]
// Example #4 Sending mail with an additional command line parameter.
// The additional_params parameter can be used to pass an additional parameter to the program configured to use when sending mail using the sendmail_path.
// [php]
// mail('nobody@example.com', 'the subject', 'the message', null,
//    '-fwebmaster@example.com');
// [/php]
// [/example]
// [example]
// Example #5 Sending HTML email
// It is also possible to send HTML email with mail().
// [php]
// // Multiple recipients
// $to = 'johny@example.com, sally@example.com'; // note the comma
// 
// // Subject
// $subject = 'Birthday Reminders for August';
// 
// // Message
// $message = '
// <html>
// <head>
//   <title>Birthday Reminders for August</title>
// </head>
// <body>
//   <p>Here are the birthdays upcoming in August!</p>
//   <table>
//     <tr>
//       <th>Person</th><th>Day</th><th>Month</th><th>Year</th>
//     </tr>
//     <tr>
//       <td>Johny</td><td>10th</td><td>August</td><td>1970</td>
//     </tr>
//     <tr>
//       <td>Sally</td><td>17th</td><td>August</td><td>1973</td>
//     </tr>
//   </table>
// </body>
// </html>
// ';
// 
// // To send HTML mail, the Content-type header must be set
// $headers[] = 'MIME-Version: 1.0';
// $headers[] = 'Content-type: text/html; charset=iso-8859-1';
// 
// // Additional headers
// $headers[] = 'To: Mary <mary@example.com>, Kelly <kelly@example.com>';
// $headers[] = 'From: Birthday Reminder <birthday@example.com>';
// $headers[] = 'Cc: birthdayarchive@example.com';
// $headers[] = 'Bcc: birthdaycheck@example.com';
// 
// // Mail it
// mail($to, $subject, $message, implode("\r\n", $headers));
// [/php]
// Note: If intending to send HTML or otherwise Complex mails, it is recommended to use the PEAR package > PEAR::Mail_Mime.
// [/example]
// [/examples]
// 
// Notes
//  Note:
//  The SMTP implementation (Windows only) of mail() differs in many ways from the sendmail implementation. First, it doesn't use a local binary for composing messages but only operates on direct sockets which means a MTA is needed listening on a network socket (which can either on the localhost or a remote machine).
//  Second, the custom headers like From:, Cc:, Bcc: and Date: are not interpreted by the MTA in the first place, but are parsed by PHP.
//  As such, the to parameter should not be an address in the form of "Something <someone@example.com>". The mail command may not parse this properly while talking with the MTA.
//  Note:
//  It is worth noting that the mail() function is not suitable for larger volumes of email in a loop. This function opens and closes an SMTP socket for each email, which is not very efficient.
//  For the sending of large amounts of email, see the > PEAR::Mail, and > PEAR::Mail_Queue packages.
// Note: The following RFCs may be useful: > RFC 1896, > RFC 2045, > RFC 2046, > RFC 2047, > RFC 2048, > RFC 2049, and > RFC 2822.
// ===== LITERATURE_SOURCES
// * PHP_NET (2023-09-06)
// URL: https://www.php.net/manual/en/function.mail.php
// ========== MAIL - END

// SYNTAX:
// bool mail(string $to, string $subject, string $message, array|string $additional_headers = array(), string $additional_params = "")

return $return_mail; // bool
}
// ============================== END
//       PHP_MAIL_MAIL_MAIL       
// ==============================


// ============================== END
//         PHP_MAIL_MAIL         
// ==============================
?>