vmail-stack/bin/vmail-forwards-get.sh

#!/bin/bash
#
# vmail-stack
# https://git.stack-source.com/msb/vmail-stack
# MIT License Copyright (c) 2021 Matthew Saunders Brown

# load config
source /usr/local/etc/vmail.conf || echo "ERROR: Either you do not have vmail user permissions or the config file is missing." && exit

help()
{
  thisfilename=$(basename -- "$0")
  echo "$thisfilename"
  echo "Get email forwards data from vmail database."
  echo ""
  echo "usage: $thisfilename [email|forward|domain] [OPTIONS]"
  echo ""
  echo "  -c          Output in cvs format."
  echo "  -f          Return info for specific forward."
  echo "  -h          Print this help."
  echo "  -s          Be more silent - use tabs instead of tables for output, do not display column headers."
  echo ""
  echo "              Search term is optional. If nothing specified all forwards for all email acccounts for all domains will be returned."
  echo "              Enter email address to get forward info for that email address."
  echo "              Enter forwarding address (in full email address format) with the -f option to get address(es) that forward to specified address."
  echo "              Enter domain name to get all forwards for all email addresses under that domain."
  exit
}

# check for and set alias search term(s)
if [ -n "$1" ]; then
  if [ $1 == "-h" ]; then
    help
  elif [[ ! $1 =~ ^- ]] ; then
    searchterm=$1
    shift
    if [[ $searchterm =~ "@" ]] ; then
      mbox=${searchterm%@*}
      domain=${searchterm##*@}
      if ! vmail::validate_domain $domain; then
        echo "ERROR: $searchterm is not a valid email address."
        exit
      fi
    elif vmail::validate_domain $searchterm; then
      domain=$searchterm
    else
      echo "ERROR: $searchterm is not a valid search term."
      help
    fi
  fi
fi

# set initial db query data
dbcmd="mysql --defaults-extra-file=$MYSQL_CONNECTION_INFO_FILE"
dbcmdopts="-e"
dbquery="SELECT vm_mboxes.mbox, vm_domains.domain, vm_forwards.forward_to, vm_forwards.save_local FROM vm_forwards, vm_mboxes, vm_domains WHERE vm_forwards.mbox_id = vm_mboxes.id AND vm_mboxes.domain_id = vm_domains.id"

# set any options that were passed
while getopts "cfhs" opt; do
  case "${opt}" in
    c )
      cvs="| sed 's/\t/,/g'"
      ;;
    f )
      forwardsearch=true
      ;;
    h )
      help
      exit;;
    s )
      dbcmdopts="-s -N $dbcmdopts"
      ;;
    \? )
      echo "Invalid option: $OPTARG" 1>&2
      exit;;
  esac
done

# build query
if [ -n "$domain" ]; then
  # add specific domain
  dbquery="$dbquery AND vm_domains.domain='$domain'"
  if [ -n "$mbox" ]; then
    # search for specific alias or mbox
    if [ -n "$forwardsearch" ]; then
      # search for specific forward to address
      dbquery="SELECT vm_mboxes.mbox, vm_domains.domain, vm_forwards.forward_to, vm_forwards.save_local FROM vm_forwards, vm_mboxes, vm_domains WHERE vm_forwards.mbox_id = vm_mboxes.id AND vm_mboxes.domain_id = vm_domains.id AND  vm_forwards.forward_to='$mbox@$domain'"
    else
      # search for forward for specific email address
      dbquery="$dbquery AND vm_mboxes.mbox='$mbox'"
    fi
  fi
fi

# set order by
dbquery="$dbquery ORDER BY vm_domains.domain, vm_mboxes.mbox, vm_forwards.forward_to;";

# execute mysql query
eval $dbcmd $dbcmdopts "\"$dbquery\"" $cvs