Description

This function displays an account's contact and notification settings.

 

 

Examples 


https://hostname.example.com:2087/cpsess##########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=CustInfo&cpanel_jsonapi_func=displaycontactinfo

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Display contact information.
$display_contact = $cpanel->api2(
    'CustInfo', 'displaycontactinfo'
);

 

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
#  Display contact information.
my $display_contact = $cpliveapi->api2(
    'CustInfo', 'displaycontactinfo',
);

 

cpapi2 --user=username CustInfo displaycontactinfo

 {  
   "cpanelresult":{  
      "apiversion":2,
      "func":"displaycontactinfo",
      "data":[  
         {  
            "value":"username@example.com",
            "name":"email",
            "descp":"This is an email address at which the system can contact you. This should be an email address that is not on your account.",
            "type":"string",
            "enabled":1
         },
         {  
            "value":"username.2@example.com",
            "name":"second_email",
            "descp":"If you wish to provide a second email address to receive notifications, enter it here.",
            "type":"string",
            "enabled":1
         },
         {  
            "value":1,
            "name":"notify_contact_address_change",
            "descp":"My contact email address changes.",
            "type":"boolean",
            "enabled":1
         },
         {  
            "value":1,
            "name":"notify_contact_address_change_notification_disabled",
            "descp":"My preference for contact email address change notifications is disabled.",
            "type":"boolean",
            "enabled":1
         },
         {  
            "value":1,
            "name":"notify_disk_limit",
            "descp":"My account approaches its disk quota.",
            "type":"boolean",
            "enabled":1
         },
         {  
            "value":1,
            "name":"notify_bandwidth_limit",
            "descp":"My account approaches its bandwidth usage limit.",
            "type":"boolean",
            "enabled":1
         },
         {  
            "value":1,
            "name":"notify_email_quota_limit",
            "descp":"Any of my account's email accounts approaches or is over quota.",
            "type":"boolean",
            "enabled":1
         },
         {  
            "value":1,
            "name":"notify_password_change",
            "descp":"My account's password changes.",
            "type":"boolean",
            "enabled":1
         },
         {  
            "value":1,
            "name":"notify_password_change_notification_disabled",
            "descp":"My preference for account password change notifications is disabled.",
            "type":"boolean",
            "enabled":1
         }
      ],
      "event":{  
         "result":1
      },
      "module":"CustInfo"
   }
}

   

Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
enabledBooleanWhether the notification setting is enabled.
  • 1 — Send notification.
  • 0 — Do not send notification.
1
valuestringThe notification setting's value.
  • A Boolean value, if the type value is boolean.
  • A string value, if the type value is string.
1
typestringThe notification setting's data type.
  • string
  • boolean
string
descpstringThe notification setting's description.A valid string.

This is an email address at which the system can contact you. This should be an email address that is not on your account.

namestringThe notification setting's name.
  • email
  • second_email
  • notify_disk_limit
  • notify_bandwidth_limit
  • notify_contact_address_change
  • notify_contact_address_change_notification_disabled
  • notify_email_quota_limit
  • notify_password_change
  • notify_password_change_notification_disabled
second_email
reasonstring

A reason for failure.

This function only returns a reason value if it failed.

A string that describes the error.

This is an error message.
resultBoolean

Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.
1