---
title: email
description: Creates an email validation action.
source: /actions/email/email.ts
contributors:
  - fabian-hiller
  - SAY-5
---

import { ApiList, Link, Property } from '~/components';
import { properties } from './properties';

# email

Creates an [email](https://en.wikipedia.org/wiki/Email_address) validation action.

```ts
const Action = v.email<TInput, TMessage>(message);
```

## Generics

- `TInput` <Property {...properties.TInput} />
- `TMessage` <Property {...properties.TMessage} />

## Parameters

- `message` <Property {...properties.message} />

### Explanation

With `email` you can validate the formatting of a string. If the input is not an email, you can use `message` to customize the error message.

> This validation action intentionally only validates common email addresses. If you are interested in an action that covers a broader subset of RFC 5322 addresses, please use the <Link href="../rfcEmail/">`rfcEmail`</Link> action instead.

## Returns

- `Action` <Property {...properties.Action} />

## Examples

The following examples show how `email` can be used.

### Email schema

Schema to validate an email.

```ts
const EmailSchema = v.pipe(
  v.string(),
  v.nonEmpty('Please enter your email.'),
  v.email('The email is badly formatted.'),
  v.maxLength(30, 'Your email is too long.')
);
```

### Optional email schema

Schema to validate an email that is allowed to be an empty string, for example for an optional form field.

```ts
const OptionalEmailSchema = v.optional(
  v.union([
    v.literal(''),
    v.pipe(v.string(), v.email('The email is badly formatted.')),
  ]),
  ''
);
```

## Related

The following APIs can be combined with `email`.

### Schemas

<ApiList items={['any', 'custom', 'string']} />

### Methods

<ApiList items={['pipe']} />

### Utils

<ApiList items={['isOfKind', 'isOfType']} />
