{"id":26811432,"url":"https://github.com/eyedea-io/syncano-socket-mailgun","last_synced_at":"2025-03-30T01:38:41.230Z","repository":{"id":23889726,"uuid":"94463137","full_name":"eyedea-io/syncano-socket-mailgun","owner":"eyedea-io","description":"Syncano Socket for Mailgun","archived":false,"fork":false,"pushed_at":"2024-02-02T18:21:01.000Z","size":238,"stargazers_count":0,"open_issues_count":32,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-04-13T19:25:06.660Z","etag":null,"topics":["mail","mailbox","mailgun","serverless","syncano","syncano-socket"],"latest_commit_sha":null,"homepage":"https://syncano.io","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/eyedea-io.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2017-06-15T17:29:00.000Z","updated_at":"2018-11-26T14:08:17.000Z","dependencies_parsed_at":"2023-12-20T08:02:13.895Z","dependency_job_id":"6efb4bdd-84c2-4570-b0b1-3484df6b4cdc","html_url":"https://github.com/eyedea-io/syncano-socket-mailgun","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eyedea-io%2Fsyncano-socket-mailgun","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eyedea-io%2Fsyncano-socket-mailgun/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eyedea-io%2Fsyncano-socket-mailgun/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eyedea-io%2Fsyncano-socket-mailgun/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/eyedea-io","download_url":"https://codeload.github.com/eyedea-io/syncano-socket-mailgun/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246266276,"owners_count":20749754,"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":["mail","mailbox","mailgun","serverless","syncano","syncano-socket"],"created_at":"2025-03-30T01:38:40.693Z","updated_at":"2025-03-30T01:38:41.222Z","avatar_url":"https://github.com/eyedea-io.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Syncano Socket for Mailgun\n\n[![Syncano Socket](https://img.shields.io/badge/syncano-socket-blue.svg)](https://syncano.io)\n[![CircleCI branch](https://img.shields.io/circleci/project/github/eyedea-io/syncano-socket-mailgun/master.svg)](https://circleci.com/gh/eyedea-io/syncano-socket-mailgun/tree/master)\n![Codecov branch](https://img.shields.io/codecov/c/github/eyedea-io/syncano-socket-mailgun/master.svg)\n[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)\n[![npm](https://img.shields.io/npm/dw/@eyedea-sockets/mailgun.svg)](https://www.npmjs.com/package/@eyedea-sockets/)\n![license](https://img.shields.io/github/license/eyedea-io/syncano-socket-mailgun.svg)\n\nMain Socket features:\n\n* **mailgun/send** — send e-mail\n* **mailgun/webhook** — webhook for receiving e-mails via Mailgun\n\n## Getting Started\n\nInstall package in your project:\n\n```sh\ncd my_project\nnpm install @syncano/cli --save-dev\nnpm install @eyedea-sockets/mailgun --save\nnpx s deploy\n```\n\nUse it:\n\n```js\nimport Syncano from '@syncano/client'\n\nconst s = new Syncano(\u003cinstaneName\u003e)\n\n// E-mail params\nconst params = {\n  to: 'john.doe@example.com'\n  from: 'App admin \u003cexample@app.com\u003e'\n  subject: 'My awesome subject'\n  html: '\u003ch1\u003eEmail title\u003c/h1\u003e\u003cp\u003eHello\u003c/p\u003e'\n}\nconst sendStatus = await s.post('mailgun/send', params)\n\n```\n\n## Endpoints\n\n### mailgun/send\n\n#### Input:\n\n| Parameter | Type   | Description          | Example                            |\n|-----------|--------|----------------------|------------------------------------|\n| to        | string | Message recipient    | `john.doe@example.com`             |\n| from      | string | Message sender       | `App admin \u003cexample@app.com\u003e`      |\n| subject   | string | Message subject      | `My awesome subject`               |\n| html      | string | Message body in HTML | `\u003ch1\u003eEmail title\u003c/h1\u003e\u003cp\u003eHello\u003c/p\u003e` |\n\n#### Outputs:\n\n**success** - **Operation Successful**\n\n- Code: 200\n- Mimetype: application/json\n\n| Parameter | Type   | Description        | Example              |\n|-----------|--------|--------------------|----------------------|\n| message   | string | Success message    | `Message sent.`      |\n\n\n**fail** - **Operation failed**\n\n- Code: 400\n- Mimetype: application/json\n\n| Parameter | Type   | Description            | Example              |\n|-----------|--------|------------------------|----------------------|\n| message   | string | Invitation failed      | `Internal error.`    |\n\n### mailgun/webhook\n\n#### Input:\n\nMailgun E-mail message payload. For more info check section \"Parsed Messages Parameters\" of Mailgun docs:\nhttps://documentation.mailgun.com/en/latest/user_manual.html#receiving-forwarding-and-storing-messages\n\n#### Outputs:\n\n**success** - **Operation Successful**\n\n- Code: 204\n- Mimetype: application/json\n\n**fail** - **Operation failed**\n\n- Code: 400\n- Mimetype: application/json\n\n| Parameter | Type   | Description            | Example           |\n|-----------|--------|------------------------|-------------------|\n| message   | string | Operation failed       | `Internal error.` |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feyedea-io%2Fsyncano-socket-mailgun","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Feyedea-io%2Fsyncano-socket-mailgun","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feyedea-io%2Fsyncano-socket-mailgun/lists"}