https://github.com/ert78gb/aws-ses-localstack-test

Test util for AWS Simple Email Service testion via Localstack
https://github.com/ert78gb/aws-ses-localstack-test

Last synced: about 1 month ago
JSON representation

Test util for AWS Simple Email Service testion via Localstack

• Host: GitHub
• URL: https://github.com/ert78gb/aws-ses-localstack-test
• Owner: ert78gb
• Created: 2023-01-11T15:44:39.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2024-04-08T10:31:53.000Z (9 months ago)
• Last Synced: 2024-04-14T07:26:55.439Z (9 months ago)
• Language: JavaScript
• Size: 16.6 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
AWS SES Localstack test util

============================

This package provides the following methods to help with integration or e2e tests

- `getEmails` returns with all emails from the localstack mounted volumes

- `deleteEmails` deletes all emails from the localstack mounted volumes

## How to use

- mount the `/var/lib/localstack` directory from the docker image to a local folder.

  Mount the `/var/lib/localstack` directory, because if only the `/var/lib/localstack/tmp/state/ses` has been mounted then the docker image will not start

```javascript

import {deleteEmails, getEmails } from '@ert78gb/aws-ses-localstack-test'

const localstackMounted = 'path/to/the/locally/mounted/folder/'

await deleteEmails({directory: localstackMounted})

// send email

const sentEmails = getEmails({directory: localstackMounted})

```

Sent email structure. Uses the original property names as localstack generates the json files

```typescript

interface LocalstackEmail {

  Id: string;

  Region: string;

  Destination: {

    BccAddresses?: string[];

    CcAddresses?: string[];

    ToAddresses?: string[];

  },

  Source: string;

  Subject: string;

  Body: {

    text_part: string;

    html_part: string;

  },

  Timestamp: Date;

}

```