https://github.com/sanv92/aws-self-mail-sender

A simple utility for sending an email to yourself using AWS SES, perfect for use in "Contact Us" forms and similar scenarios. This package provides an easy-to-use function to send emails directly to your inbox, ensuring that you don't miss important messages from your users.
https://github.com/sanv92/aws-self-mail-sender

Last synced: 19 days ago
JSON representation

A simple utility for sending an email to yourself using AWS SES, perfect for use in "Contact Us" forms and similar scenarios. This package provides an easy-to-use function to send emails directly to your inbox, ensuring that you don't miss important messages from your users.

• Host: GitHub
• URL: https://github.com/sanv92/aws-self-mail-sender
• Owner: sanv92
• Created: 2024-09-03T16:27:13.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-09-05T21:22:50.000Z (4 months ago)
• Last Synced: 2024-12-22T05:30:34.934Z (19 days ago)
• Language: TypeScript
• Homepage: https://it4you.dev
• Size: 404 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# AWS Self Mail Sender

A simple utility for sending an email to yourself using AWS SES, perfect for use in "Contact Us" forms and similar scenarios. This package provides an easy-to-use function to send emails directly to your inbox, ensuring that you don't miss important messages from your users.

## Features

- Send emails to yourself using AWS SES

- Ideal for "Contact Us" forms or similar use cases

- Easy to integrate into any Node.js project

## Installation

To install the package, use npm:

```bash

npm install aws-self-mail-sender

```

or with yarn:

```bash

yarn add aws-self-mail-sender

```

## Usage

First, you need to configure your AWS credentials to allow the package to send emails using AWS SES. This can be done by setting up environment variables:

```

AWS_REGION=your-aws-region

AWS_ACCESS_KEY_ID=your-access-key-id

AWS_SECRET_ACCESS_KEY=your-secret-access-key

[email protected]

AWS_SES_EMAIL_NAME=Your Name

AWS_SES_SUBJECT=New Contact Us Submission from [Your Website Name]

```

```typescript

import { awsSesSelfMailSender, LanguageValidationRules, ValidationRules, createValidationRegex } from 'aws-self-mail-sender'

const fieldOptions = {

  emailFrom: {

    name: 'Email From',

    required: true,

    validation: true,

    minLength: 1,

    maxLength: 500,

    pattern: /^[a-z0-9._%+-]+@[a-z0-9.-]+\.[a-z]{2,4}$/i,

    errorMessage: 'Please provide a valid email address',

  },

  subject: {

    name: 'Subject',

    required: false,

    validation: true,

    pattern: createValidationRegex(LanguageValidationRules.LatinAlphabetPattern, LanguageValidationRules.EstonianPattern, ValidationRules.SpecialCharacterPattern),

    errorMessage: 'Please provide a valid subject',

  },

}

const emailRequest = {

  emailFrom: '[email protected]',

  subject: 'Contact Us Form Submission',

  message: 'This is a test message from the contact form.',

}

awsSesSelfMailSender(fieldOptions).sendMail(emailRequest)

  .then((response) => {

    console.log('Email sent successfully:', response);

  })

  .catch((error) => {

    console.error('Error sending email:', error);

  })

```

## License

This project is licensed under the MIT License. See the LICENSE file for more details.

## Contributing

Contributions are welcome! Please feel free to submit a Pull Request or open an issue on GitHub if you find a bug or have a suggestion for improvement.