Skip to content

A versatile Node.js library for seamless email handling, supporting operations such as sending, receiving, and parsing emails with robust IMAP and SMTP integration.

License

Notifications You must be signed in to change notification settings

Samyca/mailflow

Repository files navigation

@samyca/mailflow

A comprehensive tool for handling email flows in Node.js applications, providing functionalities for sending, receiving, and parsing emails with ease.

GitHub Actions Workflow Status GitHub top language NPM Downloads GitHub License

Features

  • Send emails using SMTP protocol.
  • Fetch and parse emails from IMAP servers.
  • Extract data from emails using CSS queries.
  • Easy integration with Node.js applications.

Installation

Install using npm:

npm install @samyca/mailflow

Or using yarn:

yarn add @samyca/mailflow

Usage

Creating an Account

import { createAccount, createRandomAccount } from '@samyca/mailflow';

async function setupOtherAccount() {
  const account = await createRandomAccount();

  console.log(account);
}

async function setupAccount() {
  const account = await createAccount({
    smtpHost: 'smtp.example.com',
    smtpPort: 587,
    smtpSecure: true,
    imapHost: 'imap.example.com',
    imapPort: 993,
    imapSecure: true,
    username: 'your_username',
    password: 'your_password',
  });

  console.log(account);
}

setupOtherAccount().then();
setupAccount().then();

Fetching and Parsing Emails

import { createAccount } from '@samyca/mailflow';

async function getDataByCssQuery() {
  const account = await createAccount({
    imapHost: 'imap.example.com',
    imapPort: 993,
    imapSecure: true,
    username: 'your_username',
    password: 'your_password',
  });

  const lastEmail = await account.getLastMail({});
  const data = lastEmail.getData('div.code');

  console.log(data);
}
getDataByCssQuery().then();

About

A versatile Node.js library for seamless email handling, supporting operations such as sending, receiving, and parsing emails with robust IMAP and SMTP integration.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published