npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@hedhog/mail

v0.7.6

Published

<p align="center"> <img src="https://avatars.githubusercontent.com/u/177489127?s=200&v=4" alt="Hedhog Avatar" /> </p>

Downloads

1,195

Readme

hedhog/mail

HedHog Mail is an email sending library that is part of the HedHog framework. This library provides support for sending emails using various email services such as AWS SES, Gmail, and SMTP. It is configured to handle multiple types of email sending, including emails with attachments and multi-part content.

Features

  • Send Emails via AWS SES: Send emails using Amazon Simple Email Service.
  • Send Emails via Gmail: Send emails using the Gmail API.
  • Send Emails via SMTP: Send emails through an SMTP server.
  • Create Emails with Attachments: Support for emails with multiple attachments and formatted content.

Installation

This library is an integral part of the HedHog framework and should be installed as a dependency in your HedHog project. Ensure that the necessary dependencies are configured in your HedHog project.

npm i @hedhog/mail

Usage

The MailService is the main class responsible for sending emails. Here is a basic example of how to use the email service:

Configuration and Sending Emails

import { MailService } from '@hedhog/mail';
import { Mail } from '@hedhog/mail/interfaces/mail.interface';

// Assuming you have properly configured MailService in your module

const mailService = new MailService(/* configuration options */);

const mail: Mail = {
  from: '[email protected]',
  to: '[email protected]',
  subject: 'Test Email',
  body: '<h1>Hello World!</h1>',
  attachments: [
    {
      filename: 'attachment.txt',
      content: Buffer.from('Hello, this is an attachment!'),
      contentType: 'text/plain',
    },
  ],
};

mailService
  .send(mail)
  .then((response) => {
    console.log('Email sent successfully:', response);
  })
  .catch((error) => {
    console.error('Error sending email:', error);
  });

Available Methods

  • send(mail: Mail): Sends an email based on the specified configuration (AWS, GMAIL, or SMTP).
  • createRawEmail(mail: Mail): Creates a raw representation of the email for sending.

Folder Structure

mail/
├── dist/                        # Compiled JavaScript file from build
├── node_modules/                # Discardable folder with all module dependencies
├── src/
│   ├── mail.service.ts           # Email sending service
│   ├── mail.module.ts            # Module for MailService
│   └── mail.consts.ts            # Constants related to email sending
│   ├── mail.service.spec.ts      # Unit tests for MailService
│   └── mail.template.ejs         # Email templates in EJS format
│   ├── index.ts                  # Entry point for mail file
│   ├── interfaces/
│   │   └── mail-module-options.interface.ts # Interface for configuration options
│   ├── enums/
│   │   └── mail-configuration-type.enum.ts # Enum for email configuration types
├── .gitignore                     # Specifies which file Git should ignore
├── package.json                   # Manages dependencies and scripts for the library
├── package-lock.json              # Lock file for dependencies
├── README.md                      # Documentation for the library
└── tsconfig.lib.json              # TypeScript configuration for the library
└── tsconfig.production.json       # TypeScript configuration for production builds