PHP Classes
elePHPant
Icontem

Bitmessage PHP Class: Send control commands to a BitMessage P2P server

Recommend this page to a friend!
  Info   View files View files (5)   DownloadInstall with Composer Download .zip   Reputation   Support forum   Blog    
Last Updated Ratings Unique User Downloads Download Rankings
2016-08-08 (4 months ago) RSS 2.0 feedNot enough user ratingsTotal: 324 All time: 6,821 This week: 819Up
Version License PHP version Categories
bitmessage-php 1.2GNU General Publi...3.0PHP 5, Web services, Chat
Description Author

This class can send control commands to a BitMessage P2P server.

It can send XMLRPC messages to a given BitMessage server to execute several commands. Currently it send messages for:

- Creating a new random address or deterministic addresses
- Get a deterministic address
- Gel all inbox and sent messages
- Get a given inbox or sent message
- Get sent messages by sender
- Send a message
- Send a broadcast message
- Trash a given message
- Add or delete a subscription
- Add or delete an address book entry
- Create a channel
- Join or leave a channel
- Delete or decode addresses

Innovation Award
PHP Programming Innovation award nominee
January 2014
Number 3
Bitmessage is protocol for peer to peer communications between chat users. It is a decentralized protocol that uses strong encryption to exchange messages.

Bitmessage became relevant since it was publicly announced that NSA was intercepting communications between people on the Internet.

This class implements a client for exchanging messages using the Bitmessage
protocol.

Manuel Lemos
  Performance   Level  
Name: Con vertor <contact>
Classes: 2 packages by
Country: Portugal Portugal
Age: ???
All time rank: 311340 in Portugal Portugal
Week rank: 325 Up5 in Portugal Portugal Up
Innovation award
Innovation award
Nominee: 1x

Details
[![Stories in Ready](https://badge.waffle.io/Conver/class.bitmessage.php.png?label=ready&title=Ready)](https://waffle.io/Conver/class.bitmessage.php)
Bitmessage PHP Class
====================

[![tip for next commit](http://prime4commit.com/projects/112.svg)](http://prime4commit.com/projects/112)

[Bitmessage](https://bitmessage.org/) PHP Class to control PyBitmessage daemon using xmlrpc


Release Information
---------------
This repo contains in-development code for future releases. To download the
latest stable release please visit the [release](https://github.com/Conver/class.bitmessage.php/releases) page.


Requirements
---------------
php5-xmlrpc

php5-curl

Getting Started
---------------
1. Make sure php5-xmlrpc & php5-curl is installed and loaded
    
  `apt-get install php5-xmlrpc php5-curl`

  `service apache2 restart`

2. Include class.bitmessage.php into your PHP script:

	`require_once('curl.php');`
	
	`require_once('class.bitmessage.php');`
    
3. Initialize Bitmessage connection/object:

	`$bitmessageObj = new bitmessage("<RPCusername>:<RPCpassword>@<RPChost>:<RPCport>/");`

	Optionally, you can turn off the class stt protocol (HTTP and HTTPS). Default  protocol is http.

	`$bitmessageObj = new bitmessage("<RPCusername>:<RPCpassword>@<RPChost>:<RPCport>/", "http");`
    
4. Make calls to Bitmessage daemon as methods for your object. Examples:

    `$bitmessageObj->newAddress($label, $eighteenByteRipe = false, $totalDifficulty = 1, $smallMessageDifficulty = 1);`
    
    `$bitmessageObj->setStrip(true);`
    
    `$bitmessageObj->broadcast($address, $title, $message);`
    
Features
========

* Automatic Decoding
* Automatic HTML strip
* Support SSL over HTTPS
* Clean arrays (JSON decoded)

    
Contributing
============

You can contribute to this project in different ways:

* Report outstanding issues and bugs by creating an [Issue](https://github.com/Conver/class.bitmessage.php/issues/new)
* Suggest feature enhancements via our [Forum Thread](https://bitmessage.org/forum) on bitmessage forum
* Fork the project, create a branch and file a pull request to improve the code itself

Contact
=======

Bitmessage: BM-NBH4Q94X9E6mNmdKqeF68zWC4uzz7uCB

Donations
=========

Donations to this project are going directly to [Conver](https://github.com/Conver), the original author of this project:

* BTC address: `1Ac9HwAg352hWepY51jhPncGDwrrQWftT7`


LICENSE
---------------
Copyright (C) 2014 - 2014  Convertor

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

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, see <http://www.gnu.org/licenses/>
  Files folder image Files  
File Role Description
Accessible without login Plain text file changelog.txt Data Documentation
Plain text file class.bitmessage.php Class Class source
Plain text file curl.php Class Class source
Accessible without login Plain text file LICENSE.md Lic. License text
Accessible without login Plain text file README.md Doc. Documentation

 Version Control Unique User Downloads Download Rankings  
 100%
Total:324
This week:0
All time:6,821
This week:819Up