sv-mail
v1.0.1
Published
npm package to send mail
Downloads
2
Readme
First of all, I want to thank you all for choosing sv-mail. sv-mail
is a versatile and efficient Node.js module designed to streamline the process of sending emails with various content types and attachments. Whether you need to send simple text emails, HTML emails, or emails with multiple attachments, sv-mail
offers a seamless solution for all your emailing needs.
You can reach me at [email protected]
Features
- Simple text email support
- HTML email support
- Attachment support
- Easy configuration with nodemailer
Install
npm install sv-mail
Demo
Example : Open Link
Quick Start
Configure the email details and user credentials as shown in the examples above to start sending emails effortlessly. For any queries or support, feel free to reach out. If it seems confusing 😰😰, don't worry, it's simple.
Configuration
Below are all the available options you can pass to the component. Options without defaults are required. We will add more customization soon.!🚀🚀🚀
Configuration
Below are all the available options you can pass to the email functions. Options without defaults are required.
| Name | Type | Default | Description |
|--------------|--------|---------|-----------------------------------------------------------------------------|
| To | string | null | Recipient email address |
| subject | string | null | Subject of the email |
| text | string | null | Text content of the email |
| html | string | null | HTML content of the email |
| attachments | array | null | Array of attachments, each object containing filename
, path
, contentType
|
| UserData | object | null | User credentials and details, containing Name
, Email
, APP_PASS
|
Attachments Object
Each attachment object within the attachments
array should have the following properties:
| Property | Type | Description | |--------------|--------|--------------------------------------------------| | filename | string | Name of the attachment file | | path | string | Path to the attachment file | | contentType | string | MIME type of the attachment file |
UserData Object
The UserData
object should contain the following properties:
| Property | Type | Description | |----------|--------|---------------------------------| | Name | string | Sender's name | | Email | string | Sender's email address | | APP_PASS | string | Sender's email application password |
For more information, visit the sv-mail package.
Made with ❤