{"_id":"@allseated-registry/mailinator-client","_rev":"5-1120b156b3bcfc432e168cec8128d5dd","name":"@allseated-registry/mailinator-client","dist-tags":{"latest":"1.0.4"},"versions":{"1.0.4":{"name":"@allseated-registry/mailinator-client","version":"1.0.4","keywords":["mailinator","email","inbox","message","REST-API-client"],"author":{"url":"http://manybrain.com","name":"Manybrain, LLC","email":"support@manybrain.com"},"license":"The Apache License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0.txt)","_id":"@allseated-registry/mailinator-client@1.0.4","maintainers":[{"name":"tfreifeld-allseated","email":"tamir@allseated.com"},{"name":"tomyallseated","email":"tom.y@allseated.com"},{"name":"allseated-inc","email":"jonathan@allseated.com"}],"homepage":"https://github.com/manybrain/mailinator-javascript-client","bugs":{"url":"https://github.com/manybrain/mailinator-javascript-client/issues"},"dist":{"shasum":"8735b173fa1bd4a856452d8432aa1ae0e7c58cb5","tarball":"https://registry.npmjs.org/@allseated-registry/mailinator-client/-/mailinator-client-1.0.4.tgz","fileCount":128,"integrity":"sha512-c7V1Wya8HVjRwYz62Fml/OgnVGdJuo7yHDQvM/BpGqRvJUsng9NYFnPUUsMw6F/JYZCsPa2cML/qmlh9dXuWSQ==","signatures":[{"sig":"MEUCIQDosxC53qLiF32yACuqgQ8fjU5+dcei1LqhVAKef8K/PAIgWetgeD0+7+Sx86KQywBV/7Nx05wYNmPNR2mikp3RRnY=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":52157},"main":"lib/index.js","types":"./lib/index.d.ts","gitHead":"aa7130ffbf7060a5d276ed0a71d0fc68b950c1d2","scripts":{"test":"jest","build":"tsc","prepare":"npm run build","version":"git add -A .","coverage":"jest --coverage","postversion":"git push && git push --tags"},"_npmUser":{"name":"tomyallseated","email":"tom.y@allseated.com"},"repository":{"url":"git+https://github.com/manybrain/mailinator-javascript-client.git","type":"git"},"_npmVersion":"9.2.0","description":"Mailinator REST API client for JavaScript applications.","directories":{},"_nodeVersion":"19.1.0","dependencies":{"@types/node":"^13.1.8","create-index":"^2.6.0","typed-rest-client":"^1.7.1"},"_hasShrinkwrap":false,"devDependencies":{"tmp":"^0.1.0","jest":"^24.9.0","ts-jest":"^24.3.0","typescript":"^4.9.3","@types/jest":"^24.0.25"},"_npmOperationalInternal":{"tmp":"tmp/mailinator-client_1.0.4_1685444390914_0.7118756743607293","host":"s3://npm-registry-packages"}}},"time":{"created":"2023-05-30T10:59:50.914Z","modified":"2025-09-22T04:25:36.777Z","1.0.4":"2023-05-30T10:59:51.105Z"},"bugs":{"url":"https://github.com/manybrain/mailinator-javascript-client/issues"},"author":{"url":"http://manybrain.com","name":"Manybrain, LLC","email":"support@manybrain.com"},"license":"The Apache License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0.txt)","homepage":"https://github.com/manybrain/mailinator-javascript-client","keywords":["mailinator","email","inbox","message","REST-API-client"],"repository":{"url":"git+https://github.com/manybrain/mailinator-javascript-client.git","type":"git"},"description":"Mailinator REST API client for JavaScript applications.","maintainers":[{"email":"moraru.dia.9717@gmail.com","name":"moraru_diana"},{"email":"iraklii.d@allseated.com","name":"iraklii.d"},{"email":"jonathan@allseated.com","name":"allseated-inc"},{"email":"tom.y@allseated.com","name":"tomyallseated"},{"email":"tamir@allseated.com","name":"tfreifeld-allseated"},{"email":"ACsontos@cvent.com","name":"acsontos-cvent"}],"readme":"#### [Mailinator](https://www.mailinator.com/) REST API client for JavaScript applications. \r\n\r\nUses [Microsoft's typed-rest-client](https://github.com/microsoft/typed-rest-client). All requests are async functions.\r\n\r\n#### Usage example\r\n\r\n##### Create MailinatorClient\r\n\r\n```typescript\r\nconst mailinatorClient: MailinatorClient = new MailinatorClient(\"yourApiKeyHere\");\r\n```\r\n\r\n###### Get inbox from domain\r\n\r\n```typescript\r\nconst response: IRestResponse<Inbox> = await mailinatorClient.request(\r\n            new GetInboxRequest(\"yourDomainNameHere\")\r\n        );\r\n```\r\n\r\n###### Get paginated messages from domain and inbox\r\n\r\n```typescript\r\nconst response: IRestResponse<Inbox> = await mailinatorClient.request(\r\n            new GetInboxRequest(\"yourDomainNameHere\", \"yourInboxNameHere\", 10, 20, Sort.DESC, true)\r\n        );\r\n```\r\n                                                       \r\n###### Get message\r\n             \r\n```typescript                                \r\nconst response: IRestResponse<Message> = await mailinatorClient.request(\r\n            new GetMessageRequest(\"yourDomainNameHere\", \"yourInboxNameHere\", \"yourMessageIdHere\")\r\n        );\r\n```\r\n\r\n#### Build tests\r\n\r\n* `npm test`\r\n\r\nBy default, most of the tests are skipped. \r\n\r\n##### Build with tests\r\n\r\nMost of the tests require env variables with valid values. Visit tests source code and review `EnabledIfEnvironmentVariable` wrapped parts. The more env variables you set, the more tests are run.\r\n\r\n* `MAILINATOR_TEST_API_TOKEN` - API tokens for authentication; basic requirement across many tests;see also https://manybrain.github.io/m8rdocs/#api-authentication\r\n* `MAILINATOR_TEST_DOMAIN_PRIVATE` - private domain; visit https://www.mailinator.com/\r\n* `MAILINATOR_TEST_INBOX` - some already existing inbox within the private domain\r\n* `MAILINATOR_TEST_PHONE_NUMBER` - associated phone number within the private domain; see also https://manybrain.github.io/m8rdocs/#fetch-an-sms-messages\r\n* `MAILINATOR_TEST_MESSAGE_WITH_ATTACHMENT_ID` - existing message id within inbox (see above) within private domain (see above); see also https://manybrain.github.io/m8rdocs/#fetch-message\r\n* `MAILINATOR_TEST_ATTACHMENT_ID` - existing message id within inbox (see above) within private domain (see above); see also https://manybrain.github.io/m8rdocs/#fetch-message\r\n* `MAILINATOR_TEST_DELETE_DOMAIN` - don't use it unless you are 100% sure what you are doing\r\n\r\n#### Create index\r\n\r\n* Install https://www.npmjs.com/package/create-ts-index `npm install create-ts-index -g`\r\n* Run `cti create .`\r\n","readmeFilename":"README.md"}