Download the PHP package toropyga/fmail without Composer
On this page you can find all versions of the php package toropyga/fmail. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download toropyga/fmail
More information about toropyga/fmail
Files in toropyga/fmail
Package fmail
Short Description Library for working with post servers from Toropyga
License MIT
Informations about the package fmail
Fmail
PHP Mail sender script
Описание и примеры использования PHP класса отправки и получения почты FMail
Содержание
- Общие понятия
- Возможности класса FMail
- Описание работы
- Пример использования
Общие понятия
Класс FMail предназначен для отправки и получения электронных почтовых сообщений средствами PHP. Данный класс не является полноценной почтовой программой для работы с электронной почтой! Для работы необходимо наличие PHP версии 4 и выше.
Возможности класса FMail
Позволяет отправлять письма используя стандартную функцию PHP mail(), а также не используя данную функции напрямую подключаться к указанному почтовому серверу через сокет.
Позволяет получать письма используя библиотеку PHP IMAP
Поддерживает авторизацию на почтовых серверах методом PLAIN и LOGIN.
Поддерживаются текстовые кодировки (charset) ISO-8859-1, UTF-8, WINDOWS-1251 и KOI8-R.
Поддерживаются отправка сообщений в текстовом и HTML формате.
Отправка письма нескольким получателям.
Поддержка ограничения на количество получателей одного письма, т.е. если задано несколько получателей и стоит ограничение на количество получателей - 1, то каждому получателю будет создано и отправлено своё письмо.
Поддержка отправки писем скрытым получателям, имя и адрес получателя не отображается в поле "Кому" (To).
Позволяет прикрепить к письму файлы любого формата.
Создание сообщения из любого HTML файла с подгрузкой картинок, стилевых таблиц и скриптов.
Поддерживается кодирование текста из кодировки Windows-1251 в кодировку UTF-8 и обратно, не требуя наличия модуля iconv.
Проверка электронного адреса на правильность написания.
Протоколирование всех действий.
Описание работы
Основные функции отправки сообщений
Подключение файла класса
или с использованием composer
Инициализация класса
Внимание!!! В классе есть значения используемые по умолчанию. Изменение всех параметров по умолчанию можно произвести в блоке переменных "Переменные настройки скрипта (класса)". Или через специальные функции класса которые будут описаны ниже.
По умолчанию скрипт использует функцию PHP mail(). Для подключения через сокет указываем:
При подключении через сокет по умолчанию используется в качестве сервера localhost, для изменения пользуемся функцией:
При подключении через сокет по умолчанию используется 25 порт, для изменения пользуемся функцией:
При подключении через сокет по умолчанию используется 10 секундное ожидание ответа сокета, для изменения пользуемся функцией:
При подключении через сокет по умолчанию не требуется авторизация пользователя на сервере, для изменения пользуемся функцией:
Для авторизации необходимо указать логин и пароль пользователя. Пользуемся функциями:
По умолчанию стоит ограничение на количество одновременных получателей письма - 1 (один). Для изменения пользуемся функцией:
По умолчанию используется кодировка текста UTF-8. Для изменения пользуемся функцией:
Указание получателей письма. (Подробнее - смотри описание функции)
Очистить список получателей, так как функция setTo накопительная
Указание, если надо, скрытых получателей письма. (Подробнее - смотри описание функции)
Очистить скрытых список получателей, так как функция setBcc накопительная
Указание отправителя письма. (Подробнее - смотри описание функции)
или
Указание темы сообщения
Задание текста письма.
Для задания текста письма можно использовать 4 различных функции. При создании письма необходимо выбрать одну, так как каждая функция не добавляет к ранее заданному тексту письма новый текст, а заменяет старый новым!!!
-
Создание простого текстового сообщения (text/plain)
- Создание текстового сообщения в формате HTML
или
-
Создание простого текстового сообщения (text/plain) из HTML файла
- Создание сообщения из HTML файла (возвращает true или false)
Добавление файлов к письму (возвращает true или false)
Очистить список файлов, так как функция setFile накопительная
Отправка письма (возвращает true или false)
Основные функции получения сообщений
Подключение файла класса
Инициализация класса
При подключении по умолчанию используется в качестве сервера localhost, для изменения пользуемся функцией:
При подключении IMAP по умолчанию используется 143 порт, для изменения пользуемся функцией:
По умолчанию используется подключение по протоколу IMAP, можно использовать, но не рекомендуется, протокол POP3. Для изменения пользуемся функцией:
Настройка флагов подключения для функции imap_open
Для авторизации необходимо указать логин и пароль пользователя. Пользуемся функциями:
Считываем список папок.
Задание папки для чтения её содержимого
Возвращаем список писем в папке Все параметры необязательные. Указаваем имя папки, номер сообщения с которого начинаем чтение папки и количество сообщений для возврата (см. описание функции)
Возврат списка писем в почтовом ящике по заданным параметрам
Чтение письма по номеру письма
Чтение письма по UID
Дополнительные функции
Проверка правильности написания адреса электронной почты (возвращает true или false)
Конвертация текста из кодировки Windows-1251 в кодировку UTF-8
Конвертация текста из кодировки UTF-8 в кодировку Windows-1251
Включение отладочных функций скрипта (при ошибке выводит сообщение на экран)
Просмотр логов класса. Передаём параметры необходимых логов. 0 - все логи, 1 - отработавшие функции, 2 - переданные и полученные данные, 3 - ошибки
Декодирование строк вида =?utf-8?B?0KHQv9GA0LDQstC+0YfQvdC40Log0JHQmNCa?=
Пример использования
All versions of fmail with dependencies
toropyga/base Version >=1.0.3
ext-imap Version *
ext-fileinfo Version *
ext-iconv Version *
ext-mbstring Version *