@coolgk/email
Advanced tools
a javascript / typescript module
npm install @coolgk/email
a email sender wrapper class
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);
});
Kind: global class
See: https://www.npmjs.com/package/emailjs#emailserverconnectoptions
| 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 |
promiseKind: 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":""} |
FAQs
a email sender wrapper class
We found that @coolgk/email demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
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.
Research
Security News
Socket’s threat research team has detected six malicious npm packages typosquatting popular libraries to insert SSH backdoors.
Security News
MITRE's 2024 CWE Top 25 highlights critical software vulnerabilities like XSS, SQL Injection, and CSRF, reflecting shifts due to a refined ranking methodology.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.