3 Commits

Author SHA1 Message Date
sHa
9d302c9540 gump validator add to composer require 2018-02-12 11:48:02 +02:00
sHa
91d1e47a05 usage manual 2018-02-12 11:37:15 +02:00
sHa
6656909deb non project files 2018-02-12 09:39:41 +02:00
4 changed files with 112 additions and 22 deletions

View File

@@ -1 +1,83 @@
# sLetter
e-mail send library
## install
`composer require shadoll/sletter`
## usage
```
require __DIR__.'/../vendor/autoload.php';
$letter = (new shadoll\sLetter);
```
set mail variables:
```
$letter->set([
'sender' => 'mailgun', // sender - support mail or mailgun-service
'logoUri' => "https://site.com/logo.png", // link to logo that showing in letter
'fromMail' => "site@site.com", // sender email
'fromName' => "SiteLetter", // sender name
'toMail' => "info@site.com", // resipient email
'senderIP' => $_SERVER['REMOTE_ADDR'],
'mailgun_apikey' => 'key',
'mailgun_domain' => 'mg.site.com',
]);
```
adding fields titles:
```
$letter->setLang([
'order' => 'Замовлення',
'message' => 'Повідомлення',
'comment' => 'Повідомлення',
'date' => 'Дата',
'time' => 'Час',
'type' => 'Тип',
'doors' => 'Кількість дверцят',
'width' => 'Ширина',
'depth' => 'Глибина',
]);
```
set fields from form:
```
$letter->setData([
'name' => !empty($_REQUEST['name'])?($_REQUEST['name']):'',
'phone' => !empty($_REQUEST['phone'])?($_REQUEST['phone']):'',
'email' => !empty($_REQUEST['email'])?($_REQUEST['email']):'',
'message' => !empty($_REQUEST['message'])?($_REQUEST['message']):'',
]);
```
fields list to validate before send (not working now):
```
$letter
->validate([
'name',
'phone',
'email',
])
```
sending email
```
$letter
->detect()
->send()
->state();
```
detect - get sender info from his IP
send - if no error send email
state - action result (not fully working now)

View File

@@ -1,22 +1,22 @@
{
"name": "shadoll/sletter",
"description": "shadoll sLetter - e-mail send library",
"version": "18.2.13",
"prefer-stable": true,
"require": {
"php": "^7.0",
"mailgun/mailgun-php": "^2.4"
},
"authors": [
{
"name": "sHa",
"email": "sha@shadoll.com"
}
],
"autoload": {
"psr-4": {
"shadoll\\": "/lib"
}
},
"minimum-stability": "dev"
"name": "shadoll/sletter",
"description": "shadoll sLetter - e-mail send library",
"prefer-stable": true,
"require": {
"php": "^7.0",
"mailgun/mailgun-php": "^2.4",
"wixel/gump": "dev-master"
},
"authors": [
{
"name": "sHa",
"email": "sha@shadoll.com"
}
],
"autoload": {
"psr-4": {
"shadoll\\": "/lib"
}
},
"minimum-stability": "dev"
}

View File

@@ -2,8 +2,8 @@
/**
*
* @author sHa <sha@shadoll.com>
* @package shadoll/sLetter
* @version 18.2.12
* @package sLetter
* @version 18.2.13
*
*/

8
sLetter.code-workspace Normal file
View File

@@ -0,0 +1,8 @@
{
"folders": [
{
"path": "."
}
],
"settings": {}
}