Skip to content

Commit

Permalink
feat: mail plugin
Browse files Browse the repository at this point in the history
  • Loading branch information
BIYUEHU committed Aug 5, 2024
1 parent e0d1dbc commit 17b504d
Show file tree
Hide file tree
Showing 21 changed files with 796 additions and 228 deletions.
33 changes: 0 additions & 33 deletions modules/adapter-email/README.md

This file was deleted.

13 changes: 0 additions & 13 deletions modules/adapter-email/package.json

This file was deleted.

87 changes: 0 additions & 87 deletions modules/adapter-email/src/adapter.ts

This file was deleted.

30 changes: 0 additions & 30 deletions modules/adapter-email/src/api.ts

This file was deleted.

44 changes: 0 additions & 44 deletions modules/adapter-email/src/elements.ts

This file was deleted.

41 changes: 41 additions & 0 deletions modules/adapter-mail/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# @kotori-bot/adapter-mail

Supports for email. Such as `Google Mail`, `QQ Mail`, `163 Mail` and more...

## Config

```typescript
export const config = Tsu.Object({
title: Tsu.String().domain().default('Love from kotori bot mailer').describe('Mail default title'),
user: Tsu.String().describe('Email address'),
password: Tsu.String().describe('Email password'),
imapHost: Tsu.String().domain().describe('IMAP server host'),
imapPort: Tsu.Number().describe('IMAP server port'),
smtpHost: Tsu.String().domain().describe('SMTP server host'),
smtpPort: Tsu.Number().describe('SMTP server port')
})
```

## Supports

### Events

- on_message (only `MessageScope.PRIVATE`)

### Api

- sendPrivateMsg

### Elements

- text
- mention
- image
- voice
- video
- file
- reply

## Reference

- [Kotori Docs](https://kotori.js.org/)
16 changes: 16 additions & 0 deletions modules/adapter-mail/locales/common.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
"adapter_mail.descr.mail": "Send mail by target email",
"adapter_mail.msg.mail.input_target": "Please input received email",
"adapter_mail.msg.mail.input_title": "Please input mail title",
"adapter_mail.msg.mail.input_content": "Please input mail content",
"adapter_mail.msg.mail.sure": "Title: {0}\nContent: {1}\n-------------\nMak sure to send mail to {2}? (Input \"1\" to send, any other key to cancel)",
"adapter_mail.msg.mail.cancel": "Cancel successfully to send",
"adapter_mail.msg.mail.success": "Succeeded in sending mail to {0}",
"adapter_mail.msg.mail.fail": "Failed to send mail, please check mail configuration, details: {0}",
"adapter_mail.msg.mail.fail.2": "Can not find sent email {0}, you can input \"{0}mail --list\" to view available emails list",
"adapter_mail.msg.mail.fail.3": "Failed to send,target email format error!",
"adapter_mail.msg.mail.item": "\n<=========>\nName: {0}\nEmail: {1}",
"adapter_mail.msg.mail.list": "Available emails list: {0}",
"adapter_mail.option.mail.list": "View available emails list",
"adapter_mail.forward": "Received a new mail!\nFrom: {0}\nTitle: {1}\nContent: {2}\nDate: {3}"
}
30 changes: 30 additions & 0 deletions modules/adapter-mail/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
{
"name": "@kotori-bot/adapter-mail",
"version": "1.0.0",
"description": "Adapter For Email",
"main": "lib/index.js",
"keywords": [
"kotori",
"chatbot",
"kotori-plugin"
],
"license": "GPL-3.0",
"files": [
"lib",
"locales",
"LICENSE",
"README.md"
],
"author": "Arimura Sena <[email protected]>",
"peerDependencies": {
"kotori-bot": "workspace:^"
},
"dependencies": {
"@types/imap-simple": "^4.2.9",
"@types/mailparser": "^3.4.4",
"@types/nodemailer": "^6.4.15",
"imap-simple": "^5.1.0",
"mailparser": "^3.7.1",
"nodemailer": "^6.9.14"
}
}
Loading

0 comments on commit 17b504d

Please sign in to comment.