Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/alexcoder04/iserv2go

*Unofficial* IServ Go library and CLI
https://github.com/alexcoder04/iserv2go

api automation cli command-line education email files go go-api go-library golang iserv lib library mail school web-api

Last synced: 12 days ago
JSON representation

*Unofficial* IServ Go library and CLI

Host: GitHub
URL: https://github.com/alexcoder04/iserv2go
Owner: alexcoder04
License: agpl-3.0
Created: 2022-11-09T13:26:57.000Z (about 2 years ago)
Default Branch: main
Last Pushed: 2024-10-29T18:25:48.000Z (about 2 months ago)
Last Synced: 2024-10-29T20:33:06.693Z (about 2 months ago)
Topics: api, automation, cli, command-line, education, email, files, go, go-api, go-library, golang, iserv, lib, library, mail, school, web-api
Language: Go
Homepage:
Size: 162 KB
Stars: 4
Watchers: 1
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md

Awesome Lists containing this project

README

        
# iserv2go

[![License](https://img.shields.io/github/license/alexcoder04/iserv2go)](https://github.com/alexcoder04/iserv2go/blob/main/LICENSE)

[![Go Version](https://img.shields.io/github/go-mod/go-version/alexcoder04/iserv2go)](https://github.com/alexcoder04/iserv2go/blob/main/go.mod)

[![Lines](https://img.shields.io/tokei/lines/github/alexcoder04/iserv2go?label=lines)](https://github.com/alexcoder04/iserv2go/pulse)

[![Release](https://img.shields.io/github/v/release/alexcoder04/iserv2go?display_name=tag&sort=semver)](https://github.com/alexcoder04/iserv2go/releases/latest)

[![Stars](https://img.shields.io/github/stars/alexcoder04/iserv2go)](https://github.com/alexcoder04/iserv2go/stargazers)

[![Contributors](https://img.shields.io/github/contributors-anon/alexcoder04/iserv2go)](https://github.com/alexcoder04/iserv2go/graphs/contributors)

An unofficial Go library and CLI for [IServ](https://iserv.eu/).

**Disclaimer 1**: I am **not** affiliated with the [IServ GmbH](https://iserv.eu/) in any way.

**Disclaimer 2**: This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the [GNU Affero General Public License](./LICENSE) for more details.

**Disclaimer 3**: Use it at YOUR OWN RISK!

## Use as CLI

```sh

iserv2go [options] command [arguments...]

```

### List of options

|Option|Description|

|---|---|

|`-enable-email`|enables the email functionality|

|`-enable-files`|enables the files functionality|

|`-enable-web`|enables other functions (notifications, exercises, etc)|

|`-info`|shows program info|

|`-interactive`|starts interactive console where you can type commands instead of passing them as arguments|

|`-save-sessions`|saves login cookies on the hard drive for subsequent logins|

### List of commands

|Command|Arguments|Description|

|---|---|---|

|`email.list_mailboxes`|none|get a list of mailboxes|

|`email.read_mailbox`|`mailbox path`|get last 50 messages from mailbox|

|`email.send_mail`|`recipient address`, `subject`, `body`|send email|

|`files.cat`|`filename`|print contents of file|

|`files.download`|`iserv path`, `local path`|download file from IServ|

|`files.ls`|`directory`|list of files in directory|

|`files.upload`|`local path`, `iserv path`|upload file to IServ|

|`web.get_badges`|none|get badges (for modules on the nav bar left)|

|`web.get_current_exercises`|none|list of current exercises|

|`web.get_notifications`|none|get unread notifications|

|`web.get_past_exercises`|none|list of past exercises|

|`web.get_upcoming_events`|none|list of upcoming events|

## Use as Library

### Install

```sh

# in your project directory

go get github.com/alexcoder04/iserv2go/iserv

```

### Example usage

```go

package main

import (

    "fmt"

    "github.com/alexcoder04/iserv2go/iserv"

    "github.com/alexcoder04/iserv2go/iserv/types"

)

func main(){

    // create new client instance

    client := iserv.Client{}

    // login your client

    err := client.Login(&types.ClientConfig{

        IServHost: os.Getenv("ISERV_HOST"),

        Username:  os.Getenv("ISERV_USERNAME"),

        Password:  os.Getenv("ISERV_PASSWORD"),

        EnableModules: map[string]bool{

            "email": true,

            "files": false,

            "web":   false,

        },

        SaveSessions: true,

    })

    if err != nil {

        fmt.Println("failed to login")

        return

    }

    // don't forget to logout

    defer client.Logout()

    // get 10 last mails in INBOX

    messages, err := client.Email.ReadMailbox("INBOX", 10)

    if err != nil {

        return

    }

    // print them

    for _, m := range messages {

        fmt.Printf(" = '%s' from %s\n", m.Envelope.Subject, m.Envelope.Sender[0].Address())

    }

}

```

## Project Structure

The `iserv` folder contains the Go Library, the subfolders `email`, `files`, `web` are modules, which can be (de-)activated separately.

They contain each `user.go` files, which include all the functions meant to be used by end-user.

## Contributing

Contributions are always welcome, there are a lot of things that wait to be implemented, see the [issues](https://github.com/alexcoder04/iserv2go/issues).

I am also looking for co-maintainers and someone to test the project extensively :)

## Credits

### Contributors

 - [@Redstonerayy](https://github.com/Redstonerayy)

### Libraries

 - [goquery](https://github.com/PuerkitoBio/goquery) - parsing the html pages to extract information

 - [go-imap](https://github.com/emersion/go-imap) - receive emails

 - [gowebdav](https://github.com/studio-b12/gowebdav) - work with files