Skip to content

Commit 8c0746b

Browse files
committed
Update Readme
1 parent 72f89d6 commit 8c0746b

File tree

1 file changed

+14
-10
lines changed

1 file changed

+14
-10
lines changed

README.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,22 @@
44

55
![arduino-library-badge](https://www.ardu-badge.com/badge/ReadyMail.svg) ![PlatformIO](https://badges.registry.platformio.org/packages/mobizt/library/ReadyMail.svg)
66

7-
The fast and lightweight async Email client library for Arduino.
7+
The fast and lightweight async email client library for Arduino.
88

99
This library seamlessly works in async and await modes. The chunk data is processed for decodings, encodings, parsing, uploading and downloading.
1010

11-
For sending Email, the typical inline images and attachments plus the RFC 822 messages are supported.
11+
For sending email, the typical inline images and attachments plus the RFC 822 messages are supported.
1212

13-
For fetching Email, this library provides the ready to use decoded data (headers, text body and attchments) for downloading and post processing.
13+
For fetching email, this library provides the ready to use decoded data (headers, text body and attchments) for downloading and post processing.
1414

1515
This library supports all 32-bit `Arduino` devices e.g. `STM32`, `SAMD`, `ESP32`, `ESP8266`, `Raspberry Pi RP2040`, and `Renesas` devices except for 8-bit `Atmel's AVR` devices.
1616

1717

18-
## Email Sending
18+
## Send Email
1919

20-
To send an Email message, user needs to defined the `SMTPClient` and `SMTPMessage` class objects.
20+
To send an email message, user needs to defined the `SMTPClient` and `SMTPMessage` class objects.
2121

22-
The one of SSL client if you are sending Email over SSL/TLS or basic network client should be set for the `SMTPClient` class constructor.
22+
The one of SSL client if you are sending email over SSL/TLS or basic network client should be set for the `SMTPClient` class constructor.
2323

2424
Note that the SSL client or network client assigned to the `SMTPClient` class object should be lived in the `SMTPClient` class object usage scope otherwise the error can be occurred.
2525

@@ -146,7 +146,7 @@ In some Arduino devices that work with `WiFiNINA/WiFi101` firmwares, use `SMTPMe
146146
147147
**Half Line-Break**
148148
149-
Depending on server policy, some SMTP server may reject the Email sending when the Lf (line feed) was used for line break in the content instead of CrLf (Carriage return + Line feed).
149+
Depending on server policy, some SMTP server may reject the email sending when the Lf (line feed) was used for line break in the content instead of CrLf (Carriage return + Line feed).
150150
151151
Then we recommend using CrLf instead of Lf in the content to avoid this issue.
152152
@@ -229,9 +229,13 @@ The `SMTPCommandResponse::statusCode` value provides the SMTP server response co
229229
The [Command.ino](/examples/Sending/Command/Command.ino) example showed how to use `SMTPClient::sendCommand()` to work with flags, message and folder or mailbox.
230230
231231
232-
## Email Reading
232+
## Receive Email
233233
234-
To receive or fetch the Email, only `IMAPClient` calss object is required.
234+
The IMAP protocol supports fetching, searching and idling. The idle and fetch functions can be used to get the incoming email alert.
235+
236+
While serach function with keywords also provides the mean to get the specific messages that match the search criteria e.g. unread, new, and flagged messages.
237+
238+
To search, receive or fetch the email, only `IMAPClient` calss object is required.
235239
236240
The `IMAPDataCallback` and `FileCallback` functions can be assigned to the `IMAPClient::fetch` and `IMAPClient::fetchUID` functions.
237241
@@ -292,7 +296,7 @@ if (imap.isConnected())
292296

293297
The library provides the simple IMAP APIs for idling (mailbox polling), searching and fetching the messages. If additional works are needed e.g. setting and deleting flags, or creating, moving and deleting folder, or copying, moving and deleting mssage etc., those taks can be done through the `IMAPClient::sendCommand()`.
294298

295-
The [Command.ino](/examples/Reading/Command/Command.ino) example show how to do those works. The server responses from sending the command will be discussed in the [IMAP Custom Comand Processing Information](#imap-custom-comand-processing-information) section below.
299+
The [Command.ino](/examples/Reading/Command/Command.ino) example shows how to do those works. The server responses from sending the command will be discussed in the [IMAP Custom Comand Processing Information](#imap-custom-comand-processing-information) section below.
296300

297301

298302
### IMAP Processing Information

0 commit comments

Comments
 (0)