{"id":18444689,"url":"https://github.com/casperklein/docker-mailserver-mailctl","last_synced_at":"2025-04-07T23:33:12.561Z","repository":{"id":129362554,"uuid":"252870888","full_name":"casperklein/docker-mailserver-mailctl","owner":"casperklein","description":"mailctl is a script to easily interact with docker-mailserver","archived":false,"fork":false,"pushed_at":"2024-08-11T20:04:29.000Z","size":23,"stargazers_count":6,"open_issues_count":0,"forks_count":1,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-08-11T23:36:13.180Z","etag":null,"topics":["bash","bash-completion","bash-script","docker","docker-mailserver"],"latest_commit_sha":null,"homepage":"","language":"Shell","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/casperklein.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":"2020-04-04T00:09:14.000Z","updated_at":"2024-08-11T20:03:30.000Z","dependencies_parsed_at":"2023-12-19T06:49:17.242Z","dependency_job_id":"56ed3be3-3681-493a-af74-bb7f868ceb99","html_url":"https://github.com/casperklein/docker-mailserver-mailctl","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/casperklein%2Fdocker-mailserver-mailctl","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/casperklein%2Fdocker-mailserver-mailctl/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/casperklein%2Fdocker-mailserver-mailctl/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/casperklein%2Fdocker-mailserver-mailctl/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/casperklein","download_url":"https://codeload.github.com/casperklein/docker-mailserver-mailctl/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223297245,"owners_count":17121977,"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":["bash","bash-completion","bash-script","docker","docker-mailserver"],"created_at":"2024-11-06T07:03:23.819Z","updated_at":"2024-11-06T07:03:24.366Z","avatar_url":"https://github.com/casperklein.png","language":"Shell","readme":"# mailctl\n\nmailctl is a script to easily interact with [docker-mailserver](https://github.com/docker-mailserver/docker-mailserver/).\n\n## Installation\n\n1. Download `mailctl`\n\n       curl -o mailctl https://raw.githubusercontent.com/casperklein/docker-mailserver-mailctl/master/mailctl\n\n1. Make `mailctl` executable\n\n       chmod a+x mailctl\n\n1. Change setup variables to your needs in `mailctl`\n\n   **Example**:\n\n       DIR=/mail       # docker-compose directory\n       CONTAINER=mail  # docker container name\n       TIMEOUT=3600    # a lot of time for a graceful container stop\n\n## Bash Completion\n\nIf the `bash-completion` package is installed, mailctl completion can be loaded automatically:\n\n       curl -o /usr/share/bash-completion/completions/mailctl https://raw.githubusercontent.com/casperklein/docker-mailserver-mailctl/master/mailctl-completion.bash\n\nAlternatively you can source the completion file:\n\n1. Download:\n\n       curl -o mailctl-completion.bash https://raw.githubusercontent.com/casperklein/docker-mailserver-mailctl/master/mailctl-completion.bash\n\n2. Source `mailctl-completion.bash` in your `~/.bashrc`\n\n       source /path/to/mailctl-completion.bash\n\n## Usage\n\n    mailctl status                           Show status\n    mailctl config                           Show configuration\n    mailctl start                            Start container\n    mailctl stop                             Stop container\n    mailctl restart                          Restart container\n    mailctl setup                            Invoke 'setup.sh'\n    mailctl queue                            Show mail queue\n    mailctl flush                            Flush mail queue\n    mailctl view   \u003cqueue id\u003e                Show mail by queue id\n    mailctl unhold \u003cqueue id\u003e [\u003cqueue id\u003e]   Release mail that was put \"on hold\" (marked with '!')\n    mailctl unhold ALL                       Release all mails that were put \"on hold\" (marked with '!')\n    mailctl delete \u003cqueue id\u003e [\u003cqueue id\u003e]   Delete mail from queue\n    mailctl delete ALL                       Delete all mails from queue\n    mailctl fail2ban [\u003cban|unban\u003e \u003cIP\u003e]      Interact with fail2ban\n    mailctl ports                            Show published ports\n    mailctl postconf                         Show postfix configuration\n    mailctl logs [-f]                        Show logs. Use -f to 'follow' the logs\n    mailctl login                            Run container shell\n    mailctl supervisor                       Interact with supervisorctl\n    mailctl update-check                     Check for container package updates\n    mailctl update-packages                  Update container packages\n    mailctl versions                         Show versions\n\n## Example\n\n`mailctl status`\n\n    Container:    Up 48 hours (healthy)\n\n    Version:      12.0.0\n\n    Fail2ban:     No IPs have been banned\n\n    Packages:     All packages are up to date.\n\n    Ports:        25/tcp -\u003e 0.0.0.0:25\n                  465/tcp -\u003e 0.0.0.0:465\n                  993/tcp -\u003e 0.0.0.0:993\n                  995/tcp -\u003e 0.0.0.0:995\n\n    Postfix:      Mail queue is empty\n\n    Supervisor:   amavis                           RUNNING   pid 2999, uptime 17:32:37\n                  cron                             RUNNING   pid 2913, uptime 2 days, 2:11:34\n                  dovecot                          RUNNING   pid 2920, uptime 2 days, 2:11:34\n                  fail2ban                         RUNNING   pid 2192, uptime 2 days, 2:11:34\n                  mailserver                       RUNNING   pid 24,   uptime 2 days, 2:11:39\n                  opendkim                         RUNNING   pid 2923, uptime 2 days, 2:11:34\n                  opendmarc                        RUNNING   pid 2935, uptime 2 days, 2:11:33\n                  postfix                          RUNNING   pid 2942, uptime 2 days, 2:11:33\n                  rsyslog                          RUNNING   pid 2915, uptime 2 days, 2:11:36\n                  changedetector                   RUNNING   pid 2916, uptime 2 days, 2:11:34\n                  update-check                     RUNNING   pid 2917, uptime 2 days, 2:11:35\n                  clamav                           STOPPED   Not started\n                  fetchmail                        STOPPED   Not started\n                  postgrey                         STOPPED   Not started\n                  postsrsd                         STOPPED   Not started\n                  saslauthd_ldap                   STOPPED   Not started\n                  saslauthd_mysql                  STOPPED   Not started\n                  saslauthd_pam                    STOPPED   Not started\n                  saslauthd_rimap                  STOPPED   Not started\n                  saslauthd_shadow                 STOPPED   Not started\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcasperklein%2Fdocker-mailserver-mailctl","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcasperklein%2Fdocker-mailserver-mailctl","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcasperklein%2Fdocker-mailserver-mailctl/lists"}