Amazon SES
This library allows you to interact with the AWS SES Service
Prerequisites
Installation
npm i @winglibs/ses
Usage
bring ses;
let emailService = new ses.EmailService(emailIdentities: ["bot@wing.cloud"]);
License
This library is licensed under the MIT License.
API Reference
Table of Contents
- Classes
- Interfaces
- Structs
EmailService_tfaws (preflight class)
No description
Constructor
new(props: EmailServiceProps): EmailService_tfaws
Properties
No properties
Methods
| Signature | Description |
|---|---|
inflight sendEmail(options: SendEmailOptions): str? | No description |
inflight sendRawEmail(options: SendRawEmailOptions): str? | No description |
EmailService_sim (preflight class)
No description
Constructor
new(props: EmailServiceProps): EmailService_sim
Properties
No properties
Methods
| Signature | Description |
|---|---|
inflight sendEmail(options: SendEmailOptions): str? | No description |
inflight sendRawEmail(options: SendRawEmailOptions): str? | No description |
EmailService (preflight class)
EmailService can used for defining and interacting with AWS SES. When running the simulator in a non test environment, it will use the actual cloud implementation.
Constructor
new(props: EmailServiceProps): EmailService
Properties
No properties
Methods
| Signature | Description |
|---|---|
inflight sendEmail(options: SendEmailOptions): str? | No description |
inflight sendRawEmail(options: SendRawEmailOptions): str? | No description |
IEmailService (interface)
No description
Properties
No properties
Methods
| Signature | Description |
|---|---|
inflight sendEmail(options: SendEmailOptions): str? | No description |
inflight sendRawEmail(options: SendRawEmailOptions): str? | No description |
Body (struct)
No description
Properties
| Name | Type | Description |
|---|---|---|
Html | Content? | No description |
Text | Content? | No description |
CloudWatchDestination (struct)
No description
Properties
| Name | Type | Description |
|---|---|---|
defaultValue | str | No description |
dimensionName | str | No description |
valueSource | str | No description |
ConfigurationSet (struct)
No description
Properties
| Name | Type | Description |
|---|---|---|
name | str | No description |
Content (struct)
No description
Properties
| Name | Type | Description |
|---|---|---|
Data | str? | No description |
Destination (struct)
No description
Properties
| Name | Type | Description |
|---|---|---|
BccAddresses | | No description |
CcAddresses | | No description |
ToAddresses | | No description |
EmailServiceProps (struct)
No description
Properties
| Name | Type | Description |
|---|---|---|
configurationSet | ConfigurationSet? | No description |
emailIdentities | | No description |
eventDestination | EventDestination? | No description |
EventDestination (struct)
No description
Properties
| Name | Type | Description |
|---|---|---|
cloudwatchDestination | CloudWatchDestination? | No description |
matchingTypes | | No description |
name | str | No description |
Message (struct)
No description
Properties
| Name | Type | Description |
|---|---|---|
Body | Body? | No description |
Subject | Content? | No description |
RawMessage (struct)
No description
Properties
| Name | Type | Description |
|---|---|---|
Data | str | No description |
SendEmailOptions (struct)
No description
Properties
| Name | Type | Description |
|---|---|---|
Destination | Destination? | No description |
Message | Message? | No description |
Source | str | No description |
SendRawEmailOptions (struct)
No description
Properties
| Name | Type | Description |
|---|---|---|
Destinations | | No description |
RawMessage | RawMessage | No description |
Source | str? | No description |