feapi.sh

#!/usr/bin/env bash
# --------------------------
# -- feapi.sh script
# 
# -------------------------

# ------------
# -- Variables
# ------------
# Get version for file ~/.version
SCRIPT_NAME=feapi
SCRIPT=$(readlink -f "$0")
SCRIPTPATH=$(dirname "$SCRIPT")
API_URL="https://api.forwardemail.net"
REQUIRED_APPS=("jq" "column")
VERSION=$(<$SCRIPTPATH/VERSION)

# -- Colors
export TERM=xterm-color
export CLICOLOR=1
export LSCOLORS=ExFxCxDxBxegedabagacad

export NC='\e[0m' # No Color
export CBLACK='\e[0;30m'
export CGRAY='\e[1;30m'
export CRED='\e[0;31m'
export CLIGHT_RED='\e[1;31m'
export CGREEN='\e[0;32m'
export CLIGHT_GREEN='\e[1;32m'
export CBROWN='\e[0;33m'
export CYELLOW='\e[1;33m'
export CBLUE='\e[0;34m'
export CLIGHT_BLUE='\e[1;34m'
export CPURPLE='\e[0;35m'
export CLIGHT_PURPLE='\e[1;35m'
export CCYAN='\e[0;36m'
export CLIGHT_CYAN='\e[1;36m'
export CLIGHT_GRAY='\e[0;37m'
export CWHITE='\e[1;37m'

# -- Check for key files
[[ -f .test ]] && TEST=$(<$SCRIPTPATH/.test) || TEST="0"
[[ -f .debug ]] && DEBUG=$(<$SCRIPTPATH/.debug) || DEBUG="0"
[[ -z $DEBUG ]] && DEBUG="0"
[[ -z $TEST ]] && TEST="0"

# ----------------
# -- Key Functions
# ----------------
_debug () {
    if [[ $DEBUG -ge "1" ]]; then
		echo -e "${CCYAN}**** DEBUG $@${NC}"
    fi
}

_debug_curl () {
	if [[ $DEBUG == "2" ]]; then
    	echo -e "${CCYAN}**** DEBUG $@${NC}"
    fi
}


_debug_all () {
        _debug "--------------------------"
        _debug "arguments - $@"
        _debug "funcname - ${FUNCNAME[@]}"
        _debug "basename - $SCRIPTPATH"
        _debug "sourced files - ${BASH_SOURCE[@]}"
        _debug "test - $TEST"
        _debug "--------------------------"
}

_error () {
        echo -e "${CRED}$@${NC}";
}

_success () {
        echo -e "${CGREEN}$@${NC}";
}

_command () {
	if ! command -v $1 &> /dev/null
	then
	    _error "The command $1 could not be found and is required to run $SCRIPT_NAME"
	    exit
	fi
}

_check_commands () {
	for cmd in ${REQUIRED_APPS[@]}; do
		_command $cmd		
	done
}

# --------
# -- Debug
# --------
_debug_all $@

if [[ $TEST == "1" ]]; then
        _debug "Testing get using .test_get file"
        TEST_FILE=$(<$SCRIPTPATH/tests/test_get)
elif [[ $TEST == "2" ]]; then
	_debug "Testing post using .test_post file"
	TEST_FILE=$(<$SCRIPTPATH/tests/test_post)
elif [[ $TEST == "3" ]]; then
        _debug "Testing error using .test_error file"
        TEST_FILE=$(<$SCRIPTPATH/tests/test_error)
elif [[ $TEST == "4" ]]; then
        _debug "Testing create-alias using .test_create file"
        TEST_FILE=$(<$SCRIPTPATH/tests/test_create)
elif [[ $TEST == "5" ]]; then
        _debug "Testing create-alias using .test_create file"
        TEST_FILE=$(<$SCRIPTPATH/tests/test_delete)
else
        _debug "Testing mode off -- .test=$TEST"
fi

# ------------
# -- Functions
# ------------

# -- usage
usage () {
	echo "Usage: $SCRIPT_NAME <list|create>"
	echo ""
	echo " Commands"
	echo "    list-aliases <domain>                              -List all aliases for domain"
	echo "    list-domains <domain>                              -List domains"
	echo "    view-alias <email alias>                           -Retrive specific domain alias"
	echo "    create-alias <email alias> <destination-emails>	 -Creates an alias with comma separated destination emails"
	echo "    delete-alias <email alias>                         -Deletes an alias"
	echo "    tests                                              -List all test codes"
	echo " Options"
	echo "    -d         -Debug mode 1 or 2"
	echo ""
	echo " Ensure you hav your forwardemail.net API credentials in \$HOME/.feapi in the following format"
	echo " API_KEY=1v34b21b43234b"
	echo ""
        echo "Version: $VERSION"
}

split_email () {
	email=$@
	IFS=$'@' 
	email=($email)
	unset IFS
        ALIAS=${email[0]}
        DOMAIN=${email[1]}
}

curl_error_message () {
        status=$(echo $@ | jq -r '[.message, .statusCode] | @tsv')
        IFS=$'\t'
        status=($status)
        QUERY_MESSAGE=${status[0]}
        QUERY_CODE=${status[1]}

        echo ""
        _error "Query Error"
        _error "Query Message: $QUERY_MESSAGE"
        _error "Status Code: $QUERY_CODE"
        exit
}

curl_check () {
        if [[ $output == *"Bad Request"* ]]; then
                _debug "curl error"
                curl_error_message $output
        elif [[ $output == *"Not Found"* ]]; then
                _debug "curl error"
                curl_error_message $output
        else
                _debug "curl success"
                _success "Query success"
        fi
}
                         
curl_get () {
	QUERY=$1
	CURL_QUERY="$API_URL$QUERY"

	_debug "curl_get"

        if (( $TEST >= "1" )); then
		_debug "query: $TEST_FILE"
                output=$TEST_FILE
        else
                _debug "query: $QUERY api: $FEAPI_TOKEN"
                _debug "cmd: curl -sX GET $CURL_QUERY -u $FEAPI_TOKEN:"
                output=$(curl -sX GET $CURL_QUERY -u $FEAPI_TOKEN:)
                _debug_curl $output
        fi
}

curl_post () {
	QUERY=$1
	ALIAS=$2	
        EMAILS=$3
        ENABLED=$4
        CURL_QUERY="$API_URL$QUERY"

	_debug "curl_post"
	
	# If test is set
	if (( $TEST >= "1" )); then
		_debug "Running test query"
        
		echo ""
		echo "sample CURL"
		echo "-----------"
		echo "curl -sX POST $CURL_QUERY -u $FEAPI_TOKEN: \\"
		echo "-d \"name=$ALIAS\" \\"
		echo "-d \"recipients=$EMAILS\""
		echo "-d \"$4\""
		echo ""
		output=$TEST_FILE
        else
		_debug "query: $QUERY alias:$ALIAS emails:${EMAILS[@]}"
		_debug "cmd: curl -sX POST $CURL_QUERY -u $FEAPI_TOKEN: -d \"name=$ALIAS\" -d \"recipients=$EMAILS\" -d \"$ENABLED\""		
        output=$(curl -sX POST $CURL_QUERY -u $FEAPI_TOKEN: -d "name=$ALIAS" -d "recipients=$EMAILS" -d "$ENABLED")
        _debug_curl $output
        fi

	_debug "output"
	_debug "------"
	_debug $output
	
    if [[ $output == *"Bad Request"* ]]; then
        _debug "curl error"
        curl_error_message $output
	else
        _debug "curl success"
        _success "Query success"

        fi

}

curl_delete () {
        QUERY=$1
        CURL_QUERY="$API_URL$QUERY"

        _debug "curl_delete"

        if (( $TEST >= "1" )); then
                _debug "query: $TEST_FILE"
                output=$TEST_FILE
        else
                _debug "query: $QUERY api: $FEAPI_TOKEN"
                _debug "cmd: curl -sX DELETE $CURL_QUERY -u $FEAPI_TOKEN:"
                output=$(curl -sX DELETE $CURL_QUERY -u $FEAPI_TOKEN:)
                _debug_curl $output
        fi        
	curl_check
}

list_domains () {
	#GET /v1/domains
	#Querystring Parameter	Required	Type	Description
	#name	No	String (RegExp supported)	Search for domains by name
	#alias	No	String (RegExp supported)	Search for domains by alias name
	#recipient	No	String (RegExp supported)	Search for domains by recipient
	# List aliases
    echo "-- Listing domains"
    curl_get "/v1/domains"
    echo "Domains"
    echo "-------------------"
    echo ${output[@]} | jq -r '(["ID","DOMAIN","MX","TXT","ALIASES","CREATED","LINK"] | (., map(length*"-"))), (.[] | [.id, .name, .has_mx_record, .has_txt_record, .members[0] .alias_count, .created_at, .link])|@tsv' | column -t
}

list_aliases () {
	#GET /v1/domains/domain.com/aliases
	#Querystring Parameter	Required	Type				Description
	#name			No		String (RegExp supported)	Search for aliases in a domain by name
	#recipient		No		String (RegExp supported)	Search for aliases in a domain by recipient	

	# Variables
	DOMAIN=$1
	_debug "domain = $DOMAIN"
	
	# List aliases
	echo "-- Listing aliases"
	curl_get "/v1/domains/$DOMAIN/aliases"
	echo "Aliases for $DOMAIN"
	echo "-------------------"
	echo ${output[@]} | jq -r '(["ID","ENABLED","NAME","RECIPIENTS","DESCRIPTION"] | (., map(length*"-"))), (.[]| [.id, .is_enabled, .name,(.recipients|join(",")),.description])|@tsv' | column -t
	
}

view_alias () {
        # GET /v1/domains/:domain_name/aliases/:alias_id
        # curl https://api.forwardemail.net/v1/domains/:domain_name/aliases/:alias_id -u API_TOKEN:

        # Split email parts
        _debug "splitting email"
        split_email $@
        _debug "alias: $ALIAS domain: $DOMAIN"

        # Get data and print
        echo "-- Getting alias $@"
        curl_get "/v1/domains/$DOMAIN/aliases/$ALIAS"
        echo "Alias $@"
        echo "-----------"
        echo ${output[@]} | jq -r '(["ID","ENABLED","NAME","RECIPIENTS","DESCRIPTION"] | (., map(length*"-"))), [.id, .is_enabled, .name,(.recipients|join(",")),.description]|@tsv' | column -t
}

create_alias () {
	#POST /v1/domains/domain.com/aliases
	#Body Parameter	Required Type			Description
	#name		Yes	String			Alias name
	#recipients	Yes	String or Array		List of recipients (must be line-break/space/comma separated String 
	#						or Array of valid email addresses, fully-qualified domain names 
	#						("FQDN"), IP addresses, and/or webhook URL's)
	#description	No	String			Alias description
	#labels		No	String or Array		List of labels (must be line-break/space/comma separated String or Array)
	#is_enabled	No	Boolean			Whether to enable to disable this alias (if disabled, emails will be routed 
	#						nowhere but return successful status codes)

	# Variables
	_debug "args: $@"
        split_email $1
        EMAILS=$2
        _debug "alias: $ALIAS domain: $DOMAIN emails:$EMAILS"
	
	# Create alias
        echo "-- Creating alias"
        curl_post "/v1/domains/$DOMAIN/aliases" "$ALIAS" "$EMAILS" "is_enabled=true"
        echo ${output[@]} | jq -r '(["ID","ENABLED","NAME","RECIPIENTS"] | (., map(length*"-"))), [.id, .is_enabled, .name,(.recipients|join(","))]|@tsv' | column -t
}

delete_alias () {
	#DELETE /v1/domains/:domain_name/aliases/:alias_id
	#Example Request:
	#curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/aliases/:alias_id

        # Variables
        split_email $1
        _debug "alias: $ALIAS domain: $DOMAIN"

        # Create alias
        echo "-- Creating alias"
        curl_delete "/v1/domains/$DOMAIN/aliases/$ALIAS"
        echo ${output[@]} | jq -r '(["ID","ENABLED","NAME","RECIPIENTS","DESCRIPTION"] | (., map(length*"-"))), ([.id, .is_enabled, .name,(.recipients|join(",")),.description])|@tsv' | column -t
}

tests_cmd () {
	echo "Current Test Value = $TEST"
	echo ""
	echo "Test 0 = Testing Disabled"
        echo "Test 1 = test_get"
	echo "Test 2 = test_post"
	echo "Test 3 = test_error"
	echo "Test 4 = test_create"
	echo "Test 5 = test_delete"
	if [[ $1 ]]; then
		echo ""
		echo "Changing test value to $1"
		echo "$1" > $SCRIPTPATH/.test
	fi
}

debug_cmd () {
        echo "Current debug value = $DEBUG"
        echo ""
        echo "Debug 0 = Debug disabled"
	echo "Debug 1 = Debug enabled"
	echo "Debug 2 = Debug enabled + curl debug enabled"
        if [[ $1 ]]; then
                echo ""
                echo "Changing debug value to $1"
                echo "$1" > $SCRIPTPATH/.debug
        fi
}

# --------------
# -- Main script
# --------------

# -- options
POSITIONAL=()
while [[ $# -gt 0 ]]
do
key="$1"

case $key in
    -d|--debug)
    DEBUG="$2"
    shift # past argument
    shift # past value
    ;;
    *)# unknown option
    POSITIONAL+=("$1") # save it in an array for later
    shift # past argument
    ;;
esac
done
set -- "${POSITIONAL[@]}" # restore positional parameters

# -- debug args
_debug "ARGS: $@"

# -- check if required commands are installed
_check_commands

# -- Check for .feapi key
if [[ -f ~/.feapi ]]; then
	_success "Found ~/.feapi"
    source ~/.feapi
elif [[ $FEAPI_TOKEN ]]; then
        _success "Found API key."
else
    _error "No ~/.feapi file exists, and $FEAPI_TOKEN set."
    exit 1
fi

# -- Loop through args
if [ ! $1 ]; then
        usage
        exit
elif [[ $1 == "list-aliases" ]]; then
	if [[ ! -n $2 ]];then 
		usage
		exit 1
	else
		list_aliases $2
	fi
elif [[ $1 == "list-domains" ]]; then
	list_domains	
elif [[ $1 == "view-alias" ]]; then
	if [[ ! -n $2 ]];then usage;exit;fi
	view_alias $2
elif [[ $1 == 'create-alias' ]]; then
	if [[ ! -n $2 ]] || [[ ! -n $3 ]]; then usage; exit;fi
	create_alias $2 $3
elif [[ $1 == 'delete-alias' ]]; then
        if [[ ! -n $2 ]]; then usage; exit;fi
        delete_alias $2
elif [[ $1 == "tests" ]]; then
	tests_cmd $2
elif [[ $1 == "debug" ]]; then
        debug_cmd $2
else
	usage
fi