simplepush

README

simplepush

Golang client and library for simplepush.io

Synopsis

simplepush
Usage: simplepush -k key -m message [-t title] [-e event] [-p password] [-s salt]
  -e event
    	Set event
  -k key
    	Set simplepush.io key
  -m message
    	Set message
  -s salt
    	Set custom salt
  -p password
    	Set password, if set send message encrypted
  -t title
    	Set title

Releases

Pre-built binaries are provided here. Please note that these binaries are automatically built by Travis-CI. Your decision if you trust them.

Docker

docker pull rck81/simplepush
docker run -it --rm rck81/simplepush -k YOURKEY -m "Test"

Documentation

Overview

Package simplepush provides a library to send (end-to-end encrypted) push messages to Smartphones via https://simplepush.io

Index

• Variables
• func Send(m Message) error
• type Message

Variables

var APIUrl = "https://api.simplepush.io/"

APIUrl is the public API entry point for https://simplepush.io. It is public to allow overriding in case of simplepush.io compatible services.

Functions

func Send

func Send(m Message) error

Send takes a message of type Message and sends it via the simplepush.io API. Please refer to the documentation of the Message struct for further information.

Types

type Message

type Message struct {
	SimplePushKey string // Your simeplepush.io key
	Title         string // Title of your message
	Message       string // Message body
	Event         string // The event the message should be associated with
	Encrypt       bool   // If set, the message will be sent end-to-end encrypted with the provided Password/Salt. If false, the message is sent unencrypted.
	Password      string // Your password
	Salt          string // If set, this salt is used, otherwise the default one gets used.
}

Message contains all the information necessary to send a, potentially encrypted, message.