UAPI Functions - Email::set_always_accept

Description

This function sets the Mail Exchanger (MX) type.

Note:

This function only affects the cPanel configuration. You must configure the mail exchanger's DNS entry separately. 

Examples 

 cPanel or Webmail Session URL

https://hostname.example.com:2083/cpsess##########/execute/Email/set_always_accept?domain=example.com&mxcheck=auto&alwaysaccept=1

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Set example.com's mail exchanger type.
$set_mx_type = $cpanel->uapi(
    'Email', 'set_always_accept',
    array(
        'domain'        => 'example.com',
        'mxcheck'       => 'auto',
        'alwaysaccept'  => '1',
         )
);

 LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Set example.com's mail exchanger type.
my $set_mx_type = $cpliveapi->uapi(
    'Email', 'set_always_accept',
    {
        'domain'        => 'example.com',
        'mxcheck'       => 'auto',
        'alwaysaccept'  => '1',
    }
);

 cPanel Template Toolkit
<!-- Set example.com's mail exchanger type, then display the changed values. -->
[% data = execute( 'Email', 'set_always_accept', { 'domain' => 'example.com', 'mxcheck' => 'auto', 'alwaysaccept' => '1' } ); %]
[% FOREACH q = data.checkmx.changed %]
     <p>
         [% q %]
     </p>
[% END %]
   
<!-- Get only the changed values. -->
[% execute('Email', 'set_always_accept', { 'domain' => 'example.com', 'mxcheck' => 'auto', 'alwaysaccept' => '1' } ).data.checkmx.changed %]

 Command Line
uapi --user=username Email set_always_accept domain=example.com mxcheck=auto alwaysaccept=1

 

Notes:

  • You must URI-encode values.
  • username represents your account-level username.

 Output (JSON)
{ 
   "messages":null,
   "errors":null,
   "status":1,
   "metadata":{ 
 
   },
   "data":{ 
      "statusmsg":"Set Always Accept Status to: auto",
      "checkmx":{ 
         "warnings":[
         ],
         "issecondary":0,
         "local":0,
         "remote":0,
         "detected":"local",
         "isprimary":1,
         "changed":0,
         "mxcheck":"auto",
         "secondary":0
      },
      "status":1,
      "local":0,
      "detected":"local",
      "remote":0,
      "mxcheck":"auto",
      "secondary":0,
      "results":"Set Always Accept Status to: auto"
   }
}

 

Note:

Use cPanel's API Shell interface (Home >> Advanced >> API Shell) to directly test cPanel API calls.

 

Parameters

Parameter

Type

Description

Possible values

Example

domain

string

Required

The mail exchanger's domain.

A valid domain on the cPanel account.

 example.com 

mxcheck

string

The mail exchanger type.

This parameter defaults to auto.

 
  • auto — Allow cPanel to determine the appropriate role.
  • local — Always accept the domain's mail.
  • secondary — Accept mail until a higher priority mail server is available. 
  • remote — Do not accept mail.

auto 

 alwaysaccept 

 Boolean 

 Whether the mail exchanger always accepts mail for the domain. 

This parameter defaults to 1.
  • 1 — Always accepts mail.
  • 0 — Does not always accept mail.

1

 

Returns

Return

Type

Description

Possible values

Example

statusmsg

string

A message of success or a reason for failure.
  • A message of success that includes the new type.
  • A string that describes an error.

Set Always Accept Status to: local

checkmx

hash

A hash of the mail exchanger's data.

 This hash includes the warnings,issecondary, local, detected,remote, isprimary, changed,secondary, and mxcheck returns. 

 

warnings

array

An array of warning messages, if any exist.

The function returns this value in the checkmx hash.

One or more warning messages.

 

 issecondary 

 Boolean 

Whether the mail exchanger is a secondary exchanger.

The function returns this value in the checkmx hash.
  • 1 — Secondary.
  • 0 — Not secondary.

0

local

Boolean

Whether the mail exchanger is a local exchanger.

The function returns this value in the checkmx hash.
  • 1 — Local.
  • 0 — Not local.

0

detected

string

The mail exchanger type.

The function returns this value in the checkmx hash.
  • auto
  • local
  • secondary
  • remote

auto

remote

Boolean

Whether the mail exchanger is a remote exchanger.

The function returns this value in the checkmx hash.
  • 1 — Remote.
  • 0 — Not remote.

0

isprimary

Boolean

 Whether the mail exchanger is the primary mail exchanger. 

The function returns this value in the checkmx hash.
  • 1 — Primary.
  • 0 — Not primary.

0

changed

Boolean

Whether a change occurred during the function.

The function returns this value in the checkmx hash.
  • 1 — Change occurred.
  • 0 — No change.

1

secondary

Boolean

Whether the mail exchanger is a secondary exchanger.

The function returns this value in the checkmx hash.
  • 1 — Secondary.
  • 0 — Not secondary.

0

mxcheck

string

The mail exchanger type.

The function returns this value in the checkmx hash.
  • auto
  • local
  • secondary
  • remote

auto

status

Boolean

Whether the function succeeded.
  • 1 — Success.
  • 0 — Failure.

1

local

Boolean

Whether the mail exchanger is a local exchanger.
  • 1 — Local.
  • 0 — Not local.

0

remote

Boolean

Whether the mail exchanger is a remote exchanger.
  • 1 — Remote.
  • 0 — Not remote.

0

detected

string

The mail exchanger type.
  • auto
  • local
  • secondary
  • remote

auto

mxcheck

string

The mail exchanger type.
  • auto
  • local
  • secondary
  • remote

auto

secondary

Boolean

Whether the mail exchanger is a secondary exchanger.
  • 1 — Secondary.
  • 0 — Not secondary.

0

results

string

A message of success or a reason for failure.
  • A message of success that includes the new type.
  • A string that describes an error.

 Set Always Accept Status to: local 

 

 

  • 0 Users Found This Useful
Was this answer helpful?

Related Articles

The cPanel Interface

For  cPanel  &  WHM  version  58 Overview The cPanel interface is...

User Preferences

For cPanel & WHM version 58 Overview This document outlines how to access your cPanel...

Manage External Authentications

For cPanel & WHM version 58 Overview Manage credentials Additional documentation...

What is cPanelID?

In This Article:  Overview ServicesHow to get a cPanelID cPanelID External...

Guide to cPanel Interface Customization - cPanel Style Development

Introduction You can develop custom styles that modify the appearance of the cPanel interface....