EmailVerification

The Single Email Verification Gem is a Ruby library that provides functionality to verify single email addresses. It allows you to easily integrate email verification into your Ruby applications.

Installation

To install the gem, add the following line to your application's Gemfile:

$ gem install 'SingleEmailVerification'

Install the gem and add to the application's Gemfile by executing:

$ bundle nstall

If bundler is not being used to manage dependencies, install the gem by executing:

$ gem install SingleEmailVerification

Usage

To use the Single Email Verification gem, require it in your Ruby code:

require 'emailVerification'

Development

Then, create an instance of the EmailVerification::Client class and use its single_verify method to verify a single email address:

class ClientTest

def initialize
    @client = EmailVerification::Client.new
end

def test_single_verify
    email = 'sahal.abdullah@mslm.io'
    resp = @client.single_verify(email)
    puts resp
end

end

ClientTest.new.test_single_verify

To modify your ClientTest class to allow users to add their API key from the MSL cloud, you can implement a method to set the API key and use it when initializing the EmailVerification::Client. Here's the updated code:

require 'email_verification'

class ClientTest def initialize(api_key = nil) @api_key = api_key @client = EmailVerification::Client.new(api_key: @api_key) end

def set_api_key(api_key) @api_key = api_key @client = EmailVerification::Client.new(api_key: @api_key) end

def test_single_verify email = 'sahal.abdullah@mslm.io' resp = @client.single_verify(email) puts resp end end

Example usage:

Instantiate ClientTest with API key

client_test = ClientTest.new('your_api_key_here')

Alternatively, set API key after instantiation

client_test.set_api_key('your_api_key_here')

Perform single email verification

client_test.test_single_verify

With this modification, users can provide their API key either during initialization or after instantiation using the set_api_key method. This gives them the flexibility to use their MSL cloud API key for unlimited hits.

Sending and Verifying OTPs

The Single Email Verification gem now supports sending OTPs and verifying them. Here's how you can use this feature:

require 'email_verification'

Instantiate the client

client = EmailVerification::Client.new

Sending OTP

otp_send_req = { "phone" => "+921123454456", "tmpl_sms" => "Your verification code is {112233}", "token_len" => 4, "expire_seconds" => 300, }

otp_send_resp = client.send_otp(otp_send_req)

Verifying OTP

otp_verify_req = { "phone" => "+921123454456", "token" => "#{otp}", # Replace otp with the actual OTP entered by the user "consume" => true, }

otp_verify_resp = client.verify(otp_verify_req)

You can change the number of digits in the OTP by modifying the token_len parameter in the otp_send_req hash.

otp_send_req = { ... "token_len" => 6, # Change to the desired length ... } Feel free to incorporate these methods into your Ruby applications for email verification and OTP functionalities.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/sahalAbdullah/emailVerification. Please provide detailed descriptions and steps to reproduce any bugs you encounter.

License

The Single Email Verification gem is available as open source under the terms of the MIT License. You are free to use and modify it as per your requirements.

Code of Conduct

Everyone interacting in the EmailVerification project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.