{"id":15771627,"url":"https://github.com/trstringer/shark-mail","last_synced_at":"2025-04-21T04:31:46.845Z","repository":{"id":147740261,"uuid":"64598687","full_name":"trstringer/shark-mail","owner":"trstringer","description":":fish: Filesystem-based email CLI","archived":false,"fork":false,"pushed_at":"2016-08-08T14:11:53.000Z","size":28,"stargazers_count":5,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-10-11T15:09:34.723Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/trstringer.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-07-31T14:43:02.000Z","updated_at":"2018-06-24T15:26:05.000Z","dependencies_parsed_at":"2023-05-27T09:15:17.199Z","dependency_job_id":null,"html_url":"https://github.com/trstringer/shark-mail","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/trstringer%2Fshark-mail","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/trstringer%2Fshark-mail/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/trstringer%2Fshark-mail/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/trstringer%2Fshark-mail/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/trstringer","download_url":"https://codeload.github.com/trstringer/shark-mail/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249996107,"owners_count":21358064,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-04T15:03:41.147Z","updated_at":"2025-04-21T04:31:46.624Z","avatar_url":"https://github.com/trstringer.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Shark Mail\n\n*The simple filesystem-based email client*\n\n - [Installation](#installation)\n - [Configuration](#configuration)\n - [Receiving email](#receiving-email)\n - [Sending email](#sending-email)\n\n## Installation\n\n```\nnpm install --global shark-mail\n```\n\n## Configuration\n\nShark Mail relies on a simple filesystem configuration.  The following folders need to exist before launching Shark Mail...\n\n```\n~/sharkm\n~/sharkm/outbox\n~/sharkm/outbox/archive\n```\n\nHere's a quick oneliner to create the filesystem structure...\n\n```\ncd \u0026\u0026 mkdir -p sharkm/outbox/archive\n```\n\nShark Mail also requires a configuration file for a few things...\n 1. Email credential configuration (the *from* email address)\n 2. Address book list\n\n```javascript\nmodule.exports = {\n  sender: {\n    host: \"smtp.gmail.com\",\n    port: 465,\n    secure: true,\n    auth: {\n      user: \"you@gmail.com\",\n      pass: \"password\"\n    }\n  },\n  addressBook: [\n    { name: \"Person1\", email: \"person1@email.com\" },\n    { name: \"Person2\", email: \"person2@email.com\" }\n  ]\n};\n```\n\nCurrently the only supported provider is Gmail.\n\n## Receiving email\n\nTo receive email, you simply need to run...\n\n```\nsharkmail fetch\n```\n\nNew emails that haven't been received and cached yet are created in `~/sharkm`.  A new file will be created for each email.\n\n## Sending email\n\nEmails will be sent when you run...\n\n```\nsharkmail send\n```\n\nEmails that are sent will be in files in `~/sharkm/outbox` with the file extension of `*.email`.  All files that match `~/sharkm/outbox/*.email` will attempt to be sent.\n\nThe file format for outbound emails is the following...\n\n```\n\u003cemail-address-or-address-book-name\u003e\n\u003cemail-subject\u003e\n\u003cemail-body\u003e\n```\n\nIn short, email address or address book name on line 1, email subject on line 2, and the rest of the file (lines 3+) is the message body. \n\n\u003e :bulb: If you have a draft email that you don't want to accidentally send it's a good idea to have a different extension, such as `*.email.draft` and then remove `draft` when you're ready to send the email\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftrstringer%2Fshark-mail","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftrstringer%2Fshark-mail","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftrstringer%2Fshark-mail/lists"}