Go to file

Matteo Manzinello 2301092cd0 added babel		2019-05-14 16:02:04 +02:00
assets	new assets + README	2019-05-11 00:49:43 +02:00
dist	gulp	2019-05-13 12:43:46 +02:00
src	add keydown only when the modal is showing, remove it when now showing	2019-05-13 12:43:37 +02:00
.gitignore	aggiornato gitignore	2019-05-05 22:18:53 +02:00
.npmignore	added .DS_Store in npmignore	2019-05-13 11:46:48 +02:00
README.md	updated README	2019-05-14 10:41:11 +02:00
gulpfile.js	MAILGO_VERSION dynamically managed by gulp	2019-05-09 14:52:24 +02:00
package.json	added babel	2019-05-14 16:02:04 +02:00
yarn.lock	added babel	2019-05-14 16:02:04 +02:00

README.md

💌 mailgo, a different mailto: more possibilities, less spam (WIP)

(see it in action! https://mailgo.js.org)

docs: npm

what?

mailgo will substitute all the mailto: links with the mailgo modal

installation

add at the end of the <body>

<body>
...
<script src="https://unpkg.com/mailgo@0.3.0/dist/mailgo.min.js"></script>
</body>

you can also import mailgo in <head> using defer

<head>
...
<script src="https://unpkg.com/mailgo@0.3.0/dist/mailgo.min.js" defer></script>
</head>

(note: the GitHub /dist folder is totally unstable, use unpkg to test mailgo, thanks!)

usage

by default all the mailto: links will be enabled with mailgo automatically and will appear also cc, bcc, subject and body parameter, if provided

(to exclude a single mailto link add to the <a> element the class no-mailgo)

do you want to prevent the spam? Use a no-spam usage instead the default usage

no-spam usage #1 (recommended)

<a href="#mailgo" data-address="matteo" data-domain="manzinello.dev">write me!</a>

add href="#mailgo" to <a>
add data-address and data-domain to re-create your email address

no-spam usage #2

<a class="mailgo" data-address="matteo" data-domain="manzinello.dev">write me!</a>

add class="mailgo" to <a>
add data-address and data-domain to re-create your email address

no-spam usage #3

<a mailgo data-address="matteo" data-domain="manzinello.dev">write me!</a>

add the attribute mailgo to <a>
add data-address and data-domain to re-create your email address

cc, bcc, body and subject

mailgo also supports cc, bcc, subject and body in no-spam installation using the parameters:

data-cc-address and data-cc-domain to recreate cc: data-cc-address@data-cc-domain
data-bcc-address and data-bcc-domain to recreate bcc: data-bcc-address@data-bcc-domain
data-subject for the subject of the email
data-body for the body of the email

for the default installation you can use the classic mailto parameters and they will appear in the modal

examples

this is a complete mailgo example with the no-spam usage #1 (and cc, bcc, subject and body):

<a href="#mailgo" data-address="matteo" data-domain="manzinello.dev" data-cc-address="matteomanzinello" data-cc-domain="gmail.com" data-bcc-address="hello" data-bcc-domain="matteomanzinello.com" data-subject="A strange email" data-body="This email is for me with me also in cc and in bcc">write me!</a>

This is a more simple example (also with no-spam #1 usage):

<a href="#mailgo" data-address="matteo" data-domain="manzinello.dev">write me!</a>

browsers support

// WIP

https://mailgo.js.org