Go to file

Matteo Manzinello 8ebab0b8ee v0.4.0		2019-05-20 18:09:39 +02:00
assets	removed DS_Store	2019-05-14 16:46:53 +02:00
dist	keyboard commands added! g=gmail, o=outlook, spacebarORenter=default, c=copy	2019-05-20 18:05:42 +02:00
src	keyboard commands added! g=gmail, o=outlook, spacebarORenter=default, c=copy	2019-05-20 18:05:42 +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	v0.4.0	2019-05-20 18:09:39 +02:00
babel.config.js	added browserslist in README	2019-05-16 12:10:25 +02:00
gulpfile.js	fix babel	2019-05-15 19:18:12 +02:00
package.json	v0.4.0	2019-05-20 18:09:39 +02:00
yarn.lock	ncu	2019-05-20 12:57:48 +02:00

README.md

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

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.4.0/dist/mailgo.min.js"></script>
</body>

you can also import mailgo in <head> using defer

<head>
...
<script src="https://unpkg.com/mailgo@0.4.4/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 spam-less usage instead the default usage

spam-less 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

spam-less 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

spam-less 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, subject and multiple email addresses

mailgo also supports cc, bcc, subject and body in spam-less 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

mailgo doesn't support multiple email addresses in to, cc and bcc at the moment, but there is an issue for this!

keyboard commands

from mailgo 0.4.0, when a mailgo modal is showing, there are also keyboard commands that can perform different actions

pressing g perform the open in Gmail action
pressing o perform the open in Outlook action
pressing spacebar or enter perform the open default action
pressing c perform the copy action

examples

this is a complete mailgo example with the spam-less 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 spam-less #1 usage):

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

browsers support (WIP)

"browserslist": "> 0.25%, not dead"

see the compatibility of mailgo on browserl.ist

connected projects