Skip to content

Commit

Permalink
Mail-tester.com Documentation (#377)
Browse files Browse the repository at this point in the history
* Added page for mailtester and added to index.rst file

* Added title for mailtester page

* Just testing my SSH key.

* Made a start on instructions for use of mailtester

* added first image to mailtester docs

* Made a start to 'results' section

* Added content to mail-tester page

* Fixed a couple of formatting issues (text on same line as some images)

* re-added missing rdns.png

* added meta

* correcting metadata

* changed linked path: ["What factors affect DNS propagation
time?"](/Domains/domains/dnspropagation.html) to (/Domains/domains/dnspropagation.md)

* changed link path /DOmains/ssl/types.html to /types.nd

* added metadata for ttl.md

* changed reference /Domains/safedns/addnewdomain.html to .md

* Update IP addresses in getting started pages for ddosx (#376)

IP Ranges were missing in the nginx and and apache section

* enforce recommonmark version (#383)

Workaround for bug readthedocs/recommonmark#130

* New docs page for Windows Update Install options (#379)

* Added Windows Update Options

Added a page explaining how to change Windows Update installation options

* Edited name of Windows Update page

Changed name from "Changing Windows Updates Schedules" to "Changing Windows Updates Installation Options"

* Fixing Formatting

Fixing formatting on the "Changing Windows Updates Installation Options" page

* Formatting again

Fixing Formatting on "Changing Windows Updates Installation Options"

* Formatting

Formatting on Windows Updates installation options

* Added new folder for Windows tips

Added a new folder for Windows tips, and added a first tip page

* Fixing file link

Fixing image link in TLS Powershell docs page

* Fixing image

Fixing image again

* Changing file name

Changing image name to remove number

* Moved files folder into Powershell

Moved files folder into Powershell

* Changing filepath to image

* Added eval meta info to TLS page

* Added index.rst file

* Changed apostrophes for backticks for proper code highlighting

* Editing backtick spacing

* Removed tips, keeping as just a powershell folder

* Removed reference to old Tips folder from index.rst

* Added reference to TLS in Powershell article to index.rst

* Added eval_rst to Powershell index.rst file 

As per https://github.com/ukfast/docs.ukfast.co.uk

* Typos

* Added powershell/index

* Updated file names to be lowercase for type

* Reverted html -> md changes
  • Loading branch information
jehmemez authored and laf committed May 1, 2019
1 parent a6ea83f commit f68bd9b
Show file tree
Hide file tree
Showing 7 changed files with 71 additions and 0 deletions.
7 changes: 7 additions & 0 deletions source/Domains/safedns/ttl.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,10 @@ Select `Product and Services` > `SafeDNS` > select your domain name > Under the
Please remember this value is in seconds and that the lowest value is `300` seconds.

Also note that there are a number of different factors that can affect the total propagation time of DNS record changes. Please see ["What factors affect DNS propagation time?"](/Domains/domains/dnspropagation.html) for more information.

```eval_rst
.. meta::
:title: Changing TTL (Time To Live) | UKFast Documentation
:description: Guidance on changing and understanding your TTL values.
:keywords: dns, safedns, ukfast, hosting, domains, ttl, propagation
```
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions source/operatingsystems/linux/mail/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,4 @@ Email is a complex and deep subject, but these guides should help cover the basi
postfix
dkim
spf
mailtester
63 changes: 63 additions & 0 deletions source/operatingsystems/linux/mail/mailtester.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
# Testing Mail

Guidance on how to use `mail-tester.com` and understanding the results.

## **Purpose**
Mail-tester is used to test the 'quality' of emails - taking into consideration:
* Your message's content
* Your mailserver's configuration
* The IP address your mail is being sent from

## **How to use it**
Firstly, go to https://www.mail-tester.com in your browser. You should see something similar to:
![Mailtester_1](files/Mailtester1.png)

As instructed by the webpage, send the email you wish to test from the desired address (for example, sending a company newsletter from the appropriate address).

**You should avoid generic phrases such as** 'this is a test' **as it will likely be flagged as spam**.

Once you have sent the email, click the 'then check your score' button to proceed.

## **The results**
If no other tests were recently sent to the same address as your email, you will automatically be taken to the message sent (as below). From this, you can scroll down to see the full report.

![Mailtester_2](files/Mailtester2.png)

If your test results aren't displayed automatically, a list will appear for you to select from. This includes the subject line, spam rating, and how long ago the email was submitted.

### **Explanation of Results**
![Mailtester_3](files/Mailtester3.png)

### View of message
'Click here to view your message' simply displays your email's content in basic HTML & plain text view. The 'source' section within this gives more detailed information on the mail servers sending and receiving your mail (including their IP addresses, and what protocol was used to encrypt the email's content).

### SpamAssassin
[SpamAssassin](https://spamassassin.apache.org/) is a spam-filtering program, which uses various techniques to determine whether or not your mail will be flagged as spam. IN the example below, SpamAssassin found no issues as the records it
checks were valid, such as SPF.

SPF (Sender Policy Framework) records allow the recipient to check that your mail is authentic. The SPF record defines which mail servers are allowed to send from your domain (such as @ukfast.co.uk).

If any checks were unsuccessful, this will likely decrease the overall rating given by mail-tester. For example, SpamAssassin shows that this message is not signed with DKIM (this serves the same purpose as SPF by different means). While the lack of DKIM deducts 1/10 from the overall score, it isn;t entirely necessary as most spam filters won't consider its absence to be a huge concern.

![Mailtester_4](files/Mailtester4.png)

### Email Formatting

The fourth section evaluates how well formatted your email is. This includes:

* What percentage of your message is text - a lack of special characters and punctuation may suggest an email looks more like spam.

* Whether it includes images - image-based emails make it more difficult for spam filters to determine whether or not the content is malicious.

* Malicious code - including potentially dangerous elemnts such as javascript may be seen as a security risk and cause an email to be marked as spam. Using shortened URLs will also decrease the overall score, as they may be used to conceal the actual destination.

* Whether an 'unsubscribe' button is present - for marketing and mass emails, a method of unsubscribing must be provided by law (to comply with GDPR).

### Broken Links
The last section of mail-tester checks whether your mesage contains any links, and if they're broken. Links are considered to be broken when opening one gives an error code and doesn't load the content originally intended to be found there.

```eval_rst
.. meta::
:title: Using mail-tester.com | UKFast Documentation
:description: A guide to using mail-tester and understanding the results
:keywords: ukfast, mail, email, guide, tutorial, mail-tester, mailtester,

0 comments on commit f68bd9b

Please sign in to comment.