import { Email } from '@coolgk/email';
// OR
// const { Email } = require('@coolgk/email');

const email = new Email({host: 'localhost'});

email.send({
    subject: 'hello this is email subject',
    from: {
            name: 'Daniel Gong',
            email: 'daniel.k.gong@example.com'
    },
    to: [
        {
            name: 'Dan Go',
            email: 'dan@example.com'
        },
        'gong@example.com'
    ],
    message: '<html><body><h1>test</h1>some message here <img src="cid:my-image" width="500" height="250"></body></html>',
    attachments: [
        {
            path: '/tmp/test.png',
            name: 'screenshot.png'
        },
        {
            path:"/tmp/test.png",
            headers:{"Content-ID": "<my-image>"}
        }
    ]
}).then((sentMessage) => {
    console.log(sentMessage);
}).catch((error) => {
    console.log(error);
});

Email

Kind: global class
See: https://www.npmjs.com/package/emailjs#emailserverconnectoptions

Email
- new Email(options)
- .send(options, [attachments]) ⇒ promise

new Email(options)

Param	Type	Default	Description
options	`object`
[options.user]	`string`		username for logging into smtp
[options.password]	`string`		password for logging into smtp
[options.host]	`string`	`"'localhost'"`	smtp host
[options.port]	`string`		smtp port (if null a standard port number will be used)
[options.ssl]	`boolean`		boolean (if true or object, ssl connection will be made)
[options.tls]	`boolean`		boolean (if true or object, starttls will be initiated)
[options.domain]	`string`		domain to greet smtp with (defaults to os.hostname)
[options.authentication]	`Array.<string>`		authentication methods

email.send(options, [attachments]) ⇒ `promise`

Kind: instance method of Email
Returns: promise - - message sent

Param	Type	Description
options	`object`
options.subject	`string`	email subject
[options.message]	`string`	html email message
options.to	`Array.<(string\|object)>`	to email address
options.to[].name	`string`	name of the recipient
options.to[].email	`string`	email address of the recipient
[options.from]	`string` \| `object`	see options.to
[options.cc]	`Array.<(string\|object)>`	see options.to
[options.bcc]	`Array.<(string\|object)>`	see options.to
[attachments]	`Array.<object>`	email attachments
attachments.path	`string`	file path
[attachments.name]	`string`	file name
[attachments.type]	`string`	file mime type
[attachments.method]	`string`	method to send attachment as (used by calendar invites)
[attachments.headers]	`object`	attachment headers, header: value pairs, e.g. {"Content-ID":""}

Keywords

FAQs

What is @coolgk/email?

Is @coolgk/email well maintained?

Package last updated on 21 Feb 2018

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

@coolgk/email

@coolgk/email

Examples

Email

new Email(options)

email.send(options, [attachments]) ⇒ promise

Keywords

Related posts

Input Validation Vulnerabilities Dominate MITRE's 2024 CWE Top 25 List

Risky Business Podcast: Why Open Source Software Needs Better Malware Tracking

email.send(options, [attachments]) ⇒ `promise`