Skip to content

Commit 8b66b38

Browse files
committed
Fix broken Markdown headings
1 parent 6fd516b commit 8b66b38

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#Mailin [![Build Status](https://travis-ci.org/Flolagale/mailin.svg?branch=master)](https://travis-ci.org/Flolagale/mailin)
1+
# Mailin [![Build Status](https://travis-ci.org/Flolagale/mailin.svg?branch=master)](https://travis-ci.org/Flolagale/mailin)
22

33
__Artisanal inbound emails for every web app__
44
<img align="right" src="postman.jpg"/>
@@ -15,9 +15,9 @@ Why? Because we needed it for our startup [jokund.com](http://jokund.com).
1515
### Show me a demo!
1616
Sure! A demo is live at [mailin.io](http://mailin.io). Please note that it is running on the smallest Digital Ocean instance, so be fair if it is overloaded.
1717

18-
###Initial setup
18+
### Initial setup
1919

20-
####Dependencies
20+
#### Dependencies
2121

2222
Mailin can run without any dependencies other than node itself, but having them allow you to use some additional features.
2323

@@ -34,14 +34,14 @@ sudo aptitude install spamassassin spamc
3434
```
3535
Spamassassin is not enabled by default, enable it in ```/etc/default/spamassassin```.
3636

37-
####Node versions
37+
#### Node versions
3838

3939
The latest version of Mailin (^3.0.0) runs on node ~0.12.0 or iojs ^2.0.0. If you are running an older version of node such as ~0.10.0, you can install Mailin ^2.0.0:
4040
```
4141
npm install [email protected]
4242
```
4343

44-
####The crux: setting up your DNS correctly
44+
#### The crux: setting up your DNS correctly
4545

4646
In order to receive emails, your smtp server address should be made available somewhere. Two records should be added to your DNS records. Let us pretend that we want to receive emails at ```*@subdomain.domain.com```:
4747
* First an MX record: ```subdomain.domain.com MX 10 mxsubdomain.domain.com```. This means that the mail server for addresses like ```*@subdomain.domain.com``` will be ```mxsubdomain.domain.com```.
@@ -50,8 +50,8 @@ In order to receive emails, your smtp server address should be made available so
5050
You can fire up Mailin (see next section) and use an [smtp server tester](http://mxtoolbox.com/diagnostic.aspx) to verify that everything is correct.
5151

5252

53-
###Using Mailin
54-
####From the command line
53+
### Using Mailin
54+
#### From the command line
5555

5656
Install mailin globally.
5757

@@ -74,7 +74,7 @@ and make sure that your user can write to the log file.
7474

7575
At this point, Mailin will listen for incoming emails, parse them and post an urlencoded form ```multipart/form-data``` to your webhook url.
7676

77-
#####Webhook format
77+
##### Webhook format
7878
The webhook payload is a multipart form with a ```mailinMsg``` fields always present and some optional additional fields containing the content of the attachments. How to handle this? We have got you covered, there is a working example using node and express in [mailin/samples/server.js](https://github.com/Flolagale/mailin/blob/master/samples/server.js). Anyway, once parsed, you should end up with something like:
7979
```
8080
{
@@ -129,14 +129,14 @@ The webhook payload is a multipart form with a ```mailinMsg``` fields always pre
129129
}
130130
```
131131

132-
#####Gotchas
132+
##### Gotchas
133133
* ```error: listen EACCES```: your user do not have sufficients privileges to run on the given port. Ports under 1000 are restricted to root user. Try with [sudo](http://xkcd.com/149/).
134134
* ```error: listen EADDRINUSE```: the current port is already used by something. Most likely, you are trying to use port 25 and your machine's [mail transport agent](http://en.wikipedia.org/wiki/Message_transfer_agent) is already running. Stop it with something like ```sudo service exim4 stop``` or ```sudo service postfix stop``` before using Mailin.
135135
* ```error: Unable to compute spam score ECONNREFUSED```: it is likely that spamassassin is not enabled on your machine, check the ```/etc/default/spamassassin``` file.
136136
* ```node: command not found```: most likely, your system does not have node installed or it is installed with a different name. For instance on Debian/Ubuntu, the node interpreter is called nodejs. The quick fix is making a symlink: ```ln -s $(which nodejs) /usr/bin/node``` to make the node command available.
137137
* ```Uncaught SenderError: Mail from command failed - 450 4.1.8 <[email protected]>: Sender address rejected: Domain not found```: The smtpOption `disableDNSValidation` is set to `false` and an email was sent from an invalid domain.
138138

139-
####Embedded inside a node application
139+
#### Embedded inside a node application
140140

141141
Install Mailin locally.
142142

0 commit comments

Comments
 (0)