Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/initphp/mailer
This is a simple and fast library for sending mail with PHP.
https://github.com/initphp/mailer
mailer php-mail php-mailer php-mailer-smtp
Last synced: 26 days ago
JSON representation
This is a simple and fast library for sending mail with PHP.
- Host: GitHub
- URL: https://github.com/initphp/mailer
- Owner: InitPHP
- License: mit
- Created: 2022-03-15T09:43:10.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-07-20T04:26:29.000Z (over 1 year ago)
- Last Synced: 2024-11-18T09:43:03.174Z (about 1 month ago)
- Topics: mailer, php-mail, php-mailer, php-mailer-smtp
- Language: PHP
- Homepage:
- Size: 15.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Mailer
This is a simple library for sending mail with SMTP consisting of a single class.
[](https://packagist.org/packages/initphp/mailer) [](https://packagist.org/packages/initphp/mailer) [](https://packagist.org/packages/initphp/mailer) [](https://packagist.org/packages/initphp/mailer) [](https://packagist.org/packages/initphp/mailer)
## Instalation
```
composer require initphp/mailer
```
## Requirements
- PHP 7.4 or higher
- MBString Extension
- Iconv Extension
- FileInfo Extension
## Usage
```php
$config = [
'mailType' => 'text' // or 'html'
'protocol' => 'smtp' // or 'mail' or 'sendmail'
'SMTPAuth' => true,
'SMTPHost' => 'smtp.gmail.com',
'SMTPUser' => '[email protected]',
'SMTPPass' => 'YourMailPassword',
'SMTPPort' => 587
];
$mailer = \InitPHP\Mailer\Mailer::newInstance($config);
$mailer->setFrom('[email protected]', 'Muhammet Şafak');
//$mailer->setTo('[email protected]');
//$mailer->setCC('[email protected]');
//$mailer->setBCC('[email protected]');
$mailer->setSubject('Mail Subject');
$mailer->setMessage('Mail Body Message');
$mailer->send();
```
## Methods
#### `newInstance()`
Creates a new mailer object and returns it.
```php
public static function newInstance(?array $config = null): \InitPHP\Mailer\Mailer
```
### `clear()`
```php
public function clear(bool $clearAttachments = false): self
```
### `setHeader()`
```php
public function setHeader(string $header, string $value): self
```
### `setFrom()`
```php
public function setFrom(string $from, string $name = '', ?string $returnPath = null): self
```
### `setReplyTo()`
```php
public function setReplyTo(string $replyTo, string $name = ''): self
```
### `setTo()`
```php
public function setTo(string|array $to): self
```
### `setCC()`
```php
public function setCC(string $cc): self
```
### `setBCC()`
```php
public function setBCC(string $bcc, ?int $limit = null): self
```
### `setSubject()`
```php
public function setSubject(string $subject): self
```
### `setMessage()`
```php
public function setMessage(string $body): self
```
### `setAttachmentCID()`
```php
public function setAttachmentCID(string $fileName): false|string
```
### `setAltMessage()`
```php
public function setAltMessage(string $str): self
```
### `setMailType()`
```php
public function setMailType(string $type = 'text'): self
```
- `$type` : `text` or `html`
### `setWordWrap()`
```php
public function setWordWrap(bool $wordWrap = true): self
```
### `setProtocol()`
```php
public function setProtocol(string $protocol = 'mail'): self
```
- `$protocol` : `mail`, `sendmail` or `smtp`
### `setPriority()`
```php
public function setPriority(int $n = 3): self
```
- `$n` : An integer between 1 and 5 inclusive.
### `setNewline()`
```php
public function setNewline(string $newLine = \PHP_EOL): self
```
### `setCRLF()`
```php
public function setCRLF(string $CRLF = \PHP_EOL): self
```
### `attach()`
```php
public function attach(string|resource $file, string $disposition = '', ?string $newName = null, ?string $mime = null): false|self
```
### `send()`
```php
public function send(bool $autoClear = true): bool
```
### `printDebugger()`
```php
public function printDebugger(array $include = ['headers', 'subject', 'body']): string
```
## Getting Help
If you have questions, concerns, bug reports, etc, please file an issue in this repository's Issue Tracker.
## Getting Involved
> All contributions to this project will be published under the MIT License. By submitting a pull request or filing a bug, issue, or feature request, you are agreeing to comply with this waiver of copyright interest.
There are two primary ways to help:
- Using the issue tracker, and
- Changing the code-base.
### Using the issue tracker
Use the issue tracker to suggest feature requests, report bugs, and ask questions. This is also a great way to connect with the developers of the project as well as others who are interested in this solution.
Use the issue tracker to find ways to contribute. Find a bug or a feature, mention in the issue that you will take on that effort, then follow the Changing the code-base guidance below.
### Changing the code-base
Generally speaking, you should fork this repository, make changes in your own fork, and then submit a pull request. All new code should have associated unit tests that validate implemented features and the presence or lack of defects. Additionally, the code should follow any stylistic and architectural guidelines prescribed by the project. In the absence of such guidelines, mimic the styles and patterns in the existing code-base.
## Credits
- [Muhammet ŞAFAK](https://www.muhammetsafak.com.tr) <>
## License
Copyright © 2022 [MIT License](./LICENSE)