update tsconfig
This commit is contained in:
parent
d94117a606
commit
75e3aa33e6
@ -5,17 +5,28 @@
|
||||
"githost": "code.foss.global",
|
||||
"gitscope": "push.rocks",
|
||||
"gitrepo": "smartsmtp",
|
||||
"description": "a module for handling smtp stuff",
|
||||
"description": "A module for handling SMTP operations such as sending emails via SMTP or sendmail transport.",
|
||||
"npmPackagename": "@push.rocks/smartsmtp",
|
||||
"license": "MIT",
|
||||
"projectDomain": "push.rocks"
|
||||
"projectDomain": "push.rocks",
|
||||
"keywords": [
|
||||
"SMTP",
|
||||
"email",
|
||||
"nodemailer",
|
||||
"sendmail",
|
||||
"smartmail integration",
|
||||
"TypeScript",
|
||||
"email sending",
|
||||
"email templates",
|
||||
"programming"
|
||||
]
|
||||
}
|
||||
},
|
||||
"npmci": {
|
||||
"npmGlobalTools": [],
|
||||
"npmAccessLevel": "public"
|
||||
},
|
||||
"tsdocs": {
|
||||
"tsdoc": {
|
||||
"legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
|
||||
}
|
||||
}
|
||||
13
package.json
13
package.json
@ -2,7 +2,7 @@
|
||||
"name": "@push.rocks/smartsmtp",
|
||||
"version": "3.0.3",
|
||||
"private": false,
|
||||
"description": "a module for handling smtp stuff",
|
||||
"description": "A module for handling SMTP operations such as sending emails via SMTP or sendmail transport.",
|
||||
"main": "dist_ts/index.js",
|
||||
"typings": "dist_ts/index.d.ts",
|
||||
"type": "module",
|
||||
@ -39,5 +39,16 @@
|
||||
"cli.js",
|
||||
"npmextra.json",
|
||||
"readme.md"
|
||||
],
|
||||
"keywords": [
|
||||
"SMTP",
|
||||
"email",
|
||||
"nodemailer",
|
||||
"sendmail",
|
||||
"smartmail integration",
|
||||
"TypeScript",
|
||||
"email sending",
|
||||
"email templates",
|
||||
"programming"
|
||||
]
|
||||
}
|
||||
1
readme.hints.md
Normal file
1
readme.hints.md
Normal file
@ -0,0 +1 @@
|
||||
|
||||
122
readme.md
122
readme.md
@ -1,39 +1,107 @@
|
||||
# @pushrocks/smartsmtp
|
||||
# @push.rocks/smartsmtp
|
||||
a module for handling smtp stuff
|
||||
|
||||
## Availabililty and Links
|
||||
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartsmtp)
|
||||
* [gitlab.com (source)](https://gitlab.com/pushrocks/smartsmtp)
|
||||
* [github.com (source mirror)](https://github.com/pushrocks/smartsmtp)
|
||||
* [docs (typedoc)](https://pushrocks.gitlab.io/smartsmtp/)
|
||||
## Install
|
||||
|
||||
## Status for master
|
||||
To install `@push.rocks/smartsmtp`, use the following command with npm:
|
||||
|
||||
Status Category | Status Badge
|
||||
-- | --
|
||||
GitLab Pipelines | [](https://lossless.cloud)
|
||||
GitLab Pipline Test Coverage | [](https://lossless.cloud)
|
||||
npm | [](https://lossless.cloud)
|
||||
Snyk | [](https://lossless.cloud)
|
||||
TypeScript Support | [](https://lossless.cloud)
|
||||
node Support | [](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||
Code Style | [](https://lossless.cloud)
|
||||
PackagePhobia (total standalone install weight) | [](https://lossless.cloud)
|
||||
PackagePhobia (package size on registry) | [](https://lossless.cloud)
|
||||
BundlePhobia (total size when bundled) | [](https://lossless.cloud)
|
||||
Platform support | [](https://lossless.cloud) [](https://lossless.cloud)
|
||||
```bash
|
||||
npm install @push.rocks/smartsmtp --save
|
||||
```
|
||||
|
||||
Ensure that you are installing the package in a project set up with TypeScript and support for ECMAScript modules, as the usage examples provided will rely on this configuration.
|
||||
|
||||
## Usage
|
||||
|
||||
Use TypeScript for best in class intellisense
|
||||
`@push.rocks/smartsmtp` simplifies handling SMTP-based emailing in Node.js applications, offering a streamlined interface to create transporters and send emails using popular services like Nodemailer and enhancements for template-based emails via `@pushrocks/smartmail`. This guide walks you through setting up a `Smartsmtp` instance and sending emails.
|
||||
|
||||
## Contribution
|
||||
### Setting Up
|
||||
|
||||
We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
|
||||
First, ensure you import the necessary classes from the module. Here's how you set up your imports using ESM syntax:
|
||||
|
||||
For further information read the linked docs at the top of this readme.
|
||||
```typescript
|
||||
import { Smartsmtp } from '@push.rocks/smartsmtp';
|
||||
```
|
||||
|
||||
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
||||
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|
||||
### Creating SMTP Transport
|
||||
|
||||
[](https://maintainedby.lossless.com)
|
||||
`@push.rocks/smartsmtp` provides two primary ways to set up an SMTP transporter: through direct SMTP server credentials or utilizing the local `sendmail` command.
|
||||
|
||||
#### SMTP Server Credentials
|
||||
|
||||
To connect to an SMTP server directly, you'll need the server address, username, and password. Here's how you can create a `Smartsmtp` instance using SMTP server credentials:
|
||||
|
||||
```typescript
|
||||
// Define your SMTP configuration
|
||||
const smtpOptions = {
|
||||
smtpServer: 'smtp.example.com',
|
||||
smtpUser: 'user@example.com',
|
||||
smtpPassword: 'yourPassword'
|
||||
};
|
||||
|
||||
// Async function to create and use a Smartsmtp instance
|
||||
async function setupSmtp() {
|
||||
const smtpInstance = await Smartsmtp.createSmartsmtpWithRelay(smtpOptions);
|
||||
|
||||
// smtpInstance is now ready to use
|
||||
}
|
||||
```
|
||||
|
||||
#### Using Sendmail
|
||||
|
||||
If you wish to use the local `sendmail` command, which is common in UNIX environments, you can create a `Smartsmtp` instance dedicated to that:
|
||||
|
||||
```typescript
|
||||
async function setupSendmail() {
|
||||
const sendmailInstance = await Smartsmtp.createSmartsmtpSendmail();
|
||||
|
||||
// sendmailInstance is now ready to use for sending emails
|
||||
}
|
||||
```
|
||||
|
||||
### Sending Emails
|
||||
|
||||
With a `Smartsmtp` instance ready, you can send emails. This requires creating a `Smartmail` instance (from the `@pushrocks/smartmail` package) that defines the email configuration, including subjects, recipients, and body content.
|
||||
|
||||
```typescript
|
||||
import { Smartmail } from '@pushrocks/smartmail';
|
||||
|
||||
async function sendEmail(smtpInstance: Smartsmtp) {
|
||||
// Create a Smartmail instance
|
||||
const myEmail = new Smartmail({
|
||||
from: 'me@example.com',
|
||||
subject: 'Test Email',
|
||||
body: 'This is a test email sent using @push.rocks/smartsmtp.'
|
||||
});
|
||||
|
||||
// Use the smtpInstance to send the email
|
||||
const result = await smtpInstance.sendSmartMail(myEmail, 'recipient@example.com');
|
||||
|
||||
console.log(result); // Check the result
|
||||
}
|
||||
```
|
||||
|
||||
In the example above, `Smartmail` is utilized to define the base content of the email being sent. The `sendSmartMail` method of `Smartsmtp` takes this email configuration, alongside recipient details, and performs the sending operation.
|
||||
|
||||
This completes the basic usage guide for `@push.rocks/smartsmtp`. With these steps, you can integrate straightforward SMTP email sending capabilities into your Node.js applications, leveraging modern TypeScript syntax and ESM modules. For further customization and advanced features, refer to the documentation of Nodemailer and `@pushrocks/smartmail`.
|
||||
|
||||
|
||||
|
||||
## License and Legal Information
|
||||
|
||||
This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository.
|
||||
|
||||
**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
|
||||
|
||||
### Trademarks
|
||||
|
||||
This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.
|
||||
|
||||
### Company Information
|
||||
|
||||
Task Venture Capital GmbH
|
||||
Registered at District court Bremen HRB 35230 HB, Germany
|
||||
|
||||
For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
|
||||
|
||||
By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user