How to manage email restrictions via the command-line

Introduction

Email restrictions allow you to restrict incoming and outgoing email features for email addresses. Being able to manage these quickly via the command line will allow you to set the restrictions that you need at a user level or email-account level.

Procedure

Hold and release outgoing email for a cPanel user:

• Add cPanel account to outbound email hold queue

  whmapi1 hold_outgoing_email user=cpusername

• Release cPanel account queued outgoing emails

  whmapi1 release_outgoing_email user=cpusername

Hold and release outgoing email for an individual email account:

• Suspend email account outgoing mail

  uapi --user=cpusername Email hold_outgoing email=emailusername@domain.tld

• Unsuspend email account outgoing mail

  uapi --user=cpusername Email release_outgoing email=emailusername@domain.tld

Suspend and unsuspend outgoing email for a cPanel user:

• Suspend cPanel account outgoing email

  whmapi1 suspend_outgoing_email user=cpusername

• Unsuspend account outgoing email
  

  whmapi1 unsuspend_outgoing_email user=cpusername

Suspend and unsuspend outgoing email for an individual email account:

• Suspend email account outgoing mail

  uapi --user=cpusername Email suspend_outgoing email=emailusername@domain.tld

• Unsuspend email account outgoing mail

  uapi --user=cpusername Email unsuspend_outgoing email=emailusername@domain.tld

Suspend and unsuspend incoming email for an individual email account:

• Suspend email account incoming (SMTP) mail

  uapi --user=cpusername Email suspend_incoming email=emailusername@domain.tld

• Unsuspend email account incoming mail

   uapi --user=cpusername Email unsuspend_incoming email=emailusername@domain.tld

Suspend and unsuspend login for an individual email account:

• Suspend email account login

  uapi --user=cpusername Email suspend_login email=emailusername@domain.tld

• Unsuspend email account login

  uapi --user=cpusername Email unsuspend_login email=emailusername@domain.tld 

Please note that, in the above examples, cpusername and emailusername@domain.tld must be replaced with the cPanel account's username and the email address on which the action is to be taken.