A service that monitors a mailbox for messages and will automatically move them to another, usually on a different server.
Used to liberate your mail from proprietary providers that don't provide automatic forward-and-delete functionality, i.e. most of them.
MailPump has two usage modes, single, and multi. Single operates in a one-to-one fashion, i.e. One connection
to the source and one connection to the destination. Many single instances pointed at the same place can
potentially overwhelm the destination server. For this case, multi mode should be preferred. In multi mode,
multiple source servers can be specified, as well as a single destination server, thus relieving pressure on the target.
For multi-mode documentation, please see here.
NAME:
mailpump run - Run the pump
USAGE:
mailpump run [command options] [arguments...]
OPTIONS:
--batch-size value deletion batch size (default: 15) [$MAILPUMP_BATCH_SIZE]
--dest-auth-method value dest auth method (default: "LOGIN") [$MAILPUMP_DEST_AUTH_METHOD]
--dest-debug value display dest debug info (default: "persistent") [$MAILPUMP_DEST_DEBUG]
--dest-oauth2-client-id value dest oauth2 client id [$MAILPUMP_DEST_OAUTH2_CLIENT_ID]
--dest-oauth2-client-secret value dest oauth2 client secret [$MAILPUMP_DEST_OAUTH2_CLIENT_SECRET]
--dest-oauth2-provider value dest oauth2 provider (custom) (default: "custom") [$MAILPUMP_DEST_OAUTH2_PROVIDER]
--dest-oauth2-scopes value dest oauth2 scopes (accepts multiple inputs) [$MAILPUMP_DEST_OAUTH2_SCOPES]
--dest-oauth2-token-url value dest oauth2 token url [$MAILPUMP_DEST_OAUTH2_TOKEN_URL]
--dest-password value dest imap password [$MAILPUMP_DEST_PASSWORD]
--dest-password-file value dest imap password file [$MAILPUMP_DEST_PASSWORD_FILE]
--dest-tls-skip-verify skip dest tls verification (default: false) [$MAILPUMP_DEST_TLS_SKIP_VERIFY]
--dest-transport value dest imap transport (persistent, standard) (default: "persistent") [$MAILPUMP_DEST_TRANSPORT]
--dest-url value dest url [$MAILPUMP_DEST_URL]
--dest-username value dest imap username [$MAILPUMP_DEST_USERNAME]
--fetch-buffer-size value fetch buffer size (default: 20) [$MAILPUMP_FETCH_BUFFER_SIZE]
--fetch-max-interval value maximum interval between fetches. can abort IDLE (default: 5m0s) [$MAILPUMP_FETCH_MAX_INTERVAL]
--idle-fallback-interval value fallback poll interval for servers that don't support IDLE (default: 1m0s) [$MAILPUMP_IDLE_FALLBACK_INTERVAL]
--log-format value log format (text/json) (default: "text") [$MAILPUMP_LOG_FORMAT]
--log-level value log level (default: "info") [$MAILPUMP_LOG_LEVEL]
--source-auth-method value source auth method (default: "LOGIN") [$MAILPUMP_SOURCE_AUTH_METHOD]
--source-debug value display source debug info (default: "persistent") [$MAILPUMP_SOURCE_DEBUG]
--source-oauth2-client-id value source oauth2 client id [$MAILPUMP_SOURCE_OAUTH2_CLIENT_ID]
--source-oauth2-client-secret value source oauth2 client secret [$MAILPUMP_SOURCE_OAUTH2_CLIENT_SECRET]
--source-oauth2-provider value source oauth2 provider (custom) (default: "custom") [$MAILPUMP_SOURCE_OAUTH2_PROVIDER]
--source-oauth2-scopes value source oauth2 scopes (accepts multiple inputs) [$MAILPUMP_SOURCE_OAUTH2_SCOPES]
--source-oauth2-token-url value source oauth2 token url [$MAILPUMP_SOURCE_OAUTH2_TOKEN_URL]
--source-password value source imap password [$MAILPUMP_SOURCE_PASSWORD]
--source-password-file value source imap password file [$MAILPUMP_SOURCE_PASSWORD_FILE]
--source-tls-skip-verify skip source tls verification (default: false) [$MAILPUMP_SOURCE_TLS_SKIP_VERIFY]
--source-transport value source imap transport (persistent, standard) (default: "persistent") [$MAILPUMP_SOURCE_TRANSPORT]
--source-url value source url [$MAILPUMP_SOURCE_URL]
--source-username value source imap username [$MAILPUMP_SOURCE_USERNAME]
MailPump supports three authentication methods: LOGIN, PLAIN, and OAUTHBEARER, which should be passed to
the --source-auth-method and --dest-auth-method parameters:
The LOGIN authentication method corresponds to the IMAP LOGIN command1.
Example parameters:
| Parameter | Value | Required |
|---|---|---|
*-auth-method |
LOGIN |
Yes |
*-username |
joe.bloggs |
Yes |
*-password |
PassW0Rd1 |
Yes |
The PLAIN authentication method corresponds to the SASL PLAIN mechanism2.
Example parameters:
| Parameter | Value | Required |
|---|---|---|
*-auth-method |
PLAIN |
Yes |
*-username |
joe.bloggs |
Yes |
*-password |
PassW0Rd1 |
Yes |
The OAUTHBEARER authentication method corresponds to the SASL OAUTHBEARER mechanism3.
MailPump can be configured to use a custom OAuth2 provider. Built-in providers may be added in future releases.
| Parameter | Example | Required |
|---|---|---|
*-oauth2-provider |
custom |
Yes |
*-oauth2-client-id |
mailpump |
If *-oauth2-provider=custom |
*-oauth2-client-secret |
d2baf3d2-5810-4dd1-afec-3a0101b28980 |
If *-oauth2-provider=custom |
*-oauth2-token-url |
https://server.example.com/oauth2/token |
If *-oauth2-provider=custom |
*-oauth2-scopes4 |
imap |
If *-oauth2-provider=custom |
*-username |
joe.bloggs |
Yes |
*-password5 |
b2F1dGgyLXJlZnJlc2gtdG9rZW4K |
Yes |
The mailpump oauthlogin command will initiate an OAuth2 login and print a token suitable for passing to
*-password.
NAME:
mailpump oauthlogin - Generate an OAuth2 Token
USAGE:
mailpump oauthlogin [command options] [arguments...]
OPTIONS:
--provider value provider (custom) (default: "custom") [$MAILPUMP_PROVIDER]
--client-id value client id [$MAILPUMP_CLIENT_ID]
--client-secret value client secret [$MAILPUMP_CLIENT_SECRET]
--token-url value token url [$MAILPUMP_TOKEN_URL]
--scopes value scopes [$MAILPUMP_SCOPES]
--help, -h show help (default: false)
| Provider | URL |
|---|---|
| Generic | imap[s]://hostname[:port]/mailbox/path |
| Migadu | imaps://imap.migadu.com/INBOX |
| Yahoo! | imaps://imap.mail.yahoo.com/INBOX |
| Outlook | imaps://outlook.office365.com/INBOX |
| GMail | imaps://imap.gmail.com/INBOX |
Copyright © 2022 Zane van Iperen
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License version 2, and only version 2 as published by the Free Software Foundation.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
Footnotes
-
https://datatracker.ietf.org/doc/html/rfc3501#section-6.2.3 ↩
-
This may be specified multiple times to add multiple scopes. When configuring via environment variable, separate the values with commas. ↩
-
This should be a base64-encoded OAuth2 Refresh Token. ↩