NOTE: This crate is archived, use 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.

How it works?

All of them, inputs/outputs and services "speak" the same language: the Message type.

Inputs obtain and transform input data into a Message. Services receive Messages and generate other Messages usually doing some kind of processing. Outputs transform a Message into output data and deliver it.

Check the current built-in input/output connectors and services.

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
• Multiplatform. Run your local service-server in any computer you have.

Getting Started

• API Docs
• Examples

Add the following to your Cargo.toml

service-io = "0.1"

Example

Running this example in any of your home computer, and sending an email (as an example, to services@domain.com) 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.

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("services@domain.com")
                .password("1234")
        )
        .output(
            SmtpClient::default()
                .domain("smtp.domain.com")
                .email("services@domain.com")
                .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 services@domain.com 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 type for additional methods as input mapping/filters or adding whitelists to your services.

Test it yourself with examples/email_server.rs. Run the following to see all config options.

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.
• Enable unsecure app access 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!