{"id":26241232,"url":"https://github.com/repetere/periodicjs.core.mailer","last_synced_at":"2026-04-21T08:03:06.653Z","repository":{"id":19822970,"uuid":"23083839","full_name":"repetere/periodicjs.core.mailer","owner":"repetere","description":"nodemailer transport loader","archived":false,"fork":false,"pushed_at":"2019-12-02T21:27:08.000Z","size":528,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":7,"default_branch":"master","last_synced_at":"2026-01-14T03:46:48.742Z","etag":null,"topics":["async","cms","javascript","mailer","mailgun","nodejs","nodemailer","sendmail","ses","smtp"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/repetere.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-08-18T19:35:09.000Z","updated_at":"2020-05-24T16:43:10.000Z","dependencies_parsed_at":"2022-08-25T21:41:50.162Z","dependency_job_id":null,"html_url":"https://github.com/repetere/periodicjs.core.mailer","commit_stats":null,"previous_names":["typesettin/periodicjs.core.mailer"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/repetere/periodicjs.core.mailer","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/repetere%2Fperiodicjs.core.mailer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/repetere%2Fperiodicjs.core.mailer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/repetere%2Fperiodicjs.core.mailer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/repetere%2Fperiodicjs.core.mailer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/repetere","download_url":"https://codeload.github.com/repetere/periodicjs.core.mailer/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/repetere%2Fperiodicjs.core.mailer/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32082780,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-21T06:27:27.065Z","status":"ssl_error","status_checked_at":"2026-04-21T06:27:21.250Z","response_time":128,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["async","cms","javascript","mailer","mailgun","nodejs","nodemailer","sendmail","ses","smtp"],"created_at":"2025-03-13T08:19:54.075Z","updated_at":"2026-04-21T08:03:06.617Z","avatar_url":"https://github.com/repetere.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# periodicjs.core.mailer [![Coverage Status](https://coveralls.io/repos/github/typesettin/periodicjs.core.mailer/badge.svg?branch=master)](https://coveralls.io/github/typesettin/periodicjs.core.mailer?branch=master) [![Build Status](https://travis-ci.org/typesettin/periodicjs.core.mailer.svg?branch=master)](https://travis-ci.org/typesettin/periodicjs.core.mailer)\n\nPeriodic's Code mailer module exports a single function that asynchronously returns a node mailer transport to send transactional emails with.\n\n [API Documentation](https://github.com/typesettin/periodicjs.core.mailer/blob/master/doc/api.md)\n\n## Installation\n\n```\n$ npm install periodicjs.core.mailer\n```\n\nThis is a part of Periodic's core.\n\n## Usage\n\n### Sending Emails\n*JavaScript*\n```javascript\nvar CoreMailer = require('periodicjs.core.mailer'),\n  sampleemail ={\n    to: \"user@example.com\",\n    cc: \"service@example.com\",\n    subject: \"sample email test\",\n    generateTextFromHTML: true,\n    html: \"\u003ch1\u003eWelcome User\u003c/h1\u003e\u003cp\u003eemail rocks\u003c/p\u003e\"\n  },\n  emailtransport;\n\n  //instance methods\n  const newCoreMailer = new CoreMailer({ \n    config: { \n      transportConfig: {\n        type: 'stub',\n        transportoptions: {\n          debug: true,\n          args: ['-t', '-i']\n        },\n      },\n    },\n  });\n  newCoreMailer.sendEmail(sampleemail)\n  .then(console.log)\n  .catch(console.error);\n  //static methods\n  CoreMailer.sendEmail(sampleemail)\n  .then(console.log)\n  .catch(console.error);\n\n//example transports\nconst sendmailTransportExample = {\n  \"type\":\"sendmail\",\n  \"transportoptions\":{\n    \"debug\":true,\n    \"args\":[\"-t\",\"-i\"]\n  }\n};\nconst SMTPTransportExample = {\n  \"type\":\"SMTP\",\n  \"transportoptions\":{\n    \"service\": \"SendGrid\",\n    \"auth\": {\n      \"user\": \"username\",\n      \"pass\": \"password\"\n    }\n  }\n};\nconst SESTransportExample = {\n  \"type\":\"ses\",\n  \"transportoptions\":{\n    \"accessKeyId\": \"ACCESSKEYID\",\n    \"secretAccessKey\": \"SECRETACCESSKEY\"\n  }\n};\n//all types:\nconst transports = {\n  ses,\n  sendmail: sendmailTransport,\n  'smtp-pool': smtpPool,\n  sendgrid: sgTransport,\n  mailgun: mgTransport,\n  stub: stubTransport,\n  direct: directTransport,\n}\n```\n\n\n\n## API\n\n```javascript\n//options.emailtemplatefilepath\nCoreMailer.getEmailTemplateHTMLString(options); //Promise.resolve(templateString);\n//options.transportObject.transportType, options.transportObject.transportOptions\nCoreMailer.getTransport(options); //Promise.resolve(nodemailertransport); \n//options.to, options.from, options.html, options.subject, etc\nCoreMailer.sendEmail(options); //Promise.resolve(emailstatus);\n```\n## Development\n*Make sure you have grunt installed*\n```\n$ npm install -g grunt-cli\n```\n\nFor tests\n```\n$ grunt test \u0026\u0026 grunt coveralls\n```\nFor generating documentation\n```\n$ grunt doc\n$ jsdoc2md lib/**/*.js \u003e doc/api.md\n```\n\n## Notes\n* Check out https://github.com/typesettin/periodicjs for the full Periodic Documentation","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frepetere%2Fperiodicjs.core.mailer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frepetere%2Fperiodicjs.core.mailer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frepetere%2Fperiodicjs.core.mailer/lists"}