SMTP Users Calls

/settings/addSmtp

Add a new SMTP User

try:
    import sarv
    sarv_client = sarv.Sarv('owner_id', 'token', 'SarvTES_APP_DOMAIN')
    result = sarv_client.settings.addSmtpUser(total_limit=500, hourly_limit=200)
    print result
    '''
    {
        "status" : "success",
        "message" : "SMTP User Created",
        "smtp_user_name" : "smtp12345",
        "smtp_password" : "asfsf4w343"
    }
    '''
except sarv.Error, e:
    # Sarv errors are thrown as exceptions
    print 'A sarv error occurred: %s - %s' % (e.__class__, e)

{
    "status" : "success",
    "message" : "SMTP User Created",
    "smtp_user_name" : "smtp12345",
    "smtp_password" : "asfsf4w343"
}

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

Parameters
owner_id* string	a valid Sarv User Id
token* string	a valid token
SarvTES_APP_DOMAIN* string	a valid SarvTES APP DOMAIN
total_limit* integer	positive digit
hourly_limit* integer	positive digit

* compulsory field

Return Value: Success
struct the results of newly created SMTP user status string always success message string human readable message smtp_user_name string smtp user name smtp_password string smtp password

Return Value: Error
struct the error results when attempt to create smtp user 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. Sarv Developers will be notified.
AuthenticationError	Provided owner_id and token was not matched.

/settings/editSmtp

Edit SMTP User

try:
    import sarv
    sarv_client = sarv.Sarv('owner_id', 'token', 'SarvTES_APP_DOMAIN')
    result = sarv_client.settings.editSmtp(smtp_user_name="smtp12345", total_limit=1000, hourly_limit=None,status="Enable")
    print result
    '''
    {
        "status" : "success",
        "message" : "SMTP User Updated"
    }
    '''
except sarv.Error, e:
    # Sarv errors are thrown as exceptions
    print 'A sarv error occurred: %s - %s' % (e.__class__, e)

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

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

Parameters
owner_id* string	a valid Sarv User Id
token* string	a valid token
SarvTES_APP_DOMAIN* string	a valid SarvTES APP DOMAIN
smtp_user_name* string	a valid smtp user name
total_limit integer	positive digit
hourly_limit integer	positive digit
status string	value of status is Either 'Enable' OR 'Disable'

* compulsory field

Return Value: Success
struct the results of updated SMTP user status string always success message string human readable message

Return Value: Error
struct the error results when attempt to update smtp user details 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. Sarv Developers will be notified.
AuthenticationError	Provided owner_id and token was not matched.

/settings/resetSmtpPassword

Password Reset for SMTP user

try:
    import sarv
    sarv_client = sarv.Sarv('owner_id', 'token', 'SarvTES_APP_DOMAIN')
    result = sarv_client.settings.resetSmtpPassword(smtp_user_name="smtp12345")
    print result
    '''
    {
        "status" : "success",
        "message" : "password reseted",
        "smtp_user_name" : "smtp12345",
        "smtp_password" : "2fg345gy6r7"
    }
    '''
except sarv.Error, e:
    # Sarv errors are thrown as exceptions
    print 'A sarv error occurred: %s - %s' % (e.__class__, e)

{
    "status" : "success",
    "message" : "password reseted",
    "smtp_user_name" : "smtp12345",
    "smtp_password" : "2fg345gy6r7"
}

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

Parameters
owner_id* string	a valid Sarv User Id
token* string	a valid token
SarvTES_APP_DOMAIN* string	a valid SarvTES APP DOMAIN
smtp_user_name* string	a valid smtp user name

* compulsory field

Return Value:Success
struct the results of password reset for SMTP user status string always 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 attempt to reset password for smtp user 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. Sarv Developers will be notified.
AuthenticationError	Provided owner_id and token was not matched.

/settings/listSmtp

List SMTP users

try:
    import sarv
    sarv_client = sarv.Sarv('owner_id', 'token', 'SarvTES_APP_DOMAIN')
    result = sarv_client.settings.listSmtp()
    print result
    '''
    {
        "status" : "success",
        "smtp_list" :   [
                            {
                                "smtp_user_name" : "smtps456546",
                                "password" : "cgvddgrsd",
                                "status" : "Enable",
                                "total_limit" : 1000,
                                "hourly_limit" : 600
                            },
                            {
                                "smtp_user_name" : "smtps456567",
                                "password" : "fdsdfs",
                                "status" : "Disable",
                                "total_limit" : 100,
                                "hourly_limit" : 30
                            }
                        ]
    }
    '''
except sarv.Error, e:
    # Sarv errors are thrown as exceptions
    print 'A sarv error occurred: %s - %s' % (e.__class__, e)

{
    "status" : "success",
    "smtp_list" :   [
                        {
                            "smtp_user_name" : "smtps456546",
                            "password" : "cgvddgrsd",
                            "status" : "Enable",
                            "total_limit" : 1000,
                            "hourly_limit" : 600
                        },
                        {
                            "smtp_user_name" : "smtps456567",
                            "password" : "fdsdfs",
                            "status" : "Disable",
                            "total_limit" : 100,
                            "hourly_limit" : 30
                        }
                    ]
}

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

Parameters
owner_id* string	a valid Sarv User Id
token* string	a valid token
SarvTES_APP_DOMAIN* string	a valid SarvTES APP DOMAIN

* compulsory field

Return Value: Success
struct the results of List SMTP user status string always success message string human readable message smtp_list[]struct information of single smtp user smtp_user_name string smtp user name smtp_password string smtp password total_limit integer positive digit hourly_limit integer positive digit status integer value of status is Either 'Enable' OR 'Disable'

Return Value: Error
struct the error results when attempt to list smtp user 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. Sarv Developers will be notified.
AuthenticationError	Provided owner_id and token was not matched.