/mailsender

simple mail-sending service, http-api, written in golang

Primary LanguageGoApache License 2.0Apache-2.0

mailsender

simple mail-sending service, http-api, written in golang

install

install mail-sender from src

	# get src
	mkdir -p $GOPATH/src/github.com/niean && cd $GOPATH/src/github.com/niean
	git clone git@github.com:niean/mailsender.git && cd mailsender
	
	# build
	go get ./...
	./control build
	
	# config
	mv cfg.example.json cfg.json
	vim cfg.json
	
	# start
	./control start
	...
	
	# stop
	./control stop

install mail-sender from bin

	# get bin
	mkdir -p /home/to/mailsender && cd /home/to/mailsender
	wget https://github.com/niean/mailsender/releases/download/v0.0.1/tycs-mailsender-0.0.1.tar.gz
	tar -zxf tycs-mailsender.tar.gz
	
	# config
	mv cfg.example.json cfg.json
	vim cfg.json
	
	# start
	./control start
	...
	
	# stop
	./control stop

usage

	# test, send one mail to tycloudstart.com:1986
	curl -X POST -d "tos=anddynie@gmail.com;subject=some_subject;content=some_content;user=anddy" "tycloudstart.com:1986/mail/sender"

    # http-api
    POST /mail/sender HTTP/1.1
    Host host:port
    Args
	   -- tos: receivers, separated by comma(,)
	   -- subject: subject of ur mail
	   -- content: content of ur mail
       -- user: optional, displayed name of sender at receiver's side

configuration

    debug: true/false, whether or not open debug-logging

    http
        - enable: true/false, whether or not enable http-server 
        - listen: int, port of the http-server

   	mail 
        - enable: true/false, whether or not enable mail-sending service
        - sendConcurrent: int, max number of concurrent threads sending mails
        - maxQueueSize: int, max number of cached mails which are to be sent
        - fromUser: string, default display name of sender at receiver's side
        - mailServerHost: string, hostname of the smtp (or pop3) server 
        - mailServerPort: int, port of the mailServerHost
        - mailServerAccount: string, authorized user account on mailServerHost
        - mailServerPasswd: int, password for mailServerAccount

debug

use ./test/debug to debug your mailsender service

	bash ./test/debug
	{
	    "data": [
	        {# counter of mailsending request
	            "Cnt": 0,
	            "Name": "HttpRequestCnt",
	            "Other": {},
	            "Qps": 0,
	            "Time": "2015-06-17 09:11:57"
	        },
	        {# counter of all mails sent(ok + error)
	            "Cnt": 0,
	            "Name": "MailSendCnt",
	            "Other": {},
	            "Qps": 0,
	            "Time": "2015-06-17 09:11:57"
	        },
	        {# counter of mails sent ok
	            "Cnt": 0,
	            "Name": "MailSendOkCnt",
	            "Other": {},
	            "Qps": 0,
	            "Time": "2015-06-17 09:11:57"
	        },
	        {# counter of mails sent error
	            "Cnt": 0,
	            "Name": "MailSendErrCnt",
	            "Other": {},
	            "Qps": 0,
	            "Time": "2015-06-17 09:11:57"
	        }
	    ],
	    "msg": "success"
	}

reference

TODO