SMTP Users

📘
Do you have any questions on our Email API? Write to us at [email protected]

/settings/addSmtp

Creates a new SMTP user.

Example Request

{
    "owner_id": "example id",
    "token": "example token",
    "total_limit": 1000,
    "hourly_limit": 100
}

Example Success Response

{
    "status": "success",
    "message": "Smtp User Added",
    "smtp_user_name": "smtp12345",
    "smtp_password": "examplepassword"
}

Example Error Response

{
    "status": "error",
    "code": -1,
    "name": "AuthenticationError",
    "message": "Token MissMatch"
}

Parameters

Parameter	Type	Description
owner_id*	string	a valid SendCleanUser Id
token*	string	a valid token
total_limit*	integer	total sending limit for the SMTP user
hourly_limit*	integer	hourly sending limit for the SMTP user

*compulsory field

Return Value: Success

struct — the results of adding an SMTP user

Field	Type	Description
status	string	success
message	string	human readable message
smtp_user_name	string	newly created SMTP user name
smtp_password	string	newly created SMTP password

Return Value: Error

struct — the error results when attempting to add an SMTP user

Field	Type	Description
status	string	error
message	string	human readable message
type	string	one of the error types listed below

Error Types

ValidationError — The parameters passed to the API call are invalid or not provided when required.

GeneralError — An unexpected error occurred processing the request. SendClean Developers will be notified.

AuthenticationError — Provided owner_id and token was not matched.

/settings/editSmtp

Modifies an existing SMTP user.

Example Request

{
    "owner_id": "example id",
    "token": "example token",
    "smtp_user_name": "smtp12345",
    "total_limit": 2000,
    "hourly_limit": 200,
    "status": "Enable"
}

Example Success Response

{
    "status": "success",
    "message": "Smtp User Updated"
}

Example Error Response

{
    "status": "error",
    "code": -1,
    "name": "AuthenticationError",
    "message": "Token MissMatch"
}

Parameters

Parameter	Type	Description
owner_id*	string	a valid SendCleanUser Id
token*	string	a valid token
smtp_user_name*	string	a valid SMTP user name
total_limit	integer	updated total sending limit
hourly_limit	integer	updated hourly sending limit
status	string	Enable or Disable

*compulsory field

Return Value: Success

struct — the results of editing an SMTP user

Field	Type	Description
status	string	success
message	string	human readable message

Return Value: Error

struct — the error results when attempting to edit an SMTP user

Field	Type	Description
status	string	error
message	string	human readable message
type	string	one of the error types listed below

Error Types

ValidationError — The parameters passed to the API call are invalid or not provided when required.

GeneralError — An unexpected error occurred processing the request. SendClean Developers will be notified.

AuthenticationError — Provided owner_id and token was not matched.

/settings/resetSmtpPassword

Resets the password for an existing SMTP user.

Example Request

{
    "owner_id": "example id",
    "token": "example token",
    "smtp_user_name": "smtp12345"
}

Example Success Response

{
    "status": "success",
    "message": "Smtp Password Reset",
    "smtp_user_name": "smtp12345",
    "smtp_password": "newexamplepassword"
}

Example Error Response

{
    "status": "error",
    "code": -1,
    "name": "AuthenticationError",
    "message": "Token MissMatch"
}

Parameters

Parameter	Type	Description
owner_id*	string	a valid SendCleanUser Id
token*	string	a valid token
smtp_user_name*	string	a valid SMTP user name

*compulsory field

Return Value: Success

struct — the results of resetting SMTP password

Field	Type	Description
status	string	success
message	string	human readable message
smtp_user_name	string	SMTP user name
smtp_password	string	new SMTP password

Return Value: Error

struct — the error results when attempting to reset SMTP password

Field	Type	Description
status	string	error
message	string	human readable message
type	string	one of the error types listed below

Error Types

ValidationError — The parameters passed to the API call are invalid or not provided when required.

GeneralError — An unexpected error occurred processing the request. SendClean Developers will be notified.

AuthenticationError — Provided owner_id and token was not matched.

/settings/listSmtp

Retrieves all SMTP users associated with an account.

Example Request

{
    "owner_id": "example id",
    "token": "example token"
}

Example Success Response

{
    "status": "success",
    "smtp_data": [
        {
            "smtp_user_name": "smtp12345",
            "smtp_password": "examplepassword",
            "status": "Enable",
            "total_limit": 1000,
            "hourly_limit": 100
        }
    ]
}

Example Error Response

{
    "status": "error",
    "code": -1,
    "name": "AuthenticationError",
    "message": "Token MissMatch"
}

Parameters

Parameter	Type	Description
owner_id*	string	a valid SendCleanUser Id
token*	string	a valid token

*compulsory field

Return Value: Success

struct — the results of listing SMTP users

Field	Type	Description
status	string	success
smtp_data	array	array of SMTP user objects

**smtp_data[]**fields:

Field	Type	Description
smtp_user_name	string	SMTP user name
smtp_password	string	SMTP password
status	string	Enable or Disable
total_limit	integer	total sending limit
hourly_limit	integer	hourly sending limit

Return Value: Error

struct — the error results when attempting to list SMTP users

Field	Type	Description
status	string	error
message	string	human readable message
type	string	one of the error types listed below

Error Types

ValidationError — The parameters passed to the API call are invalid or not provided when required.

GeneralError — An unexpected error occurred processing the request. SendClean Developers will be notified.

AuthenticationError — Provided owner_id and token was not matched.