The enable_spf_dkim_globally Script

Valid for versions 82 through the latest version

Version:

82


Last modified: May 13, 2020

Overview

This script enables SPF and DKIM system-wide. It also creates the appropriate DNS records for all users’ domains. If the system detects that a DKIM record exists for a domain, it will not update it. If it detects that an SPF record exists for a domain, it will update it.

Important:

You must run this script as a root-level user.

Run the script

To run this script on the command line, use the following format:

/usr/local/cpanel/scripts/enable_spf_dkim_globally [options]

Options

Use the following options with this script:

  • -xRequired. Use this option to run the script.
    Important:

    If you do not use this option, the script dies with a warning message.

  • --user — Use this option to specify an account for which to enable SPF and DKIM. The system will also create the DNS record for the user’s domain.
    Note:

    To run this script for multiple users, use this option multiple times. For example:

    /usr/local/cpanel/scripts/enable_spf_dkim_globally -x --user=user1 --user=user2
    

    In this example, user1 and user2 represent the users for which you want to enable SPF and DKIM.

Important:

The --help option will not provide help documentation.

Additional Documentation