{"id":18990795,"url":"https://github.com/mailslurp/mailslurp-cli","last_synced_at":"2026-04-14T05:30:21.136Z","repository":{"id":77779147,"uuid":"204936258","full_name":"mailslurp/mailslurp-cli","owner":"mailslurp","description":null,"archived":false,"fork":false,"pushed_at":"2020-04-27T10:56:21.000Z","size":315,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-01T14:43:06.523Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","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/mailslurp.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,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-08-28T13:17:57.000Z","updated_at":"2020-04-27T10:56:24.000Z","dependencies_parsed_at":"2023-04-16T10:01:10.237Z","dependency_job_id":null,"html_url":"https://github.com/mailslurp/mailslurp-cli","commit_stats":null,"previous_names":[],"tags_count":20,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mailslurp%2Fmailslurp-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mailslurp%2Fmailslurp-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mailslurp%2Fmailslurp-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mailslurp%2Fmailslurp-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mailslurp","download_url":"https://codeload.github.com/mailslurp/mailslurp-cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240002229,"owners_count":19732165,"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-08T17:11:29.296Z","updated_at":"2026-04-14T05:30:21.086Z","avatar_url":"https://github.com/mailslurp.png","language":"Shell","readme":"# MailSlurp API Bash client\n\n## Overview\n\nThis is a Bash client script for accessing MailSlurp API service.\n\nThe script uses cURL underneath for making all REST calls.\n\n## Usage\n\n```shell\n# Make sure the script has executable rights\n$ chmod u+x mailslurp\n\n# Print the list of operations available on the service\n$ ./mailslurp -h\n\n# Print the service description\n$ ./mailslurp --about\n\n# Print detailed information about specific operation\n$ ./mailslurp \u003coperationId\u003e -h\n\n# Make GET request\n./mailslurp --host http://\u003chostname\u003e:\u003cport\u003e --accept xml \u003coperationId\u003e \u003cqueryParam1\u003e=\u003cvalue1\u003e \u003cheader_key1\u003e:\u003cheader_value2\u003e\n\n# Make GET request using arbitrary curl options (must be passed before \u003coperationId\u003e) to an SSL service using username:password\nmailslurp -k -sS --tlsv1.2 --host https://\u003chostname\u003e -u \u003cuser\u003e:\u003cpassword\u003e --accept xml \u003coperationId\u003e \u003cqueryParam1\u003e=\u003cvalue1\u003e \u003cheader_key1\u003e:\u003cheader_value2\u003e\n\n# Make POST request\n$ echo '\u003cbody_content\u003e' | mailslurp --host \u003chostname\u003e --content-type json \u003coperationId\u003e -\n\n# Make POST request with simple JSON content, e.g.:\n# {\n#   \"key1\": \"value1\",\n#   \"key2\": \"value2\",\n#   \"key3\": 23\n# }\n$ echo '\u003cbody_content\u003e' | mailslurp --host \u003chostname\u003e --content-type json \u003coperationId\u003e key1==value1 key2=value2 key3:=23 -\n\n# Preview the cURL command without actually executing it\n$ mailslurp --host http://\u003chostname\u003e:\u003cport\u003e --dry-run \u003coperationid\u003e\n\n```\n\n## Docker image\n\nYou can easily create a Docker image containing a preconfigured environment\nfor using the REST Bash client including working autocompletion and short\nwelcome message with basic instructions, using the generated Dockerfile:\n\n```shell\ndocker build -t my-rest-client .\ndocker run -it my-rest-client\n```\n\nBy default you will be logged into a Zsh environment which has much more\nadvanced auto completion, but you can switch to Bash, where basic autocompletion\nis also available.\n\n## Shell completion\n\n### Bash\n\nThe generated bash-completion script can be either directly loaded to the current Bash session using:\n\n```shell\nsource mailslurp.bash-completion\n```\n\nAlternatively, the script can be copied to the `/etc/bash-completion.d` (or on OSX with Homebrew to `/usr/local/etc/bash-completion.d`):\n\n```shell\nsudo cp mailslurp.bash-completion /etc/bash-completion.d/mailslurp\n```\n\n#### OS X\n\nOn OSX you might need to install bash-completion using Homebrew:\n\n```shell\nbrew install bash-completion\n```\n\nand add the following to the `~/.bashrc`:\n\n```shell\nif [ -f $(brew --prefix)/etc/bash_completion ]; then\n  . $(brew --prefix)/etc/bash_completion\nfi\n```\n\n### Zsh\n\nIn Zsh, the generated `_mailslurp` Zsh completion file must be copied to one of the folders under `$FPATH` variable.\n\n## Documentation for API Endpoints\n\nAll URIs are relative to **\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*AliasControllerApi* | [**createAlias**](docs/AliasControllerApi.md#createalias) | **POST** /aliases | Create an email alias\n*AliasControllerApi* | [**createAnonymousAlias**](docs/AliasControllerApi.md#createanonymousalias) | **POST** /aliases/anonymous | Create an anonymous email alias\n*AliasControllerApi* | [**deleteAlias**](docs/AliasControllerApi.md#deletealias) | **DELETE** /aliases/{aliasId} | Delete an owned alias\n*AliasControllerApi* | [**getAlias**](docs/AliasControllerApi.md#getalias) | **GET** /aliases/{aliasId} | Get an email alias\n*AliasControllerApi* | [**getAliases**](docs/AliasControllerApi.md#getaliases) | **GET** /aliases | Get all email aliases\n*AliasControllerApi* | [**updateAlias**](docs/AliasControllerApi.md#updatealias) | **PUT** /aliases/{aliasId} | Update an owned alias\n*AttachmentControllerApi* | [**uploadAttachment**](docs/AttachmentControllerApi.md#uploadattachment) | **POST** /attachments | Upload an attachment for sending\n*AttachmentControllerApi* | [**uploadMultipartForm**](docs/AttachmentControllerApi.md#uploadmultipartform) | **POST** /attachments/multipart | Upload an attachment for sending using Multipart Form\n*BulkActionsControllerApi* | [**bulkCreateInboxes**](docs/BulkActionsControllerApi.md#bulkcreateinboxes) | **POST** /bulk/inboxes | Bulk create Inboxes (email addresses)\n*BulkActionsControllerApi* | [**bulkDeleteInboxes**](docs/BulkActionsControllerApi.md#bulkdeleteinboxes) | **DELETE** /bulk/inboxes | Bulk Delete Inboxes\n*BulkActionsControllerApi* | [**bulkSendEmails**](docs/BulkActionsControllerApi.md#bulksendemails) | **POST** /bulk/send | Bulk Send Emails\n*CommonActionsControllerApi* | [**createNewEmailAddress**](docs/CommonActionsControllerApi.md#createnewemailaddress) | **POST** /createInbox | Create new random inbox\n*CommonActionsControllerApi* | [**createNewEmailAddress1**](docs/CommonActionsControllerApi.md#createnewemailaddress1) | **POST** /newEmailAddress | Create new random inbox\n*CommonActionsControllerApi* | [**emptyInbox**](docs/CommonActionsControllerApi.md#emptyinbox) | **DELETE** /emptyInbox | Delete all emails in an inbox\n*CommonActionsControllerApi* | [**sendEmailSimple**](docs/CommonActionsControllerApi.md#sendemailsimple) | **POST** /sendEmail | Send an email\n*ContactControllerApi* | [**createContact**](docs/ContactControllerApi.md#createcontact) | **POST** /contacts | Create a contact\n*ContactControllerApi* | [**deleteContact**](docs/ContactControllerApi.md#deletecontact) | **DELETE** /contacts/{contactId} | Delete contact\n*ContactControllerApi* | [**getAllContacts**](docs/ContactControllerApi.md#getallcontacts) | **GET** /contacts/paginated | Get all contacts\n*ContactControllerApi* | [**getContact**](docs/ContactControllerApi.md#getcontact) | **GET** /contacts/{contactId} | Get contact\n*ContactControllerApi* | [**getContacts**](docs/ContactControllerApi.md#getcontacts) | **GET** /contacts | Get all contacts\n*DomainControllerApi* | [**createDomain**](docs/DomainControllerApi.md#createdomain) | **POST** /domains | Create Domain\n*DomainControllerApi* | [**deleteDomain**](docs/DomainControllerApi.md#deletedomain) | **DELETE** /domains/{id} | Delete a domain\n*DomainControllerApi* | [**getDomain**](docs/DomainControllerApi.md#getdomain) | **GET** /domains/{id} | Get a domain\n*DomainControllerApi* | [**getDomains**](docs/DomainControllerApi.md#getdomains) | **GET** /domains | Get domains\n*EmailControllerApi* | [**deleteAllEmails**](docs/EmailControllerApi.md#deleteallemails) | **DELETE** /emails | Delete all emails\n*EmailControllerApi* | [**deleteEmail**](docs/EmailControllerApi.md#deleteemail) | **DELETE** /emails/{emailId} | Delete an email\n*EmailControllerApi* | [**downloadAttachment**](docs/EmailControllerApi.md#downloadattachment) | **GET** /emails/{emailId}/attachments/{attachmentId} | Get email attachment bytes\n*EmailControllerApi* | [**forwardEmail**](docs/EmailControllerApi.md#forwardemail) | **POST** /emails/{emailId}/forward | Forward email\n*EmailControllerApi* | [**getAttachmentMetaData**](docs/EmailControllerApi.md#getattachmentmetadata) | **GET** /emails/{emailId}/attachments/{attachmentId}/metadata | Get email attachment metadata\n*EmailControllerApi* | [**getAttachments**](docs/EmailControllerApi.md#getattachments) | **GET** /emails/{emailId}/attachments | Get all email attachment metadata\n*EmailControllerApi* | [**getEmail**](docs/EmailControllerApi.md#getemail) | **GET** /emails/{emailId} | Get email content\n*EmailControllerApi* | [**getEmailHTML**](docs/EmailControllerApi.md#getemailhtml) | **GET** /emails/{emailId}/html | Get email content as HTML\n*EmailControllerApi* | [**getEmailsPaginated**](docs/EmailControllerApi.md#getemailspaginated) | **GET** /emails | Get all emails\n*EmailControllerApi* | [**getRawEmailContents**](docs/EmailControllerApi.md#getrawemailcontents) | **GET** /emails/{emailId}/raw | Get raw email string\n*EmailControllerApi* | [**getRawEmailJson**](docs/EmailControllerApi.md#getrawemailjson) | **GET** /emails/{emailId}/raw/json | Get raw email in JSON\n*EmailControllerApi* | [**getUnreadEmailCount**](docs/EmailControllerApi.md#getunreademailcount) | **GET** /emails/unreadCount | Get unread email count\n*EmailControllerApi* | [**validateEmail**](docs/EmailControllerApi.md#validateemail) | **POST** /emails/{emailId}/validate | Validate email\n*FormControllerApi* | [**submitForm**](docs/FormControllerApi.md#submitform) | **POST** /forms | Submit a form to be parsed and sent as an email to an address determined by the form fields\n*GroupControllerApi* | [**addContactsToGroup**](docs/GroupControllerApi.md#addcontactstogroup) | **PUT** /groups/{groupId}/contacts | Add contacts to a group\n*GroupControllerApi* | [**createGroup**](docs/GroupControllerApi.md#creategroup) | **POST** /groups | Create a group\n*GroupControllerApi* | [**deleteGroup**](docs/GroupControllerApi.md#deletegroup) | **DELETE** /groups/{groupId} | Delete group\n*GroupControllerApi* | [**getAllGroups**](docs/GroupControllerApi.md#getallgroups) | **GET** /groups/paginated | Get all Contact Groups in paginated format\n*GroupControllerApi* | [**getGroup**](docs/GroupControllerApi.md#getgroup) | **GET** /groups/{groupId} | Get group\n*GroupControllerApi* | [**getGroupWithContacts**](docs/GroupControllerApi.md#getgroupwithcontacts) | **GET** /groups/{groupId}/contacts | Get group and contacts belonging to it\n*GroupControllerApi* | [**getGroups**](docs/GroupControllerApi.md#getgroups) | **GET** /groups | Get all groups\n*GroupControllerApi* | [**removeContactsFromGroup**](docs/GroupControllerApi.md#removecontactsfromgroup) | **DELETE** /groups/{groupId}/contacts | Remove contacts from a group\n*InboxControllerApi* | [**createInbox**](docs/InboxControllerApi.md#createinbox) | **POST** /inboxes | Create an Inbox (email address)\n*InboxControllerApi* | [**deleteAllInboxes**](docs/InboxControllerApi.md#deleteallinboxes) | **DELETE** /inboxes | Delete all inboxes\n*InboxControllerApi* | [**deleteInbox**](docs/InboxControllerApi.md#deleteinbox) | **DELETE** /inboxes/{inboxId} | Delete inbox\n*InboxControllerApi* | [**getAllInboxes**](docs/InboxControllerApi.md#getallinboxes) | **GET** /inboxes/paginated | List Inboxes Paginated\n*InboxControllerApi* | [**getEmails**](docs/InboxControllerApi.md#getemails) | **GET** /inboxes/{inboxId}/emails | Get emails in an Inbox\n*InboxControllerApi* | [**getInbox**](docs/InboxControllerApi.md#getinbox) | **GET** /inboxes/{inboxId} | Get Inbox\n*InboxControllerApi* | [**getInboxEmailsPaginated**](docs/InboxControllerApi.md#getinboxemailspaginated) | **GET** /inboxes/{inboxId}/emails/paginated | Get inbox emails paginated\n*InboxControllerApi* | [**getInboxTags**](docs/InboxControllerApi.md#getinboxtags) | **GET** /inboxes/tags | Get inbox tags\n*InboxControllerApi* | [**getInboxes**](docs/InboxControllerApi.md#getinboxes) | **GET** /inboxes | List Inboxes / Email Addresses\n*InboxControllerApi* | [**sendEmail**](docs/InboxControllerApi.md#sendemail) | **POST** /inboxes/{inboxId} | Send Email\n*InboxControllerApi* | [**setInboxFavourited**](docs/InboxControllerApi.md#setinboxfavourited) | **PUT** /inboxes/{inboxId}/favourite | Set inbox favourited state\n*InboxControllerApi* | [**updateInbox**](docs/InboxControllerApi.md#updateinbox) | **PATCH** /inboxes/{inboxId} | Update Inbox\n*TemplateControllerApi* | [**createTemplate**](docs/TemplateControllerApi.md#createtemplate) | **POST** /templates | Create a Template\n*TemplateControllerApi* | [**deleteTemplate**](docs/TemplateControllerApi.md#deletetemplate) | **DELETE** /templates/{TemplateId} | Delete Template\n*TemplateControllerApi* | [**getAllTemplates**](docs/TemplateControllerApi.md#getalltemplates) | **GET** /templates/paginated | Get all Templates in paginated format\n*TemplateControllerApi* | [**getTemplate**](docs/TemplateControllerApi.md#gettemplate) | **GET** /templates/{TemplateId} | Get Template\n*TemplateControllerApi* | [**getTemplates**](docs/TemplateControllerApi.md#gettemplates) | **GET** /templates | Get all Templates\n*WaitForControllerApi* | [**waitFor**](docs/WaitForControllerApi.md#waitfor) | **POST** /waitFor | Wait for conditions to be met\n*WaitForControllerApi* | [**waitForEmailCount**](docs/WaitForControllerApi.md#waitforemailcount) | **GET** /waitForEmailCount | Wait for and return count number of emails\n*WaitForControllerApi* | [**waitForLatestEmail**](docs/WaitForControllerApi.md#waitforlatestemail) | **GET** /waitForLatestEmail | Fetch inbox\u0026#39;s latest email or if empty wait for an email to arrive\n*WaitForControllerApi* | [**waitForMatchingEmail**](docs/WaitForControllerApi.md#waitformatchingemail) | **POST** /waitForMatchingEmails | Wait or return list of emails that match simple matching patterns\n*WaitForControllerApi* | [**waitForNthEmail**](docs/WaitForControllerApi.md#waitfornthemail) | **GET** /waitForNthEmail | Wait for or fetch the email with a given index in the inbox specified\n*WebhookControllerApi* | [**createWebhook**](docs/WebhookControllerApi.md#createwebhook) | **POST** /inboxes/{inboxId}/webhooks | Attach a WebHook URL to an inbox\n*WebhookControllerApi* | [**deleteWebhook**](docs/WebhookControllerApi.md#deletewebhook) | **DELETE** /inboxes/{inboxId}/webhooks/{webhookId} | Delete and disable a Webhook for an Inbox\n*WebhookControllerApi* | [**getAllWebhooks**](docs/WebhookControllerApi.md#getallwebhooks) | **GET** /webhooks/paginated | List Webhooks Paginated\n*WebhookControllerApi* | [**getWebhook**](docs/WebhookControllerApi.md#getwebhook) | **GET** /webhooks/{webhookId} | Get a webhook for an Inbox\n*WebhookControllerApi* | [**getWebhooks**](docs/WebhookControllerApi.md#getwebhooks) | **GET** /inboxes/{inboxId}/webhooks | Get all Webhooks for an Inbox\n*WebhookControllerApi* | [**sendTestData**](docs/WebhookControllerApi.md#sendtestdata) | **POST** /webhooks/{webhookId}/test | Send webhook test data\n\n\n## Documentation For Models\n\n - [Alias](docs/Alias.md)\n - [AttachmentMetaData](docs/AttachmentMetaData.md)\n - [BasicAuthOptions](docs/BasicAuthOptions.md)\n - [BulkSendEmailOptions](docs/BulkSendEmailOptions.md)\n - [ContactDto](docs/ContactDto.md)\n - [ContactProjection](docs/ContactProjection.md)\n - [CreateAnonymousAliasOptions](docs/CreateAnonymousAliasOptions.md)\n - [CreateContactOptions](docs/CreateContactOptions.md)\n - [CreateDomainOptions](docs/CreateDomainOptions.md)\n - [CreateGroupOptions](docs/CreateGroupOptions.md)\n - [CreateOwnedAliasOptions](docs/CreateOwnedAliasOptions.md)\n - [CreateTemplateOptions](docs/CreateTemplateOptions.md)\n - [CreateWebhookOptions](docs/CreateWebhookOptions.md)\n - [DomainDto](docs/DomainDto.md)\n - [DomainPreview](docs/DomainPreview.md)\n - [Email](docs/Email.md)\n - [EmailAnalysis](docs/EmailAnalysis.md)\n - [EmailPreview](docs/EmailPreview.md)\n - [EmailProjection](docs/EmailProjection.md)\n - [ForwardEmailOptions](docs/ForwardEmailOptions.md)\n - [GroupContactsDto](docs/GroupContactsDto.md)\n - [GroupDto](docs/GroupDto.md)\n - [GroupProjection](docs/GroupProjection.md)\n - [HTMLValidationResult](docs/HTMLValidationResult.md)\n - [Inbox](docs/Inbox.md)\n - [InboxProjection](docs/InboxProjection.md)\n - [JsonNode](docs/JsonNode.md)\n - [MatchOption](docs/MatchOption.md)\n - [MatchOptions](docs/MatchOptions.md)\n - [Pageable](docs/Pageable.md)\n - [Page«Alias»](docs/Page«Alias».md)\n - [Page«ContactProjection»](docs/Page«ContactProjection».md)\n - [Page«EmailPreview»](docs/Page«EmailPreview».md)\n - [Page«EmailProjection»](docs/Page«EmailProjection».md)\n - [Page«GroupProjection»](docs/Page«GroupProjection».md)\n - [Page«InboxProjection»](docs/Page«InboxProjection».md)\n - [Page«TemplateProjection»](docs/Page«TemplateProjection».md)\n - [Page«WebhookProjection»](docs/Page«WebhookProjection».md)\n - [RawEmailJson](docs/RawEmailJson.md)\n - [SendEmailOptions](docs/SendEmailOptions.md)\n - [SetInboxFavouritedOptions](docs/SetInboxFavouritedOptions.md)\n - [SimpleSendEmailOptions](docs/SimpleSendEmailOptions.md)\n - [Sort](docs/Sort.md)\n - [TemplateDto](docs/TemplateDto.md)\n - [TemplateProjection](docs/TemplateProjection.md)\n - [TemplateVariable](docs/TemplateVariable.md)\n - [UnreadCount](docs/UnreadCount.md)\n - [UpdateGroupContacts](docs/UpdateGroupContacts.md)\n - [UpdateInboxOptions](docs/UpdateInboxOptions.md)\n - [UploadAttachmentOptions](docs/UploadAttachmentOptions.md)\n - [ValidationDto](docs/ValidationDto.md)\n - [ValidationMessage](docs/ValidationMessage.md)\n - [WaitForConditions](docs/WaitForConditions.md)\n - [WebhookDto](docs/WebhookDto.md)\n - [WebhookProjection](docs/WebhookProjection.md)\n - [WebhookTestRequest](docs/WebhookTestRequest.md)\n - [WebhookTestResponse](docs/WebhookTestResponse.md)\n - [WebhookTestResult](docs/WebhookTestResult.md)\n\n\n## Documentation For Authorization\n\n\n## API_KEY\n\n\n- **Type**: API key\n- **API key parameter name**: x-api-key\n- **Location**: HTTP header\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmailslurp%2Fmailslurp-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmailslurp%2Fmailslurp-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmailslurp%2Fmailslurp-cli/lists"}