{"id":16278020,"url":"https://github.com/rpidanny/mailer","last_synced_at":"2025-06-25T08:04:14.481Z","repository":{"id":80496537,"uuid":"145420307","full_name":"rpidanny/mailer","owner":"rpidanny","description":"A serverless application that provides an API to send emails","archived":false,"fork":false,"pushed_at":"2019-02-22T22:11:09.000Z","size":79,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-08T17:31:47.405Z","etag":null,"topics":["email","email-sender","firebase","firebase-functions","serverless"],"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/rpidanny.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":"2018-08-20T13:19:21.000Z","updated_at":"2019-02-22T22:11:11.000Z","dependencies_parsed_at":null,"dependency_job_id":"3715f596-34e6-45fa-8722-9c9a17cf0fae","html_url":"https://github.com/rpidanny/mailer","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/rpidanny/mailer","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rpidanny%2Fmailer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rpidanny%2Fmailer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rpidanny%2Fmailer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rpidanny%2Fmailer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rpidanny","download_url":"https://codeload.github.com/rpidanny/mailer/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rpidanny%2Fmailer/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261832617,"owners_count":23216494,"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":["email","email-sender","firebase","firebase-functions","serverless"],"created_at":"2024-10-10T18:57:04.235Z","updated_at":"2025-06-25T08:04:14.465Z","avatar_url":"https://github.com/rpidanny.png","language":"JavaScript","readme":"# Mailer\n\nA simple serverless application that exposes a REST API for sending emails.\n\n## Setting up\n\n 1. Create a Firebase Project using the [Firebase Console](https://console.firebase.google.com).\n 1. Enable the **Google** Provider in the **Auth** section.\n 1. Clone or download this repo and open the `mailer` directory.\n 1. You must have the Firebase CLI installed. If you don't have it install it with `npm install -g firebase-tools` and then configure it with `firebase login`.\n 1. Configure the CLI locally by using `firebase use --add` and select your project in the list.\n 1. Install Cloud Functions dependencies locally by running: `cd functions; npm install; cd -`\n 1. To be able to send emails with your Gmail account: enable access to [Less Secure Apps](https://www.google.com/settings/security/lesssecureapps) and [Display Unlock Captcha](https://accounts.google.com/DisplayUnlockCaptcha). For accounts with 2-step verification enabled [Generate an App Password](https://support.google.com/accounts/answer/185833).\n 1. Set the `gmail.email` and `gmail.password` Google Cloud environment variables to match the email and password of the Gmail account used to send emails (or the app password if your account has 2-step verification enabled). For this use:\n\n    ```bash\n    firebase functions:config:set gmail.email=\"myusername@gmail.com\" gmail.password=\"secretpassword\"\n    ```\n\n## Deploy and test\n\nThis sample comes with a web-based UI for testing the function. To test it out:\n\n 1. Deploy your project using `firebase deploy`\n 1. Open the app using `firebase open hosting:site`, this will open a browser.\n 1. Sign in the web app in the browser using Google Sign-In and delete your account using the button on the web app. You should receive email confirmations for each actions.\n\n## API\n\nSee the detailed API Reference\n\n### Example\n\n```shell\ncurl -X POST -H \"Content-Type:application/json\" https://us-central1-\u003cproject-id\u003e.cloudfunctions.net/mail/ \\\n  -d '{\n    \"from\": \"Example App\",\n    \"to\": \"a@gmail.com\",\n    \"subject\": \"Hello World\",\n    \"text\": \"It works\"\n  }'\n```","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frpidanny%2Fmailer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frpidanny%2Fmailer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frpidanny%2Fmailer/lists"}