https://github.com/raschmitt/cli-mail

Simple CLI tool for sending e-mails.
https://github.com/raschmitt/cli-mail

cli dotnet-tool email

Last synced: 7 months ago
JSON representation

Simple CLI tool for sending e-mails.

• Host: GitHub
• URL: https://github.com/raschmitt/cli-mail
• Owner: raschmitt
• License: mit
• Created: 2020-08-15T00:26:58.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2020-08-21T02:10:38.000Z (almost 6 years ago)
• Last Synced: 2025-01-08T18:16:41.635Z (over 1 year ago)
• Topics: cli, dotnet-tool, email
• Language: C#
• Homepage: https://www.nuget.org/packages/CliMail/
• Size: 56.6 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          

# Cli.Mail 

[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/raschmitt/cli-mail/.NET%20Core%20-%20Build%20&%20Test?label=Build%20%26%20Test&style=flat-square)](https://github.com/raschmitt/cli-mail/actions?query=workflow%3A%22.NET+Core+-+Build+%26+Test%22)

[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/raschmitt/cli-mail/Nuget%20Deploy?label=Deploy&style=flat-square)](https://github.com/raschmitt/cli-mail/actions?query=workflow%3A%22Nuget+Deploy%22)

[![Codecov](https://img.shields.io/codecov/c/github/raschmitt/cli-mail?label=Code%20Coverage&style=flat-square)](https://codecov.io/gh/raschmitt/cli-mail)

[![Mutation testing badge](https://img.shields.io/endpoint?style=flat-square&url=https%3A%2F%2Fbadge-api.stryker-mutator.io%2Fgithub.com%2Fraschmitt%2Fcli-mail%2Fmaster)](https://dashboard.stryker-mutator.io/reports/github.com/raschmitt/cli-mail/master)

[![Nuget](https://img.shields.io/nuget/v/CliMail?label=Nuget&style=flat-square)](https://www.nuget.org/packages/CliMail/)

[![Nuget](https://img.shields.io/nuget/dt/CliMail?color=Blue&label=Downloads&style=flat-square)](https://www.nuget.org/stats/packages/CliMail?groupby=Version)

Cli.Mail is an easy to use .Net CLI tool for sending emails.

## Install

```

dotnet tool install -g climail

```

## How to use

Currently Cli.Mail only works for sending emails from gmail accounts, and you have to enable access form less secure apps for it to work properly.

### Enabling less secure apps in gmail

1. Go to your ([Google Account](https://myaccount.google.com/)).

2. On the left navigation panel, click `Security`.

3. On the bottom of the page, in the Less secure app access section, click on `Turn on access` and turn it on.

### Sample usage

```

climail -u mark@gmail.com -p P@assword123 -r jack@icloud.com -s "Regards" -m "Hi Jack, how are you doing?"

```

### Parameters

| Parameter | Description | Required |

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

| -u, --username | Email from where the message will be sent | Yes |

| -p, --password | Email account password | Yes |

| -r, --recipient  | Email recipient | Yes |

| -s, --subject  | Email recipient | Yes |

| -m, --message     | Email message | Yes |

| --help     | Display the help screen | No |

| --version     | Displays version information | No |

## Contributions

  Contributions and feature requests are always welcome.