{"id":16939754,"url":"https://github.com/fd0/vmail","last_synced_at":"2025-04-11T19:21:32.617Z","repository":{"id":136285951,"uuid":"174298304","full_name":"fd0/vmail","owner":"fd0","description":"command-line for managing mailboxes and aliases for mail server setups based on the howto (English) (German) by Thomas Leister","archived":false,"fork":false,"pushed_at":"2022-04-24T10:31:26.000Z","size":26,"stargazers_count":6,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-25T15:14:48.808Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fd0.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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-03-07T07:57:53.000Z","updated_at":"2023-09-22T17:41:10.000Z","dependencies_parsed_at":"2023-04-09T03:35:47.554Z","dependency_job_id":null,"html_url":"https://github.com/fd0/vmail","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/fd0%2Fvmail","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fd0%2Fvmail/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fd0%2Fvmail/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fd0%2Fvmail/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fd0","download_url":"https://codeload.github.com/fd0/vmail/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248465346,"owners_count":21108244,"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-10-13T21:05:26.576Z","updated_at":"2025-04-11T19:21:32.593Z","avatar_url":"https://github.com/fd0.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"vmail - command-line tool for managing mailboxes and aliases for mail server\nsetups based on the [howto (English)](https://thomas-leister.de/en/mailserver-debian-stretch)\n([German](https://thomas-leister.de/mailserver-debian-stretch/))\nby [Thomas Leister](https://thomas-leister.de).\n\nThis one is written in Go, there's also a version in Rust here: https://github.com/awidegreen/vmail-rs\n\nRationale: I was unable to compile a static binary using Rust locally, and the\nversion available in Debian stable (stretch) was too old to build it. So I\nwrote my own version of the program in Go, which results in a static binary.\n\nBuilding\n========\n\nYou need Go \u003e= 1.16, then run the following command inside the checked-out repository:\n\n    $ go build\n\nThis will pull the needed dependencies, verify them cryptographically and build\na static binary called `vmail`.\n\nDatabase Connection\n===================\n\nThe `vmail` binary will try to connect to the MySQL socket\n`/run/mysqld/mysqld.sock` as the current user and tries to use the `vmail`\ndatabase. If you need to connect to a different database, you can pass the connection string (format described [here](https://github.com/go-sql-driver/mysql#dsn-data-source-name)) in the environment variable `$VMAIL_DB`. The format is:\n\n    [username[:password]@][protocol[(address)]]/dbname\n\nFor connecting a database on localhost via TCP with the user `foo`, the password `bar` and the database name `zzz`, use the following string:\n\n    $ export VMAIL_DB='foo:bar@tcp(localhost:3306)/zzz'\n\nManaging Domains, Mailboxes, and Aliases\n========================================\n\nCreate new domain:\n\n    $ vmail create domain example.com\n\nCreate new alias:\n\n    $ vmail create alias foo@example.com bar@otherhost.example.com\n\nAdd a new email address to an existing alias:\n\n    $ vmail create alias foo@example.com baz@otherhost.example.com\n\nCreate a mailbox:\n\n    $ vmail create mailbox admin@example.com\n    enter password:\n    repeat password:\n    mailbox admin@example.com created\n\nList a domain:\n\n    $ vmail show example.com\n     Mailbox              Quota    Enabled\n    ---------------------------------------\n     admin@example.com             true\n    ---------------------------------------\n\n     Alias              Destinations\n    ----------------------------------------------\n     foo@example.com    bar@otherhost.example.com\n                        baz@otherhost.example.com\n    ----------------------------------------------\n\nAdd a catch-all alias (mind the quotes):\n\n    $ vmail create alias '*@example.com' admin@example.com\n\nList the domain again:\n\n    $ vmail show example.com\n         Mailbox              Quota    Enabled\n    ---------------------------------------\n     admin@example.com             true\n    ---------------------------------------\n\n     Alias              Destinations\n    ----------------------------------------------\n     *@example.com      admin@example.com\n     foo@example.com    bar@otherhost.example.com\n                        baz@otherhost.example.com\n    ----------------------------------------------\n\nList all domains:\n\n    $ vmail domains\n    example.com\n\nChange the password for a mailbox:\n\n    $ vmail password admin@example.com\n    enter password:\n    repeat password:\n    password for admin@example.com updated\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffd0%2Fvmail","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffd0%2Fvmail","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffd0%2Fvmail/lists"}