Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/antham/yogo

Check yopmail mails from command line.
https://github.com/antham/yogo

email email-disposable-checker yopmail

Last synced: 21 days ago
JSON representation

Check yopmail mails from command line.

Awesome Lists containing this project

README

        

# Yogo [![Go Report Card](https://goreportcard.com/badge/github.com/antham/yogo)](https://goreportcard.com/report/github.com/antham/yogo) [![codecov](https://codecov.io/gh/antham/yogo/branch/master/graph/badge.svg)](https://codecov.io/gh/antham/yogo) [![GitHub tag](https://img.shields.io/github/tag/antham/yogo.svg)]() [![Go Reference](https://pkg.go.dev/badge/github.com/antham/yogo.svg)](https://pkg.go.dev/github.com/antham/yogo)

Check yopmail mails from command line.

## Install

Download binaries here : [yogo](https://github.com/antham/yogo/releases/).

Or run:
`go install github.com/antham/yogo/v4@latest`

A package is available in aur for archlinux.

## Usage

```
Check yopmail mails from command line.

Usage:
yogo [command]

Available Commands:
completion Generate the autocompletion script for the specified shell
help Help about any command
inbox Handle inbox messages
version App version

Flags:
--debug Log all requests/responses
-h, --help help for yogo
--json Dump the output as json

Use "yogo [command] --help" for more information about a command.

```

⚠️ Performing too much calls will trigger a CAPTCHA that you will need to solve through a browser. Add a delay to prevent this.

## Environment variable

You can customize the behaviour of Yogo through several environment variables:

| Name | Default value | Usage |
|------------------------|------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------|
| `HTTP_PROXY` | Empty | Define an HTTP proxy for the requests |
| `HTTPS_PROXY` | Empty | Define an HTTPs proxy for the requests |
| `YOGO_USER_AGENT` | See the `defaultUserAgent` const in the [client](https://github.com/antham/yogo/blob/master/internal/client/client.go) | The user agent used to perfom the requests |
| `YOGO_REQUEST_TIMEOUT` | 10 | Duration of a request before reaching the timeout in seconds |

## Flag

Use the `--json` output flag to get the output as JSON.

In case of an issue with `yogo`, use the `--debug` flag to log the requests/responses.

## Inbox

### List

Retrieve 10 messages from mailbox [email protected] :

```bash
yogo inbox list test1 10
```

### Flush

Flush inbox [email protected] :

```bash
yogo inbox flush test1
```

### Read a mail

Retrieve first message from inbox [email protected]

```bash
yogo inbox show helloworld 1
```

Retrieve second message from inbox [email protected]

```bash
yogo inbox show helloworld 2
```

### Read the source of the mail with all headers

```bash
yogo inbox source helloworld 1
```

### Delete a mail

Delete first message from inbox [email protected]

```bash
yogo inbox delete helloworld 1
```