mailmd command reference #

Copy your mailbox into Markdown files

Commands #

• mailmd connect - Connect a mailbox
• mailmd connect gmail - Connect Gmail through the Gmail API
• mailmd connect imap - Connect an IMAP mailbox
• mailmd connect outlook - Connect Outlook or Microsoft 365
• mailmd demo - Write a sample archive without any account
• mailmd disconnect - Remove an account and its saved login
• mailmd list - List parts of your mailmd setup
• mailmd list accounts - List connected accounts
• mailmd list folders - List the folders on the server
• mailmd status - Show what is in the archive
• mailmd sync - Copy new mail into the archive
• mailmd update - Check for a newer version

Global flags #

• --config-root Folder for mailmd's settings and logins (default: $MAILMD_CONFIG_ROOT, or your user config folder)
• --dry-run Preview changes without performing them
• --include-meta Wrap the JSON output as {data, meta} with request details
• --jq Filter the JSON output with a jq expression
• --json Output stable JSON instead of the human view
• --no-ansi Disable all ANSI/control sequences in human output
• --no-color Disable color in human output
• --no-pager Never use a pager for long human output
• --no-prompt Never block on an interactive prompt
• --plain Print text without color or formatting
• --quiet Suppress non-essential output
• --template Format the JSON output with a Go text/template
• --verbose Show the details when mailmd can't read an IMAP server's answer