feat: add mail component #178

chuang8511 · 2024-06-25T19:31:59Z

Because

we want users to be able to fetch mail and send mail through vdp

This commit

build mail component with send and read mail

linear · 2024-06-25T19:32:02Z

INS-5039 [VDP] [Pipeline] Short term AI SDR demo Component dev

chuang8511 · 2024-06-26T14:53:15Z

e2e test

read email test

send email test

donch1989 · 2024-06-26T23:16:19Z

application/email/v0/read_emails.go

+
+func initIMAPClient(serverAddress string, serverPort int) (*imapclient.Client, error) {
+
+ c, err := imapclient.DialTLS(serverAddress+":"+strconv.Itoa(serverPort), nil)


We can use fmt.Printf here

donch1989 · 2024-06-26T23:31:53Z

application/email/v0/read_emails.go

+ }
+}
+
+func includeSearchCondition(email Email, search Search) bool {


How about rename this to checkEnvelopeCondition?

donch1989 · 2024-06-26T23:33:38Z

application/email/v0/read_emails.go

+ return true
+}
+
+func includeSearchMessage(email Email, search Search) bool {


How about rename this to checkMessageCondition?

donch1989 · 2024-06-26T23:43:48Z

application/email/v0/config/tasks.json

+ "title": "Search Subject",
+ "type": "string"
+ },
+ "search-from-email": {


search-from-email looks a little bit weird to me. How about we use search-from or search-email-from instead?

donch1989 · 2024-06-26T23:44:18Z

application/email/v0/config/tasks.json

@@ -0,0 +1,471 @@
+{
+ "$defs": {
+ "search-subject-text": {


I thinks search-subject should be enough.

donch1989 · 2024-06-26T23:49:36Z

application/email/v0/read_emails.go

+ }
+ }
+ if search.SearchFromEmail != "" {
+ if !strings.Contains(email.From, search.SearchFromEmail) {


I suggest we perform an exact search here: email.From == search.SearchFromEmail. If the email address is [email protected] but you search for [email protected], things will go wrong.

My original design was to let the users able to search [email protected] through aaa.
But, I think your way will be better! So, I will modify it as well.

Yeah, in this case, fuzzy search it not suitable.

donch1989 · 2024-06-26T23:51:02Z

application/email/v0/read_emails.go

+ return emails, nil
+}
+
+func convertMailboxString(mailbox string) string {


Since you convert the name of mailbox to the Gmail name. Does this mean that the current implementation can only be used with Gmail?

@donch1989
I miss to consider this point when I developed it. Thanks for pointing it out.
Now, I have 2 ideas for this.

do not support mailbox field, and we fetch all emails from all mailbox.

make mailbox as plain text, and we write the Gmail input as the example in Email Component Document

What do you think about this?

I think we can go with option 1 first. Will that have any side effects?

Will that have any side effects?

It will take a longer time to scan all mailboxes.
For AI SDR demo, I think the speed of fetching emails & accuracy of the content would be the key to success.
By specifying the mailbox, it can increase the performance in terms of speed and accuracy.

Could we go with option 2 in the current phase?
Is only searching one mailbox a damage for UX? If so, how about we set it as array:string?
Or, do you have other concerns that I miss?

It will take a longer time to scan all mailboxes.

I'm not sure about the mechanism here. I remember you already set a limit on the number of emails, right?

array:string
I don't think array: string can work well on Console for now.

The problem with Option 2 is that users may struggle to type the correct mailbox name.

I'm not sure about the mechanism here. I remember you already set a limit on the number of emails, right?

Yes, the limit I set is the number to "scan", it will only scan a specific mailbox if the limit is smaller than the message number in a mailbox.
By the current design, it won't get the content for AI SDR usage if we make it scan INBOX first.

The purpose I specially design mailbox field is for the usage to get the sending mails specifically.

The problem with Option 2 is that users may struggle to type the correct mailbox name.

Yes, it is the purpose to design this field with enum.

the limit I set is the number to "scan",

The reason of this design is that I have not found how to fetch emails through batch (query) way.
So, we have to fetch email one by one .

It makes the scanning takes time if we do not have limit here.
So, I added this field and set it 100 as default.

OK, I just check the imap package, it need the mailbox input. Then I think we can use Option 2 with a string plaintext.

Thank you! I will add Gmail mailbox in the document as well.

donch1989 · 2024-06-26T23:55:47Z

application/email/v0/config/tasks.json

+ "title": "Search To",
+ "type": "string"
+ },
+ "server-address": {


I'm thinking we should put the server-address and server-port into setup.json. They should be in the same place as the user email and password.

application/email/v0/.compogen/extra-intro.mdx

application/email/v0/.compogen/extra-send-mails.mdx

application/email/v0/config/definition.json

donch1989 · 2024-06-27T14:34:01Z

application/email/v0/config/tasks.json

+ "type": "string"
+ }
+ },
+ "TASK_SEND_EMAILS": {


Since we only send one email, how about removing the "s"?

Ah, I thought an email is like a message to a recipient.
The emails mean a message to several recipients.

I set it as recipients

So, I use plural here.
Should I change it to singular?

'Send emails' sounds more like sending different content, but in this case, you're sending just one.

GeorgeWilliamStrong · 2024-06-27T15:58:06Z

application/email/v0/.compogen/extra-setup.mdx

+For App Password, please follow the steps below:
+ - 1. Please Sign in to your Google Account with link: https://myaccount.google.com/apppasswords
+ - 2. Create a new App Password and save it in a secure place.
+ - 3. Set it in Secrets in the Instill Platform.


Suggested change

- 3. Set it in Secrets in the Instill Platform.

- 3. Add App Password as a new secret in the Instill Platform by navigating to **Console** > **Settings** > **Secrets**.

GeorgeWilliamStrong

LGTM (from a doc perspective)

donch1989

LGTM

droplet-bot added the instill component label Jun 25, 2024

chuang8511 added 9 commits June 26, 2024 16:18

feat: add gmail component skeleton

1d759fe

fix: wrap gmail to mail component

5b8faaa

feat: add read mail function

6385648

chore: change name from mail to email

1bf4f2a

feat: add filters and fix bugs

206d241

chore: add icon

797ed3d

feat: send email function

5a5cf51

feat: add send email specific logic test code

983aff6

feat: add test code for read emails specific logic

d56e48a

chuang8511 force-pushed the chunhao/ins-5039 branch from 6d95520 to d56e48a Compare June 26, 2024 15:18

chuang8511 added 2 commits June 26, 2024 17:36

fix: fix the bug from there is no ui order in some properties

99d6aab

chore: complete doc

ce3c1a9

chuang8511 marked this pull request as ready for review June 26, 2024 17:14

chuang8511 requested review from donch1989, pinglin, xiaofei-du and jvallesm as code owners June 26, 2024 17:14

donch1989 requested changes Jun 26, 2024

View reviewed changes

jvallesm reviewed Jun 27, 2024

View reviewed changes

jvallesm mentioned this pull request Jun 27, 2024

chore(compogen): DO NOT MERGE exemplify content injection with Text operator #172

Closed

chuang8511 added 2 commits June 27, 2024 13:05

fix: modify doc, change function name, and make mailbox plaintext

e6c8b59

fix: modify doc and change fatal error to infolog

11cef71

chuang8511 requested review from jvallesm and donch1989 June 27, 2024 12:34

donch1989 requested changes Jun 27, 2024

View reviewed changes

GeorgeWilliamStrong reviewed Jun 27, 2024

View reviewed changes

GeorgeWilliamStrong previously approved these changes Jun 27, 2024

View reviewed changes

chuang8511 added 2 commits June 27, 2024 17:21

chore: update document

e8dbcdd

chore: change task name from send emails to send email

518f7eb

chuang8511 dismissed GeorgeWilliamStrong’s stale review via 518f7eb June 27, 2024 16:47

chuang8511 added 4 commits June 27, 2024 17:48

chore: modify name of task

fe34c5f

chore: change name from send emails to send email

418d39a

chore: update doc

e721dba

chore: update doc

fc7dc9c

chuang8511 requested a review from donch1989 June 27, 2024 16:57

donch1989 approved these changes Jun 27, 2024

View reviewed changes

donch1989 merged commit 04b19d0 into main Jun 27, 2024
8 checks passed

donch1989 deleted the chunhao/ins-5039 branch June 27, 2024 17:03

droplet-bot mentioned this pull request Jun 27, 2024

chore(main): release 0.21.0-beta #173

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add mail component #178

feat: add mail component #178

chuang8511 commented Jun 25, 2024

linear bot commented Jun 25, 2024

chuang8511 commented Jun 26, 2024 •

edited

Loading

donch1989 Jun 26, 2024

donch1989 Jun 26, 2024

donch1989 Jun 26, 2024

donch1989 Jun 26, 2024

donch1989 Jun 26, 2024

donch1989 Jun 26, 2024

chuang8511 Jun 27, 2024 •

edited

Loading

donch1989 Jun 27, 2024

donch1989 Jun 26, 2024 •

edited

Loading

chuang8511 Jun 27, 2024

donch1989 Jun 27, 2024

chuang8511 Jun 27, 2024

chuang8511 Jun 27, 2024 •

edited

Loading

donch1989 Jun 27, 2024

chuang8511 Jun 27, 2024

chuang8511 Jun 27, 2024 •

edited

Loading

donch1989 Jun 27, 2024

chuang8511 Jun 27, 2024

donch1989 Jun 26, 2024

donch1989 Jun 27, 2024

chuang8511 Jun 27, 2024

donch1989 Jun 27, 2024

GeorgeWilliamStrong Jun 27, 2024

GeorgeWilliamStrong left a comment •

edited

Loading

donch1989 left a comment


		func initIMAPClient(serverAddress string, serverPort int) (*imapclient.Client, error) {

		c, err := imapclient.DialTLS(serverAddress+":"+strconv.Itoa(serverPort), nil)

	- 3. Set it in Secrets in the Instill Platform.
	- 3. Add App Password as a new secret in the Instill Platform by navigating to Console > Settings > Secrets.

feat: add mail component #178

feat: add mail component #178

Conversation

chuang8511 commented Jun 25, 2024

linear bot commented Jun 25, 2024

chuang8511 commented Jun 26, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chuang8511 Jun 27, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

donch1989 Jun 26, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chuang8511 Jun 27, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chuang8511 Jun 27, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

GeorgeWilliamStrong left a comment • edited Loading

Choose a reason for hiding this comment

donch1989 left a comment

Choose a reason for hiding this comment

chuang8511 commented Jun 26, 2024 •

edited

Loading

chuang8511 Jun 27, 2024 •

edited

Loading

donch1989 Jun 26, 2024 •

edited

Loading

chuang8511 Jun 27, 2024 •

edited

Loading

chuang8511 Jun 27, 2024 •

edited

Loading

GeorgeWilliamStrong left a comment •

edited

Loading