{"id":21152109,"url":"https://github.com/mailjet/mailjet-apiv3-nodejs-es2015","last_synced_at":"2025-07-09T09:32:23.401Z","repository":{"id":66340195,"uuid":"41359187","full_name":"mailjet/mailjet-apiv3-nodejs-es2015","owner":"mailjet","description":"[API v3] Official Mailjet API v3 NodeJS wrapper (EcmaScript 2015 experimental version)","archived":false,"fork":false,"pushed_at":"2015-08-28T11:28:44.000Z","size":152,"stargazers_count":5,"open_issues_count":0,"forks_count":4,"subscribers_count":13,"default_branch":"master","last_synced_at":"2024-03-25T21:30:07.848Z","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":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mailjet.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}},"created_at":"2015-08-25T11:16:26.000Z","updated_at":"2019-01-22T16:56:49.000Z","dependencies_parsed_at":"2023-02-20T02:45:47.127Z","dependency_job_id":null,"html_url":"https://github.com/mailjet/mailjet-apiv3-nodejs-es2015","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/mailjet%2Fmailjet-apiv3-nodejs-es2015","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mailjet%2Fmailjet-apiv3-nodejs-es2015/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mailjet%2Fmailjet-apiv3-nodejs-es2015/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mailjet%2Fmailjet-apiv3-nodejs-es2015/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mailjet","download_url":"https://codeload.github.com/mailjet/mailjet-apiv3-nodejs-es2015/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225532839,"owners_count":17484146,"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-11-20T10:24:56.852Z","updated_at":"2024-11-20T10:24:57.456Z","avatar_url":"https://github.com/mailjet.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n[mailjet]: http://www.mailjet.com\n[api_credential]: https://app.mailjet.com/account/api_keys\n[eventemitter]: https://nodejs.org/api/events.html\n[doc]: http://dev.mailjet.com/\n[stable]: https://github.com/mailjet/mailjet-apiv3-nodejs\n\n![alt text](http://cdn.appstorm.net/web.appstorm.net/files/2012/02/mailjet_logo_200x200.png \"Mailjet\")\n\n# Mailjet EcmaScript2015 Wrapper\n\nPlease welcome the new [Mailjet][mailjet] experimental EcmaScript API wrapper!\nIf you want a Stable ES5 version, click [Here][stable]\n\nIt is basically a translation, implementing the new EcmaScript specifications.\n\n[Mailjet][mailjet] is an Email Service Provider (ESP). Visit the website and get comfortable!\n\nFor more details, see the full [API Documentation][doc]\n\n## Getting started\n\nfirst, create a project folder\n\n`mkdir mailjet-project \u0026\u0026 cd $_`\n\n### Installation\n\nif you want to get a global installation, you can add `-g`\n\n`npm install mailjet-next`\n\n\n\n### Show me the code\n\nTo authenticate, go get your API key, and API secret [here][api_credential],\nopen your favorite text editor and import the mailjet module\n\n``` javascript\n\nimport MailjetClient from 'mailjet-next';\n\nlet mailjet = new Mailjet('apiKey', 'apiSecret');\n\n```\n\n### Get cosy with Mailjet\n\n\n#### Save your `API_KEY` and `API_SECRET`:\n\n`echo 'export MJ_APIKEY_PUBLIC=MY_API_KEY' \u003e\u003e ~/.zshrc`\n\n`echo 'export MJ_APIKEY_PRIVATE=MY_API_SECRET' \u003e\u003e ~/.zshrc`\n\n`source ~/.zshrc`\n\nreplace `zshrc` with `bash_profile` if you are simply using bash\n\n#### And use it in your projects\n\n``` javascript\n\nconst apiKey = process.env.MJ_APIKEY_PUBLIC;\nconst apiSecret = process.env.MJ_APIKEY_PRIVATE;\n\n```\n\n### Store a Mailjet resource\n\n``` javascript\n\n// GET resource\nlet user = Mailjet.get('user');\n\n// POST resource\nlet sender = Mailjet.post('sender');\n\n```\n\n### Request your resource with a callback function\n\n``` javascript\n\nuser.request((error, response, body) =\u003e {\n\tif (error)\n\t\tconsole.log (`Oops, something went wrong ${response.statusCode}`);\n\telse\n\t\tconsole.log (body);\n});\n\n```\n\n### Make the same request with a Promise\n\nthe request method actually returns a [EventEmitter][eventemitter] triggering `success` and `error`\n\n``` javascript\n\nuser.request()\n\t.then((response) =\u003e {\n\n\t}, (error) =\u003e {\n\n\t});\n\n```\n\n### Pass data to your requests\n\n``` javascript\n\nsender\n\t.request({ Email: 'mr@mailjet.com' })\n\t.then(handleData, handleError);\n\n```\n\n### Pass parameters as well as a callback\n\n``` javascript\n\nlet getContacts = Mailjet.get('contact');\n\ngetContacts.request({Limit: 3}, handleContacts);\n\n```\n\n### Request a resource with an ID\n\n``` javascript\n\ngetContacts\n\t.id(2)\n\t.request(handleSingleContact);\n\n````\n\n### Request a ressource with an Action\n\n``` javascript\n\nvar postContact = Mailjet.post('contact');\n\npostContact.action('managemanycontacts')\n\t.request({ContactLists, Contacts})\n\t.then(handleData, handleError);\n\n```\n\n### Send an Email\n\n``` javascript\n\nvar sendEmail = Mailjet.post('send');\n\nvar emailData = {\n    'FromEmail': 'my@email.com',\n    'FromName': 'My Name',\n    'Subject': 'Test with the NodeJS Mailjet wrapper',\n    'Text-part': 'Hello NodeJs !',\n    'Recipients': [{'Email': 'roger@smith.com'}],\n}\n\nsendEmail\n\t.request(emailData)\n    .then(handleData, handleError);\n\n```\n\n### Send two Emails\n\n``` javascript\n\nvar emailData = {\n    'FromEmail': 'gbadi@student.42.fr',\n    'FromName': 'Guillaume badi',\n    'Subject': 'Coucou Mailjet2',\n    'Text-part': 'Hello World2',\n    'Recipients': [{'Email': 'gbadi@mailjet.com'}],\n}\n\nvar emailData2 = emailData;\nemailData2['Text-part'] = 'This is another Email';\n\nsendEmail\n\t.request(emailData)\n    .then(handleData, handleError);\n\nsendEmail\n\t.request(emailData2)\n    .then(handleData, handleError);\n\n```\n\n## Contribute\n\nMailjet loves developers. You can be part of this project!\n\nThis wrapper is a great introduction to the open source world, check out the code!\n\nFeel free to ask anything, and contribute:\n\n- Fork the project.\n- Create a new branch.\n- Implement your feature or bug fix.\n- Add documentation to it.\n- Commit, push, open a pull request and voila.\n\nTODO:\n\n- Add compatibility with `duplicatefrom` filter\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmailjet%2Fmailjet-apiv3-nodejs-es2015","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmailjet%2Fmailjet-apiv3-nodejs-es2015","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmailjet%2Fmailjet-apiv3-nodejs-es2015/lists"}