email-sender-verifier

Email Verifier is a python library designed for sending One-Time-Passwords (OTP) and performing code verification via email.


License
MIT
Install
pip install email-sender-verifier==2.3.1

Documentation

Static Badge Static Badge Static Badge

Email Sender Verifier

logo

Email Sender Verifier is a python library designed for sending One-Time-Password (OTP) and performing code verification via email. This library is ideal for web applications that require a secure and straightforward method to authenticate users through email-based account verification ans OTPs.

Installation

Install Email Sender Verifier using pip.

CLI:

   pip install email-sender-verifier
   pip install https://github.com/christiangarcia0311/email-sender-verifier/raw/main/dist/email_sender_verifier-2.1.2.tar.gz

Features

  • Email Sending: Send emails with customizable subject, body and recipient.
  • Easy Integration: Suitable for integration into web applications requiring email-based OTP and code verification.

Usage

Email Sender class import:

    
    # import email sender class
    from Verifier.email import EmailSender
    
    # create new email sender object
    emailsender = EmailSender()

Email Sender method:

    """
    email_reciever (str): Specifies the recipient's email address where the email will be sent.
    msg_subject (str): Sets the subject line of the email.
    msg_body (str): Contains the main content of the email message.
    sender_name (str): holds the name of the sender
    
    """
    
    # email sender method
    emailsender.send_email(email_reciever, msg_subject, msg_body, sender_name)

Example 1 (Sending sample message):

    
    # define the email details 
    email = 'username@gmail.com'
    subject = 'Sending email message using python.'
    body = 'This is example message from the author'
    name = 'Administrator'
    
    # email sender method
    emailsender.send_email(email, subject, body, name)

Example 2 (Using pyotp library):

    
    # Secret key for pyotp
    secret_key = pyotp.random_base32()
    
    # Generate One-Time-Password using pyotp library
    totp = pyotp.TOTP(secret_key, interval=60)
    
    # define the email details
    email = 'username@gmail.com'
    subject = 'One-Time-Password using pyotp library'
    body = f'Your OTP code is: {totp.now()}'
    name = 'Admin'
    #email sender method
    emailsender.send_email(email, subject, body, name)

Example 3 (web-based otp verification using email sender):

web-based

LICENSE

Static Badge

Author

Static Badge

Contact

For issues or feature requests, please open an issue on GitHub. Contributions, feature requests, and feedback are all welcome!