EmailField - Django Models

EmailField is a CharField that checks the value for a valid email address using EmailValidator. EmailValidator validates a email through predefined regex which checks '@' and a '.' defined after it. One can change the regex by exploring options from EmailValidator itself. Syntax

field_name = models.EmailField(max_length=254, **options)

EmailField has one extra required argument:

EmailField.max_length

The maximum length (in characters) of the field. The max_length is enforced at the database level and in Django’s validation using MaxLengthValidator.

Django Model EmailField Explanation

Illustration of EmailField using an Example. Consider a project named geeksforgeeks having an app named geeks.

Refer to the following articles to check how to create a project and an app in Django.

• How to Create a Basic Project using MVT in Django?
• How to Create an App in Django ?

Enter the following code into models.py file of geeks app. 

from django.db import models
from django.db.models import Model
# Create your models here.

class GeeksModel(Model):
    geeks_field = models.EmailField(max_length = 254)

Add the geeks app to INSTALLED_APPS 

# Application definition

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'geeks',
]

Now when we run makemigrations command from the terminal,

Python manage.py makemigrations

A new folder named migrations would be created in geeks directory with a file named 0001_initial.py 

# Generated by Django 2.2.5 on 2019-09-25 06:00

from django.db import migrations, models

class Migration(migrations.Migration):

    initial = True

    dependencies = [
    ]

    operations = [
        migrations.CreateModel(
            name ='GeeksModel',
            fields =[
                ('id', 
                  models.AutoField(
                  auto_created = True,
                  primary_key = True,
                  serialize = False, 
                  verbose_name ='ID'
                )),
                ('geeks_field', models.EmailField( max_length = 254 )),
            ],
        ),
    ]

Now run,

Python manage.py migrate

Thus, an geeks_field EmailField is created when you run migrations on the project. It is a field to store email address in database.

How to use EmailField ?

EmailField is used for storing an email address in the database. One can store email id form any domain. Let's try storing an email id instance in model created above. 

# importing the model
# from geeks app
from geeks.models import GeeksModel

# creating a string
d = "[email protected]"

# creating an instance of 
# GeeksModel
geek_object = GeeksModel.objects.create(geeks_field = d)
geek_object.save()

Now let's check it in admin server. We have created an instance of GeeksModel.

Field Options

Field Options are the arguments given to each field for applying some constraint or imparting a particular characteristic to a particular Field. For example, adding an argument null = True to EmailField will enable it to store empty values for that table in relational database. Here are the field options and attributes that a EmailField can use.