{"_id":"@antistatique/postally","_rev":"8-415d7b5cd80d27f5e46bf0107c12428d","name":"@antistatique/postally","dist-tags":{"latest":"0.0.1"},"versions":{"0.0.1":{"name":"@antistatique/postally","version":"0.0.1","author":{"name":"Antistatique"},"license":"MIT","_id":"@antistatique/postally@0.0.1","maintainers":[{"name":"yago","email":"hello@yago.io"}],"homepage":"https://github.com/antistatique/postally#readme","bugs":{"url":"https://github.com/antistatique/postally/issues"},"dist":{"shasum":"967ba852988d0f463f26919aa8012f71dccb33d1","tarball":"https://registry.npmjs.org/@antistatique/postally/-/postally-0.0.1.tgz","integrity":"sha512-nbwD7jJdi3O/ZvLr+OVJPTVKUanbv5sPK3IM/jtRmeliaT0sOMXp9eOzxgCu1BPcXJKAa1tMoe/dJxpK7vT/Xw==","signatures":[{"sig":"MEUCIQCZ0P74HJUfswec4NRqoJcbSgfiJDsHJdpMTiAx2B/vvwIgE63mZVroGpuXglvO+ZkXRMxK1bW9jMM1mn7wWQTOqW0=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}]},"main":"index.js","engines":{"node":">=8.0.0"},"gitHead":"2b02b6dbd0f07f41f302217d68e4eb88801741dc","_npmUser":{"name":"yago","email":"hello@yago.io"},"repository":{"url":"git+https://github.com/antistatique/postally.git","type":"git"},"_npmVersion":"5.5.1","description":"AiO email creator and delivery system","directories":{},"_nodeVersion":"8.9.0","dependencies":{"inky":"^1.3.7","twig":"^1.10.5","dotenv":"^4.0.0","node-sass":"^4.6.0","inline-css":"^2.2.3","@sendgrid/mail":"^6.1.4","foundation-emails":"^2.2.1"},"_npmOperationalInternal":{"tmp":"tmp/postally-0.0.1.tgz_1510067872798_0.2341070813126862","host":"s3://npm-registry-packages"}}},"time":{"created":"2017-11-07T15:17:53.768Z","modified":"2025-08-29T08:47:33.261Z","0.0.1":"2017-11-07T15:17:53.768Z"},"bugs":{"url":"https://github.com/antistatique/postally/issues"},"author":{"name":"Antistatique"},"license":"MIT","homepage":"https://github.com/antistatique/postally#readme","repository":{"url":"git+https://github.com/antistatique/postally.git","type":"git"},"description":"AiO email creator and delivery system","maintainers":[{"email":"dev@antistatique.net","name":"antistatique-dev"},{"email":"yann.lugrin@antistatique.net","name":"yannlugrin"},{"email":"gilles.doge@gmail.com","name":"gido"}],"readme":"# 📯 Postally\n\n> AiO email creator and delivery system\n\n## Prerequisites\n\nYour project need [NodeJS 8+](https://nodejs.org/en/).\n\n**Postally** are using the following libraries to offer an AiO email system :\n- **[Twig.js](https://github.com/twigjs/twig.js)** as the main template engine\n- **[Inky](https://github.com/zurb/inky)** as the Email template engine\n- **[Foundation for Emails](https://github.com/zurb/foundation-emails/)** as HTML/CSS framework\n- **[Sendgrid](https://github.com/sendgrid/sendgrid-nodejs)** to send Email *(free account up to 40k/mo)*\n\nTo **help** your Email creation process, you can take a look at :\n- [Twig documentation](https://twig.symfony.com/doc/2.x/)\n- [Inky templates examples](https://github.com/zurb/foundation-emails/tree/develop/templates)\n- [Available Sass variables](https://github.com/zurb/foundation-emails/blob/develop/scss/_global.scss)\n\n## Usage\n\nThen, you can simply use it this way :\n\n```javascript\nconst postally = require('@antistatique/postally');\n\n// Email (Twig/Inky) markup\nconst markup = `\n  <container>\n    <row>\n      <columns align=\"left\">\n        <h1>Hello {{name}}</h1>\n      </columns>\n    </row>\n  </container>\n`;\n\n// Custom and Foundation Email SASS variables\nconst variables = `\n  $primary-color: #0ECEE1 !default;\n`\n\n// Custom (S)CSS\nconst styles = `\n  body { background: $primary-color; }\n  h1 { font-family: Georgia, serif;}\n`\n\npostally({\n  from: 'from@example.org',\n  to: 'to@example.org',\n  subject: 'Postally is amazing !',\n  data: { name: 'You' },\n  markup,\n  variables,\n  styles,\n  sendgrid_api_key: 'XXXXXXXXXXXXX',\n}).then((status) => { console.log('Success !', status); });\n```","readmeFilename":"README.md"}