Skip to content

Using Mailpile's command line

JayEss3 edited this page Dec 7, 2019 · 2 revisions

# Setup

-load #Enter setup flow

-idlequit[]# #Shut down Mailpile if it has been idle for a while

-interact

-q | quit [restart] #Exit Mailpile, normal shutdown

-rescan [full|vcards|vcards:|sources|mailboxes|both|mailbox:|] #Add new messages to index

-wait

-optimize [harder] #Optimize the keyword search index

-cron [ <--trigger|--interval |--postpone >] #Manually edit or display the background job schedule

-gpg <GPG arguments ...> #Interact with GPG directly

-health #Check and report app health

-browse_o #Launch browser and exit, if already running

-cat </path/to/file> [>/path/to/output] #Dump the contents of a file, decrypting if necessary

-cd <.../new/path/...> #Change working directory

-cleanup #Perform cleanup actions (runs before shutdown)

-login #Authenticate a user (log in)

-logout [] #De-authenticate a user (log out)

-ls [-a] [-d] [</path/*.foo> ...] #Display working directory listing

-pidfile </path/to/pidfile>
#Write the PID to a file

-pipe [[email protected]|command|>filename] -- [ [args ... ]] #Pipe a command to a shell command, file or e-mail

-ps #Display list of running threads, locks and outstanding events

-www [host:port/path] #Just run the web server

-backup [download] #Generate an encrypted backup of Stuff

-motd [--silent|--ifnew] [--[no]update|--check] #Download and/or display the Message Of The Day

-vcards [--lines] [] #Find vcards

-cached [] #Fetch results from the command cache.

-output [json|text|html|

-eventlog [incomplete] [wait] [] [= != =~ ...] #Display events from the event log

-gui [] [main|watch]
#Connect to a waiting gui-o-matic GUI

-u | undo [] #Undo either the last action or one specified by Event ID

-append <section.variable> #Add a new value to a list (or ordered dict) setting

-language #List available languages

-S | set [--force] <section.variable> #Change a setting

-U | unset #Reset one or more settings to their defaults

-P | print [-short|-secrets|-flat] #Print one or more settings

-A | add [+] [--] [account@email] <path/to/mailbox>

-h | help [] #Print help on Mailpile or individual commands

-plugins [] #List the currently available plugins

-s | search [@] #Search your mail!

-unthread #Remove a message from a thread

-n | next #Display next page of results

-p | previous #Display previous page of results

-o | order #Sort by: date, from, subject, random or index

-v | view [raw] #View one or more messages

-e | extract [>] #Extract attachment(s) to file(s)

-tag [--conversations|--messages|--force] <[+|-]tags> #Add or remove tags on a set of messages

-tags [|!] [...] #List tags

-filter [new|read] [notag|maketag] [=] [] [+] [-] [] #Add auto-tag rule for current search or terms

-contacts [--lines] []

-profiles [--lines] [] #Find profiles

-groups [--lines] [] #Find groups

-C | compose [ephemeral] #Create a new blank e-mail for editing

-E | edit [] #Edit an existing draft

-m | mail #Update message from an HTTP upload and move to outbox

-update < #Update message from a file or HTTP upload

-a | attach [<path/to/file>] #Attach a file to a message

-unattach #Remove an attachment from a message

-r | reply [all|ephemeral] #Create reply(-all) drafts to one or more messages

-f | forward [att|ephemeral] #Create forwarding drafts of one or more messages

-bounce [] #Mail/bounce a message (to someone)

-sendmail #Try to empty the outbox

-delete [--keep] #Delete one or more messages

Tags: (use a tag as a command to display tagged messages)

Clone this wiki locally