{"id":17647591,"url":"https://github.com/hunteroi/discord-mailbox","last_synced_at":"2026-03-15T07:16:48.171Z","repository":{"id":41491694,"uuid":"327664528","full_name":"HunteRoi/discord-mailbox","owner":"HunteRoi","description":"A simple framework to easily add a mailbox inside your bot with DiscordJS.","archived":false,"fork":false,"pushed_at":"2024-06-20T02:52:21.000Z","size":14895,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-05-07T05:49:28.864Z","etag":null,"topics":["bot","discordjs","mailbox","modmail"],"latest_commit_sha":null,"homepage":"https://hunteroi.github.io/discord-mailbox","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/HunteRoi.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","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,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["hunteroi"],"patreon":null,"open_collective":"hunteroi","ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2021-01-07T16:19:53.000Z","updated_at":"2024-07-26T02:16:21.000Z","dependencies_parsed_at":"2024-04-10T17:56:34.917Z","dependency_job_id":"127cc05d-2b04-4020-90c6-c6613697db32","html_url":"https://github.com/HunteRoi/discord-mailbox","commit_stats":{"total_commits":32,"total_committers":3,"mean_commits":"10.666666666666666","dds":0.40625,"last_synced_commit":"40e149e6f465ac006f016bda4243a082164874af"},"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HunteRoi%2Fdiscord-mailbox","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HunteRoi%2Fdiscord-mailbox/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HunteRoi%2Fdiscord-mailbox/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HunteRoi%2Fdiscord-mailbox/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/HunteRoi","download_url":"https://codeload.github.com/HunteRoi/discord-mailbox/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252823693,"owners_count":21809709,"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":["bot","discordjs","mailbox","modmail"],"created_at":"2024-10-23T11:13:57.479Z","updated_at":"2026-03-15T07:16:48.119Z","avatar_url":"https://github.com/HunteRoi.png","language":"TypeScript","funding_links":["https://github.com/sponsors/hunteroi","https://opencollective.com/hunteroi"],"categories":[],"sub_categories":[],"readme":"\u003ca href=\"https://www.npmjs.com/@hunteroi/discord-mailbox\"\u003e\u003cimg src=\"https://img.shields.io/github/v/release/hunteroi/discord-mailbox?style=for-the-badge\" alt=\"release version\"/\u003e\u003c/a\u003e\n\u003ca href=\"https://www.npmjs.com/@hunteroi/discord-mailbox\"\u003e\u003cimg src=\"https://img.shields.io/npm/dt/@hunteroi/discord-mailbox?style=for-the-badge\" alt=\"nb downloads npm\"/\u003e\u003c/a\u003e\n\n# Discord Mailbox\n\nDiscord Mailbox is a framework to easily add a mailbox inside your bot. The feature is also fully customizable.\n\n- Supports multiple tickets per users\n- Logs everything like you want it\n- Emits events like `ticketCreate`, `ticketUpdate` and **8 more**\n- Allow full customization of the embed (you can add image, thumbnail, etc)\n- And much more!\n\n![v3 example](https://raw.githubusercontent.com/HunteRoi/discord-mailbox/master/assets/v3_example.gif)\n\nSee [./examples/index.js](https://github.com/hunteroi/discord-mailbox/tree/master/examples/index.js). If you want to try this example, you need to send `createTicket` in your bot's DM.\n\n## Prerequisites ⚠️\n\nStarting at **v2.0.0**, you must use **NodeJS v16.6.0 or higher** to run a bot with this library.\n\nYou also must not forget to include [mandatory intents and partials](#mandatory-intents-and-partials) as well as give your bot the rights to read messages.\n\n### Mandatory intents and partials\n\n- GUILDS: used to access guild content such as channels.\n- GUILD_MESSAGES: used to read guild messages.\n- GUILD_MESSAGE_REACTIONS: used to access guild messages reactions.\n- DIRECT_MESSAGES: used to access direct messages to the bot.\n- CHANNEL: used to receive events when the bot is DMed.\n- MESSAGE: used to read the messages even if incomplete.\n\n## Installation\n\n```sh\nnpm install --save @hunteroi/discord-mailbox\n```\n\n## Events\n\n```ts\nmanager.on(MailboxManagerEvents.ticketCreate, (ticket: Ticket) =\u003e {});\n\nmanager.on(MailboxManagerEvents.ticketUpdate, (ticket: Ticket) =\u003e {});\n\nmanager.on(MailboxManagerEvents.ticketLog, (ticket: Ticket) =\u003e {});\n\nmanager.on(MailboxManagerEvents.ticketClose, (ticket: Ticket) =\u003e {});\n\nmanager.on(MailboxManagerEvents.ticketForceClose, (ticket: Ticket, user: User | PartialUser) =\u003e {});\n\nmanager.on(MailboxManagerEvents.ticketDelete, (ticket: Ticket) =\u003e {});\n\nmanager.on(MailboxManagerEvents.replySent, (message: Message, answer: Message) =\u003e {});\n\nmanager.on(MailboxManagerEvents.replyDelete, (message: Message) =\u003e {});\n\nmanager.on(MailboxManagerEvents.threadCreate, (ticket: Ticket, thread: ThreadChannel) =\u003e {});\n\nmanager.on(MailboxManagerEvents.threadArchive, (ticket: Ticket, thread: ThreadChannel) =\u003e {});\n```\n\n## Contribution\n\nContributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.\n\n1. Fork the Project\n2. Create your Branch: `git checkout -b patch/YourAmazingWork`\n3. Commit your Changes: `git commit -m 'Add some amazing work'`\n4. Push to the Branch: `git push origin patch/YourAmazingWork`\n5. Open a Pull Request\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhunteroi%2Fdiscord-mailbox","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhunteroi%2Fdiscord-mailbox","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhunteroi%2Fdiscord-mailbox/lists"}