Skip to content

Commit 28d3755

Browse files
authored
feat: email winglib (#321)
1 parent cfbf8d2 commit 28d3755

21 files changed

+2449
-0
lines changed

.gitattributes

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.github/workflows/canary.yaml

Lines changed: 33 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.github/workflows/email-pull.yaml

Lines changed: 35 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.github/workflows/email-release.yaml

Lines changed: 60 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.github/workflows/pull-request-lint.yaml

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.mergify.yml

Lines changed: 6 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.mkrepo/gitattributes.w

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ pub class GitAttributes {
88
lines.push("/.github/workflows/*-pull.yaml linguist-generated");
99
lines.push("/.github/workflows/*-release.yaml linguist-generated");
1010
lines.push("/.github/workflows/canary.yaml linguist-generated");
11+
lines.push("/.github/workflows/pull-request-lint.yaml linguist-generated");
1112
lines.push("/**/package-lock.json linguist-generated");
1213
lines.push("/**/*.extern.d.ts linguist-generated");
1314
lines.push("/package-lock.json linguist-generated");

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ publishing them for you.
1919
| [cognito](./cognito) | [@winglibs/cognito](https://www.npmjs.com/package/@winglibs/cognito) | sim, tf-aws |
2020
| [containers](./containers) | [@winglibs/containers](https://www.npmjs.com/package/@winglibs/containers) | sim, tf-aws |
2121
| [dynamodb](./dynamodb) | [@winglibs/dynamodb](https://www.npmjs.com/package/@winglibs/dynamodb) | sim, tf-aws |
22+
| [email](./email) | [@winglibs/email](https://www.npmjs.com/package/@winglibs/email) | sim, tf-aws |
2223
| [eventbridge](./eventbridge) | [@winglibs/eventbridge](https://www.npmjs.com/package/@winglibs/eventbridge) | awscdk, sim, tf-aws |
2324
| [fifoqueue](./fifoqueue) | [@winglibs/fifoqueue](https://www.npmjs.com/package/@winglibs/fifoqueue) | sim, tf-aws |
2425
| [github](./github) | [@winglibs/github](https://www.npmjs.com/package/@winglibs/github) | * |

email/.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
target/
2+
node_modules/

email/API.md

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
## API Reference
2+
3+
### Table of Contents
4+
5+
- **Classes**
6+
- <a href="#@winglibs/email.Email">Email</a>
7+
- **Interfaces**
8+
- <a href="#@winglibs/email.IEmail">IEmail</a>
9+
- **Structs**
10+
- <a href="#@winglibs/email.EmailProps">EmailProps</a>
11+
- <a href="#@winglibs/email.SendEmailOptions">SendEmailOptions</a>
12+
13+
### Email (preflight class) <a class="wing-docs-anchor" id="@winglibs/email.Email"></a>
14+
15+
*No description*
16+
17+
#### Constructor
18+
19+
```
20+
new(props: EmailProps): Email
21+
```
22+
23+
#### Properties
24+
25+
*No properties*
26+
27+
#### Methods
28+
29+
| **Signature** | **Description** |
30+
| --- | --- |
31+
| <code>inflight send(options: SendEmailOptions): void</code> | *No description* |
32+
33+
### IEmail (interface) <a class="wing-docs-anchor" id="@winglibs/email.IEmail"></a>
34+
35+
*No description*
36+
37+
#### Properties
38+
39+
*No properties*
40+
41+
#### Methods
42+
43+
| **Signature** | **Description** |
44+
| --- | --- |
45+
| <code>inflight send(options: SendEmailOptions): void</code> | Sends a simple email. |
46+
47+
### EmailProps (struct) <a class="wing-docs-anchor" id="@winglibs/email.EmailProps"></a>
48+
49+
*No description*
50+
51+
#### Properties
52+
53+
| **Name** | **Type** | **Description** |
54+
| --- | --- | --- |
55+
| <code>sender</code> | <code>str</code> | The email address for the sender of all emails. |
56+
57+
### SendEmailOptions (struct) <a class="wing-docs-anchor" id="@winglibs/email.SendEmailOptions"></a>
58+
59+
*No description*
60+
61+
#### Properties
62+
63+
| **Name** | **Type** | **Description** |
64+
| --- | --- | --- |
65+
| <code>html</code> | <code>str?</code> | The body of the email, in HTML. @default - The text body will be used as the HTML body. |
66+
| <code>subject</code> | <code>str</code> | The subject of the email. |
67+
| <code>text</code> | <code>str</code> | The body of the email, in plain text. |
68+
| <code>to</code> | <code>Array<str></code> | The email addresses to send the email to. |
69+

0 commit comments

Comments
 (0)