PHPackages                             toropyga/fmail - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. toropyga/fmail

ActiveLibrary[Utility & Helpers](/categories/utility)

toropyga/fmail
==============

Library for working with post servers from Toropyga

v7.0.1(2w ago)0304MITPHPPHP >=5.1.0

Since Aug 10Pushed 2w ago1 watchersCompare

[ Source](https://github.com/Toropyga/FMail)[ Packagist](https://packagist.org/packages/toropyga/fmail)[ RSS](/packages/toropyga-fmail/feed)WikiDiscussions master Synced today

READMEChangelogDependencies (2)Versions (10)Used By (0)

Fmail
=====

[](#fmail)

PHP Mail sender script

[![License](https://camo.githubusercontent.com/074b89bca64d3edc93a1db6c7e3b1636b874540ba91d66367c0e5e354c56d0ea/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d627269676874677265656e2e737667)](https://camo.githubusercontent.com/074b89bca64d3edc93a1db6c7e3b1636b874540ba91d66367c0e5e354c56d0ea/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d627269676874677265656e2e737667)[![Version](https://camo.githubusercontent.com/8cd4b0b295b118d89ea50c0423b24c6e7861984003a7c83e65296b41014f014f/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f76657273696f6e2d76372e302e312d626c75652e737667)](https://camo.githubusercontent.com/8cd4b0b295b118d89ea50c0423b24c6e7861984003a7c83e65296b41014f014f/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f76657273696f6e2d76372e302e312d626c75652e737667)[![PHP](https://camo.githubusercontent.com/f85e9a1e19d96dd19978f3b621237a876e188c358f8ed0908fea7d51eda1a225/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f7068702d76352e355f2d2d5f76382d626c756576696f6c65742e737667)](https://camo.githubusercontent.com/f85e9a1e19d96dd19978f3b621237a876e188c358f8ed0908fea7d51eda1a225/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f7068702d76352e355f2d2d5f76382d626c756576696f6c65742e737667)

Description and usage examples for the FMail PHP class for sending and receiving mail.

Table of Contents
=================

[](#table-of-contents)

- [Overview](#overview)
- [Features of the FMail class](#features-of-the-fmail-class)
- [How it works](#how-it-works)
- [Usage example](#usage-example)

Overview
========

[](#overview)

The FMail class is designed for sending and receiving email messages using PHP. This class is not a full-featured email client! It requires PHP version 4 or higher.

Features of the FMail class
===========================

[](#features-of-the-fmail-class)

Allows sending mail using the standard PHP `mail()` function, or, without using that function directly, connecting to a specified mail server via a socket.

Allows receiving mail using the PHP IMAP library.

Supports authorization on mail servers using the PLAIN and LOGIN methods.

Supports the ISO-8859-1, UTF-8, WINDOWS-1251, and KOI8-R text encodings (charsets).

Supports sending messages in both plain text and HTML format.

Sending a message to multiple recipients.

Supports limiting the number of recipients per message — i.e., if several recipients are specified and the recipient limit is set to 1, a separate message will be created and sent to each recipient individually.

Supports sending messages to hidden recipients, whose name and address are not shown in the "To" field.

Allows attaching files of any format to a message.

Creating a message from any HTML file, including loading images, stylesheets, and scripts.

Supports converting text from Windows-1251 encoding to UTF-8 and back, without requiring the iconv module.

Email address format validation.

Logging of all actions.

How it works
============

[](#how-it-works)

**Core message-sending functions**

Include the class file

```
require_once("FMail.php");
```

or using Composer

```
require_once("vendor/autoload.php");
```

Initialize the class

```
$ml = new Toropyga\FMail();
```

Warning!!! The class has default values. All default parameters can be changed in the "Script (class) settings variables" block, or via the special class functions described below.

By default, the script uses the PHP `mail()` function. To connect via a socket instead, specify:

```
$ml->setMailUse(false);
```

When connecting via a socket, the default server is `localhost`. To change it, use:

```
$ml->setServer('your_mailserver.com'); // you can specify an IP address or a domain name
```

When connecting via a socket, the default port is 25. To change it, use:

```
$ml->setPort(2525); // specifies the port number
```

When connecting via a socket, the default socket response timeout is 10 seconds. To change it, use:

```
$ml->setTimeout(30); // specify the time in seconds
```

When connecting via a socket, user authorization on the server is not required by default. To change this, use:

```
$ml->setAuth('PLAIN'); // specify the authorization method: LOGIN or PLAIN
```

For authorization, you must specify the user's login and password. Use the functions:

```
$ml->setLogin('login'); // specify the user's login
$ml->setPassword('password'); // specify the user's password
```

By default, the limit on the number of simultaneous message recipients is 1 (one). To change it, use:

```
$ml->setMaxRecipient(2); // number of simultaneous message recipients
```

By default, UTF-8 text encoding is used. To change it, use:

```
$ml->setCharset('WIN'); // specify the encoding code
                        // (WIN=>windows-1251, UTF=>utf-8, ISO=>iso-8859-1, KOI=>koi8-r)
```

Specifying message recipients. (For more details, see the function description)

```
$ml->setTo('test1@mail.com');
$ml->setTo('test2@mail.com', 'Ivan Ivanov');
$ml->setTo('test3@mail.com', $ml->getWin2Utf('Vasya Pupkin'));
$ml->setTo(array(array('mail'=>'test4@mail.com', 'username'=>'Ivan Ivanov')));
```

Clear the list of recipients, since the `setTo` function is cumulative

```
$ml->clearTo();
```

Specifying hidden recipients (BCC) of the message, if needed. (For more details, see the function description)

```
$ml->setBcc('bcc1@mail.com');
$ml->setBcc('bcc2@mail.com', 'Ivan Ivanov');
$ml->setBcc('bcc3@mail.com', $ml->getUtf2Win('Vasya Pupkin'));
$ml->setBcc(array(array('mail'=>'bcc4@mail.com', 'username'=>'Ivan Ivanov')));
```

Clear the list of hidden recipients, since the `setBcc` function is cumulative

```
$ml->clearBcc();
```

Specifying the message sender. (For more details, see the function description)

```
$ml->setFrom('this@server.com');
```

or

```
$ml->setFrom('this@server.com', 'Sender Name');
```

Specifying the message subject

```
$ml->setSubject('Message subject');
```

Setting the message body.

There are 4 different functions available for setting the message body. When creating a message, choose only one, since each function does not append new text to the previously set message body — it replaces the old text with the new one!!!

1. Creating a plain text message (text/plain)

```
$ml->setMessage("Message text here!");
```

2. Creating a text message in HTML format

```
$ml->setHTMLMessage("Message text here");
```

or

```
$ml->setHTMLMessage("Hereis themessage text!!!");
```

3. Creating a plain text message (text/plain) from an HTML file

```
$ml->setMessageFromHTML("file.html"); // specify the path to the HTML file
```

4. Creating a message from an HTML file (returns true or false)

```
$ml->setHTMLfile("file.html"); // specify the path to the HTML file
```

Adding files to the message (returns true or false)

```
$ml->setFile("file1.txt"); // specify the path to the file
$ml->setFile("file2.gif");
$ml->setFile("file3.zip");
```

Clear the list of files, since the `setFile` function is cumulative

```
$ml->clearFiles();
```

Sending the message (returns true or false)

```
$ml->send();
```

**Core message-receiving functions**

Include the class file

```
require_once("FMail.php");
```

Initialize the class

```
$ml = new Toropyga/FMail();
```

By default, the connection uses `localhost` as the server. To change it, use:

```
$ml->setServer('your_mailserver.com'); // you can specify an IP address or a domain name
```

When connecting via IMAP, the default port is 143. To change it, use:

```
$ml->setImapPort(993); // specifies the port number
```

The IMAP protocol is used by default for connections. POP3 can be used, but it is not recommended. To change this, use:

```
$ml->setImapType('pop3');
```

Setting connection flags for the `imap_open` function

```
$ml->setImapFlags('/ssl/debug/user=Administrator', true);
```

For authorization, you must specify the user's login and password. Use the functions:

```
$ml->setLogin('login'); // specify the user's login
$ml->setPassword('password'); // specify the user's password
```

Read the list of folders.

```
$folders = $ml->getImapFolders();
```

Setting the folder to read its contents

```
$ml->setImapFolder('INBOX/Work');
```

Returns the list of messages in a folder. All parameters are optional. Specify the folder name, the message number to start reading from, and the number of messages to return (see the function description)

```
$ml->read_folder('INBOX', 124, 10);
```

Returns the list of messages in the mailbox based on the specified parameters

```
$mails = $ml->receive('UNSEEN'); // see the function description for the list of parameters
```

Reading a message by message number

```
$ml->read_mail(124);
```

Reading a message by UID

```
$ml->read_mail_UID(24);
```

**Additional functions**

Validating the format of an email address (returns true or false)

```
$ml->getCheck('test@mail.com');
```

Converting text from Windows-1251 encoding to UTF-8

```
$text = $ml->getWin2Utf($text); // pass the text to be converted
```

Converting text from UTF-8 encoding to Windows-1251

```
$text = $ml->getUtf2Win($text); // pass the text to be converted
```

Enabling the script's debug functions (displays an error message on screen if one occurs)

```
$ml->setDebug(true);
```

Viewing the class logs. Pass the parameters for the logs you need. 0 - all logs, 1 - executed functions, 2 - data sent and received, 3 - errors

```
$logs = $ml->getLogs(3); // when debug functions are enabled, displays the logs on screen
```

Decoding strings of the form =?utf-8?B?0KHQv9GA0LDQstC+0YfQvdC40Log0JHQmNCa?=

```
$text = $ml->getSubjectDecode($text);
```

Usage example
=============

[](#usage-example)

```
require_once("FMail.php");
$ml = new Toropyga\FMail();
$ml->setMailUse(false);
$ml->setServer('your_mail_server.com');
$ml->setAuth('LOGIN');
$ml->setLogin('login');
$ml->setPassword('password');
$ml->setMaxRecipient(2);
$ml->setCharset('UTF');
$ml->setTo('test1@mail.com');
$ml->setTo('test2@mail.com', 'Ivan Ivanov');
$ml->setBcc('bcc1@mail.com');
$ml->setFrom('this@server.com', $ml->getWin2Utf('Sender Name'));
$ml->setSubject('Message subject');
$ml->setHTMLMessage("Message text here");
$ml->setFile("file1.txt");
$ml->setFile("file2.gif");
$ml->setFile("file3.zip");
if (!$ml->send()) {
    $ml->setDebug(true);
    $ml->getLogs();
}
else echo "Mail sending - OK";
```

###  Health Score

45

—

FairBetter than 91% of packages

Maintenance96

Actively maintained with recent releases

Popularity14

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity53

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~227 days

Recently: every ~291 days

Total

9

Last Release

19d ago

Major Versions

v6.0.6 → v7.0.02026-07-29

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/57900903?v=4)[Toropyga](/maintainers/Toropyga)[@Toropyga](https://github.com/Toropyga)

---

Top Contributors

[![Toropyga](https://avatars.githubusercontent.com/u/57900903?v=4)](https://github.com/Toropyga "Toropyga (13 commits)")

### Embed Badge

![Health badge](/badges/toropyga-fmail/health.svg)

```
[![Health](https://phpackages.com/badges/toropyga-fmail/health.svg)](https://phpackages.com/packages/toropyga-fmail)
```

###  Alternatives

[magepal/magento2-customeraccountlinksmanager

Customer Account Links Manager for Magento2 allows you to quickly and easily remove unwanted links from customer account dashboard

4391.0k](/packages/magepal-magento2-customeraccountlinksmanager)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)