README.md in truemail-0.1.6 vs README.md in truemail-0.1.7
- old
+ new
@@ -1,10 +1,10 @@
# Truemail
[](https://codeclimate.com/github/rubygarage/truemail/maintainability) [](https://codeclimate.com/github/rubygarage/truemail/test_coverage) [](https://badge.fury.io/rb/truemail) [](https://circleci.com/gh/rubygarage/truemail/tree/master) [](CODE_OF_CONDUCT.md)
-The Truemail gem helps you validate emails by regex pattern, presence of domain mx-records, and real existence of email account on a current email server.
+The Truemail gem helps you validate emails by regex pattern, presence of domain mx-records, and real existence of email account on a current email server. Also Truemail gem allows performing an audit of the host in which runs.
## Features
- Configurable validator, validate only what you need
- Zero runtime dependencies
@@ -135,11 +135,11 @@
### Validation features
#### Regex validation
-Validation with regex pattern is the first validation level. By default this validation not performs strictly following RFC 5322 standart, so you can override Truemail default regex pattern if you want.
+Validation with regex pattern is the first validation level. By default this validation not performs strictly following RFC 5322 standard, so you can override Truemail default regex pattern if you want.
Example of usage:
1. With default regex pattern
@@ -379,9 +379,33 @@
@string="250 127.0.1.1 Hello example.com\n">,
mailfrom=#<Net::SMTP::Response:0x0000000002d5a618 @status="250", @string="250 OK\n">,
rcptto=false,
errors={:rcptto=>"550 User not found\n"}>>]>,
@validation_type=:smtp>
+```
+
+### Host audit features
+
+Truemail gem allows performing an audit of the host in which runs. Only PTR record audit performs for today.
+
+#### PTR audit
+
+So what is a PTR record? A PTR record, or pointer record, enables someone to perform a reverse DNS lookup. This allows them to determine your domain name based on your IP address. Because generic domain names without a PTR are often associated with spammers, incoming mail servers identify email from hosts without PTR records as spam and you can't verify yours emails qualitatively.
+
+```ruby
+Truemail.host_audit
+# Everything is good
+=> #<Truemail::Auditor:0x00005580df358828
+ @result=
+ #<struct Truemail::Auditor::Result
+ warnings={}>>
+
+# Has PTR warning
+=> #<Truemail::Auditor:0x00005580df358828
+ @result=
+ #<struct Truemail::Auditor::Result
+ warnings=
+ {:ptr=>"ptr record does not reference to current verifier domain"}>>
```
### Truemail helpers
#### .valid?