Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lemunozm/service-io
Build your own hostingless server.
https://github.com/lemunozm/service-io
email imap server smtp
Last synced: about 2 months ago
JSON representation
Build your own hostingless server.
- Host: GitHub
- URL: https://github.com/lemunozm/service-io
- Owner: lemunozm
- License: apache-2.0
- Archived: true
- Created: 2022-03-29T12:16:05.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-07-10T18:02:04.000Z (about 1 year ago)
- Last Synced: 2024-07-28T17:42:06.290Z (about 2 months ago)
- Topics: email, imap, server, smtp
- Language: Rust
- Homepage:
- Size: 267 KB
- Stars: 35
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://crates.io/crates/service-io)
[](https://docs.rs/service-io)
[](https://www.apache.org/licenses/LICENSE-2.0.txt)
[](https://www.buymeacoffee.com/lemunozm)
**NOTE: This crate is archived, use [`mailfred`](https://github.com/lemunozm/mailfred) instead.**
`service-io` is a library to build servers that offering services with really little effort.
1. Choose an input connector.
2. Choose an output connector.
3. Choose your services.
4. Run it!
One of the main use-cases is to offer services [without a hosting server](#no-hosting-server).
## How it works?
All of them, **inputs**/**outputs** and **services** "speak" the same language:
the [`Message`](https://docs.rs/service-io/latest/service_io/message/struct.Message.html) type.
Inputs obtain and transform input data into a `Message`.
Services receive `Message`s and generate other `Message`s usually doing some kind of processing.
Outputs transform a `Message` into output data and deliver it.
Check the current built-in input/output
[connectors](https://docs.rs/service-io/latest/service_io/connectors/index.html)
and
[services](https://docs.rs/service-io/latest/service_io/services/index.html).
## Features
- **Easy to use**. Running a server with a bunch of services with (really) few lines of code.
- **Hostingless**. Run custom server code without hosting server using the existing email infrastructure
using the IMAP/SMTP connectors.
- **Scalable**. Create your own inputs/outputs/services implementing a trait with a single method.
[Check docs](https://docs.rs/service-io/latest/service_io/interface/index.html)
- **Multiplatform**. Run your local service-server in any computer you have.
## Getting Started
- [API Docs](https://docs.rs/service-io/latest/service_io/)
- [Examples](examples)
Add the following to your `Cargo.toml`
```toml
service-io = "0.1"
```
## Example
Running this example in any of your home computer,
and sending an email (as an example, to `[email protected]`)
with `public-ip` in the subject, you will obtain a response email with your home public IP!
In a similar way, sending an email with `process ls -l` in the subject will return
an email with the files of the folder used to run the example.
```rust,no_run
use service_io::engine::Engine;
use service_io::connectors::{ImapClient, SmtpClient};
use service_io::services::{PublicIp, Process, Echo, Alarm};
#[tokio::main]
async fn main() {
Engine::default()
.input(
ImapClient::default()
.domain("imap.domain.com")
.email("[email protected]")
.password("1234")
)
.output(
SmtpClient::default()
.domain("smtp.domain.com")
.email("[email protected]")
.password("1234")
)
.add_service("echo", Echo)
.add_service("alarm", Alarm)
.add_service("public-ip", PublicIp)
.add_service("process", Process)
// Add any other service you want
.run()
.await;
}
```
Any email sent to `[email protected]` will be interpreted as a request by the `ImapClient` connector.
If the first word of the subject matches `public-ip`, the request will be processed by the `PublicIp` service.
The service `PublicIp` will generate a response that `SmtpClient` will be deliver by email
to the remitter of the request email.
Check the [Engine](https://docs.rs/service-io/latest/service_io/engine/struct.Engine.html) type
for additional methods as input mapping/filters or adding whitelists to your services.
Test it yourself with [examples/email_server.rs](examples/email_server.rs).
Run the following to see all config options.
```sh
cargo run --example email_server -- --help
```
## Configuring a gmail account to use with `service-io`.
For use `service-io` with IMAP and SMTP connectors with gmail you need to configure some points
of your gmail account:
- Enable IMAP in account settings: Check this [Step 1](https://support.google.com/mail/answer/7126229?hl=en#zippy=%2Cpaso-comprueba-que-imap-est%C3%A9-activado%2Cstep-check-that-imap-is-turned-on).
- Enable [unsecure app access](https://support.google.com/accounts/answer/6010255?hl=en)
to allow login with password from an app.
(Pending work to make it available through *oauth2* and avoid this point).
## No hosting server use-case
If you want to offer some custom service that uses *custom server code*
you are forced to pay and maintain a hosting server,
even if the service you are offering is eventual or does not use many resources.
To solve this problem, you can use the already existent email infrastructure
using the IMAP and SMTP protocols to handle the emails as requests/responses and link them with your services.
`service-io` helps in this context.
Run locally an instance of `service-io` with IMAP/SMTP connectors.
The IMAP connector will periodically fetch the emails your clients sends,
then your services will process those emails and generate a response,
and finally the SMTP connector will deliver the response emails back to the user.
Anyone from any device with an email client can interact with your local server deployment.
There is **no hosting maintenance** and **no front-end app development**.
## Contribute
- *Have you implemented a **service** or **connector**?*
If its functionallity is not private, share it with others!
Make a *Pull Request* so everyone can use it :)
- *Do you have any cool **idea**, found a **bug** or have any **question** or **doubt**?*
Do not hesitate and open an issue!