pybitmessage.bitmessagecli module

Created by Adam Melton (.dok) referenceing https://bitmessage.org/wiki/API_Reference for API documentation Distributed under the MIT/X11 software license. See http://www.opensource.org/licenses/mit-license.php.

This is an example of a daemon client for PyBitmessage 0.6.2, by .dok (Version 0.3.1) , modified

TODO: fix the following (currently ignored) violations:

userInput(message)

Checks input for exit or quit. Also formats for input, etc

restartBmNotify()

Prompt the user to restart Bitmessage

lookupAppdataFolder()

gets the appropriate folders for the .dat files depending on the OS. Taken from bitmessagemain.py

configInit()

Initialised the configuration

apiInit(apiEnabled)

Initialise the API

apiData()

TBC

apiTest()

Tests the API connection to bitmessage. Returns true if it is connected.

bmSettings()

Allows the viewing and modification of keys.dat settings.

validAddress(address)

Predicate to test address validity

getAddress(passphrase, vNumber, sNumber)

Get a deterministic address

subscribe()

Subscribe to an address

unsubscribe()

Unsusbcribe from an address

listSubscriptions()

List subscriptions

createChan()

Create a channel

joinChan()

Join a channel

leaveChan()

Leave a channel

listAdd()

List all of the addresses and their info

genAdd(lbl, deterministic, passphrase, numOfAdd, addVNum, streamNum, ripe)

Generate address

saveFile(fileName, fileData)

Allows attachments and messages/broadcats to be saved

attachment()

Allows users to attach a file to their message or broadcast

sendMsg(toAddress, fromAddress, subject, message)

With no arguments sent, sendMsg fills in the blanks. subject and message must be encoded before they are passed.

sendBrd(fromAddress, subject, message)

Send a broadcast

inbox(unreadOnly=False)

Lists the messages by: Message Number, To Address Label, From Address Label, Subject, Received Time)

outbox()

TBC

readSentMsg(msgNum)

Opens a sent message for reading

readMsg(msgNum)

Open a message for reading

replyMsg(msgNum, forwardORreply)

Allows you to reply to the message you are currently on. Saves typing in the addresses and subject.

delMsg(msgNum)

Deletes a specified message from the inbox

delSentMsg(msgNum)

Deletes a specified message from the outbox

getLabelForAddress(address)

Get label for an address

buildKnownAddresses()

Build known addresses

listAddressBookEntries()

List addressbook entries

addAddressToAddressBook(address, label)

Add an address to an addressbook

deleteAddressFromAddressBook(address)

Delete an address from an addressbook

getAPIErrorCode(response)

Get API error code

markMessageRead(messageID)

Mark a message as read

markMessageUnread(messageID)

Mark a mesasge as unread

markAllMessagesRead()

Mark all messages as read

markAllMessagesUnread()

Mark all messages as unread

clientStatus()

Print (the client status

shutdown()

Shutdown the API

UI(usrInput)

Main user menu

main()

Entrypoint for the CLI app