NODEJS

Choose Language

Sending Domains Calls

Info! This is Beta version if you have any problem in using Api please mail us at support@sendclean.com

/settings/addSendingDomain

Add a new Sending Domains

Example Call

            
var SendClean= require('./SendClean.js');
var SendClean_client = new SendClean.SendClean('owner_id', 'token', 'SendCleanTES_APP_DOMAIN');
SendClean_client.settings.addSendingDomain({domain:"abc.com"}, function(result) {
    console.log(result);
    /*
    {
        "status" : "success",
        "message" : "Sending Domain Added"
    }
     */
    
}, function(e) {
    // SendCleanreturns the error as an object with name and message keys
    console.log('A SendCleanerror occurred: ' + e.name + ' - ' + e.message);
});

Example Success Response


{
    "status" : "success",
    "message" : "Sending Domain Added"
}

Example Error Response


{
    "status"=> "error",
    "code"=> -1,
    "name"=> "AuthenticationError",
    "message"=> "Token MissMatch"
}
Parameters
owner_id* string a valid SendCleanUser Id
token* string a valid token
SendCleanTES_APP_DOMAIN* string a valid SendCleanTES APP DOMAIN
domain* string domain name
* compulsory field
Return Value: Success
struct the results of newly Added Domain
status string always success
message string human readable message
Return Value: Error
struct the error results when attempt to add domain
status string error
message string human readable message
type string one of the error type as bellow table
Error types
ValidationError The parameters passed to the API call are invalid or not provided when required.
GeneralError An unexpected errors occurred processing the request. SendCleanDevelopers will be notified.
AuthenticationError Provided owner_id and token was not matched.

/settings/checkSendingDomain

check Sending Domain

Example Call

            
var SendClean= require('./SendClean.js');
var SendClean_client = new SendClean.SendClean('owner_id', 'token', 'SendCleanTES_APP_DOMAIN');
SendClean_client.settings.checkSendingDomain({domain:"abc.com"}, function(result) {
    console.log(result);
    /*
    {
        "status" : "success",
        "domain" : "abc.com",
        "dkim" : {"valid" : "Yes"},
        "spf" : {"valid" : "No"},
        "valid_tracking" : "No"
    }
     */
    
}, function(e) {
    // SendCleanreturns the error as an object with name and message keys
    console.log('A SendCleanerror occurred: ' + e.name + ' - ' + e.message);
});

Example Success Response


{
    "status" : "success",
    "domain" : "abc.com",
    "dkim" : {"valid" : "Yes"},
    "spf" : {"valid" : "No"},
    "valid_tracking" : "No"
}

Example Error Response


{
    "status"=> "error",
    "code"=> -1,
    "name"=> "AuthenticationError",
    "message"=> "Token MissMatch"
}
Parameters
owner_id* string a valid SendCleanUser Id
token* string a valid token
SendCleanTES_APP_DOMAIN* string a valid SendCleanTES APP DOMAIN
domain* string domain name
* compulsory field
Return Value: Success
struct the results of verify dkim and spf
status string always success
message string human readable message
dkim[]struct dkim validation result
valid string value is either 'Yes' OR 'No'
spf[]struct spf validation result
valid string value is either 'Yes' OR 'No'
valid_signing string value is either 'Yes' OR 'No'
Return Value: Error
struct the error results when attempt verify dkim and spf
status string error
message string human readable message
type string one of the error type as bellow table
Error types
ValidationError The parameters passed to the API call are invalid or not provided when required.
GeneralError An unexpected errors occurred processing the request. SendCleanDevelopers will be notified.
AuthenticationError Provided owner_id and token was not matched.

/settings/verifySendingDomain

Verify Sending Domain

Example Call

            
var SendClean= require('./SendClean.js');
var SendClean_client = new SendClean.SendClean('owner_id', 'token', 'SendCleanTES_APP_DOMAIN');
SendClean_client.settings.verifySendingDomain({domain:"abc.com", mailbox:"john@abc"}, function(result) {
    console.log(result);
    /*
    {
        "status" : "success",
        "message" : "Verification instruction has been sent to john@abc.com"
    }
     */
    
}, function(e) {
    // SendCleanreturns the error as an object with name and message keys
    console.log('A SendCleanerror occurred: ' + e.name + ' - ' + e.message);
});

Example Success Response


{
    "status" : "success",
    "message" : "Verification instruction has been sent to john@abc.com"
}

Example Error Response


{
    "status"=> "error",
    "code"=> -1,
    "name"=> "AuthenticationError",
    "message"=> "Token MissMatch"
}
Parameters
owner_id* string a valid SendCleanUser Id
token* string a valid token
SendCleanTES_APP_DOMAIN* string a valid SendCleanTES APP DOMAIN
domain* string domain name
mailbox* string mailbox name
* compulsory field
Return Value: Success
struct the results of Verify sending domain
status string always success
message string human readable message
Return Value: Error
struct the error results when attempt to verify Sending Domain
status string error
message string human readable message
type string one of the error type as bellow table
Error types
ValidationError The parameters passed to the API call are invalid or not provided when required.
GeneralError An unexpected errors occurred processing the request. SendCleanDevelopers will be notified.
AuthenticationError Provided owner_id and token was not matched.

/settings/listSendingDomain

List Sending Domain

Example Call

            
var SendClean= require('./SendClean.js');
var SendClean_client = new SendClean.SendClean('owner_id', 'token', 'SendCleanTES_APP_DOMAIN');
SendClean_client.settings.listSendingDomain({}, function(result) {
    console.log(result);
    /*
    {
        "status" : "success",
        "sending_domain_list" :     [
                                        {
                                            "domain":"abc.com",
                                            "create_date":67457775764,
                                            "dkim":{"valid" : "Yes"},
                                            "spf":{"valid" : "Yes"},
                                            "verify_domain":{"valid" : "Yes"}
                                        },
                                        {
                                            "domain":"xyz.com",
                                            "create_date":67457775891,
                                            "dkim":{"valid" : "Yes"},
                                            "spf":{"valid" : "Yes"},
                                            "verify_domain":{"valid" : "No"}
                                        }
                                    ]
    }
     */
    
}, function(e) {
    // SendCleanreturns the error as an object with name and message keys
    console.log('A SendCleanerror occurred: ' + e.name + ' - ' + e.message);
});

Example Success Response


{
    "status" : "success",
    "sending_domain_list"   :   [
                                    {
                                        "domain":"abc.com",
                                        "create_date":67457775764,
                                        "dkim":{"valid" : "Yes"},
                                        "spf":{"valid" : "Yes"},
                                        "verify_domain":{"valid" : "Yes"}
                                    },
                                    {
                                        "domain":"xyz.com",
                                        "create_date":67457775891,
                                        "dkim":{"valid" : "Yes"},
                                        "spf":{"valid" : "Yes"},
                                        "verify_domain":{"valid" : "No"}
                                    }
                                ]
}

Example Error Response


{
    "status"=> "error",
    "code"=> -1,
    "name"=> "AuthenticationError",
    "message"=> "Token MissMatch"
}
Parameters
owner_id* string a valid SendCleanUser Id
token* string a valid token
SendCleanTES_APP_DOMAIN* string a valid SendCleanTES APP DOMAIN
* compulsory field
Return Value: Success
struct the results of List Sending Domain
status string always success
message string human readable message
sending_domain_list[]struct information of single Sending Domain
domain string domain name
create_date integer create date in micro seconds
dkim[]struct dkim validation result
valid string value is Either 'Yes' OR 'No'
spf[]struct spf validation result
valid string value is Either 'Yes' OR 'No'
verify_domain[]struct verify_domain validation result
valid string value is Either 'Yes' OR 'No'
Return Value: Error
struct the error results when attempt to list Sending Domain
status string error
message string human readable message
type string one of the error type as bellow table
Error types
ValidationError The parameters passed to the API call are invalid or not provided when required.
GeneralError An unexpected errors occurred processing the request. SendCleanDevelopers will be notified.
AuthenticationError Provided owner_id and token was not matched.

/settings/deleteSendingDomain

Delete Sending Domain

Example Call

            
var SendClean= require('./SendClean.js');
var SendClean_client = new SendClean.SendClean('owner_id', 'token', 'SendCleanTES_APP_DOMAIN');
SendClean_client.settings.deleteSendingDomain({domain:"abc.com"}, function(result) {
    console.log(result);
    /*
    {
        "status" : "success",
        "message" : "Sending Domain Deleted"
    }
     */
    
}, function(e) {
    // SendCleanreturns the error as an object with name and message keys
    console.log('A SendCleanerror occurred: ' + e.name + ' - ' + e.message);
});

Example Success Response


{
    "status" : "success",
    "message" : "Sending Domain Deleted"
}

Example Error Response


{
    "status"=> "error",
    "code"=> -1,
    "name"=> "AuthenticationError",
    "message"=> "Token MissMatch"
}
Parameters
owner_id* string a valid SendCleanUser Id
token* string a valid token
SendCleanTES_APP_DOMAIN* string a valid SendCleanTES APP DOMAIN
domain* string domain name
* compulsory field
Return Value: Success
struct the results of Delete sending domain
status string always success
message string human readable message
Return Value: Error
struct the error results when attempt to Delete Sending Domain
status string error
message string human readable message
type string one of the error type as bellow table
Error types
ValidationError The parameters passed to the API call are invalid or not provided when required.
GeneralError An unexpected errors occurred processing the request. SendCleanDevelopers will be notified.
AuthenticationError Provided owner_id and token was not matched.