# About the Sender Emails APIs

With Sender Emails you create create and verify "from" and "reply-to" email addresses for email campaigns. Verification ensures that emails are delivered successfully and not flagged as spam. The process involves creating a sender email, sending a verification code, and then verifying the email using the code received.

@package_metadata:@wix/sender-emails

To use the SenderEmails API, install the `@wix/sender-emails` package.

#### Install the package

Follow the installation instructions for your development environment.

| Development environment | Installation method |
|--|--|
| Wix sites (editor or IDE) | Use the [package manager](fallback::https://dev.wix.com/docs/develop-websites/articles/coding-with-velo/packages/work-with-npm-packages-in-the-editor). |
| Wix sites (local IDE) | Run `wix install @wix/sender-emails` using the [Wix CLI](fallback::https://dev.wix.com/docs/develop-websites/articles/coding-with-velo/packages/work-with-npm-packages-with-the-wix-cli).|
| Blocks apps | Use the same installation method as Wix sites. |
| CLI and self-hosted apps | Run `npm install @wix/sender-emails` or `yarn add @wix/sender-emails`. |
| Headless sites and apps | Run `npm install @wix/sender-emails` or `yarn add @wix/sender-emails`. |

#### Import the package

To import the package in your code:

```js
import { senderEmails } from '@wix/sender-emails'
```

Coding Examples

Sled Tests

Go Headless

Build Apps

Client

API Preview

Ricos

Develop Websites

REST

Velo

Picasso

GraphQL (Alpha)

SenderEmails

Sender Emails 1 0 0

senderEmail

SenderEmail

import { senderEmails } from '@wix/sender-emails';

async function createSenderEmail(senderEmail) {
  const response = await senderEmails.createSenderEmail(senderEmail);
};

createSenderEmail

import { senderEmails } from '@wix/sender-emails';
import { auth } from '@wix/essentials';

async function myCreateSenderEmailMethod(senderEmail) {
  const elevatedCreateSenderEmail = auth.elevate(senderEmails.createSenderEmail);
  const response = await elevatedCreateSenderEmail(senderEmail);
}

createSenderEmail (with elevated permissions)

import { createClient } from '@wix/sdk';
import { senderEmails } from '@wix/sender-emails';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { senderEmails },
  // Include the auth strategy and host as relevant
});


async function createSenderEmail(senderEmail) {
  const response = await myWixClient.senderEmails.createSenderEmail(senderEmail);
};

Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).

createSenderEmail (self-hosted)

Access Verticals by Automations

Set Up Automations

Manage Stores

senderEmailId

string

import { senderEmails } from '@wix/sender-emails';

async function deleteSenderEmail(senderEmailId) {
  const response = await senderEmails.deleteSenderEmail(senderEmailId);
};

deleteSenderEmail

import { senderEmails } from '@wix/sender-emails';
import { auth } from '@wix/essentials';

async function myDeleteSenderEmailMethod(senderEmailId) {
  const elevatedDeleteSenderEmail = auth.elevate(senderEmails.deleteSenderEmail);
  const response = await elevatedDeleteSenderEmail(senderEmailId);
}

deleteSenderEmail (with elevated permissions)

import { createClient } from '@wix/sdk';
import { senderEmails } from '@wix/sender-emails';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { senderEmails },
  // Include the auth strategy and host as relevant
});


async function deleteSenderEmail(senderEmailId) {
  const response = await myWixClient.senderEmails.deleteSenderEmail(senderEmailId);
};

deleteSenderEmail (self-hosted)

void

emailAddress

Retrieve the sender email info by the email address, or creates a new one.

If you try to create an email with a name that already exists, this method won't return an error. Instead, the info of the existing sender email will be returned.

import { senderEmails } from '@wix/sender-emails';

async function getOrCreateSenderEmail(emailAddress) {
  const response = await senderEmails.getOrCreateSenderEmail(emailAddress);
};

getOrCreateSenderEmail

import { senderEmails } from '@wix/sender-emails';
import { auth } from '@wix/essentials';

async function myGetOrCreateSenderEmailMethod(emailAddress) {
  const elevatedGetOrCreateSenderEmail = auth.elevate(senderEmails.getOrCreateSenderEmail);
  const response = await elevatedGetOrCreateSenderEmail(emailAddress);
}

getOrCreateSenderEmail (with elevated permissions)

import { createClient } from '@wix/sdk';
import { senderEmails } from '@wix/sender-emails';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { senderEmails },
  // Include the auth strategy and host as relevant
});


async function getOrCreateSenderEmail(emailAddress) {
  const response = await myWixClient.senderEmails.getOrCreateSenderEmail(emailAddress);
};

getOrCreateSenderEmail (self-hosted)

GetOrCreateSenderEmailResponse

import { senderEmails } from '@wix/sender-emails';

async function getSenderEmail(senderEmailId) {
  const response = await senderEmails.getSenderEmail(senderEmailId);
};

getSenderEmail

import { senderEmails } from '@wix/sender-emails';
import { auth } from '@wix/essentials';

async function myGetSenderEmailMethod(senderEmailId) {
  const elevatedGetSenderEmail = auth.elevate(senderEmails.getSenderEmail);
  const response = await elevatedGetSenderEmail(senderEmailId);
}

getSenderEmail (with elevated permissions)

import { createClient } from '@wix/sdk';
import { senderEmails } from '@wix/sender-emails';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { senderEmails },
  // Include the auth strategy and host as relevant
});


async function getSenderEmail(senderEmailId) {
  const response = await myWixClient.senderEmails.getSenderEmail(senderEmailId);
};

getSenderEmail (self-hosted)

options

ListSenderEmailsOptions

import { senderEmails } from '@wix/sender-emails';

async function listSenderEmails(options) {
  const response = await senderEmails.listSenderEmails(options);
};

listSenderEmails

import { senderEmails } from '@wix/sender-emails';
import { auth } from '@wix/essentials';

async function myListSenderEmailsMethod(options) {
  const elevatedListSenderEmails = auth.elevate(senderEmails.listSenderEmails);
  const response = await elevatedListSenderEmails(options);
}

listSenderEmails (with elevated permissions)

import { createClient } from '@wix/sdk';
import { senderEmails } from '@wix/sender-emails';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { senderEmails },
  // Include the auth strategy and host as relevant
});


async function listSenderEmails(options) {
  const response = await myWixClient.senderEmails.listSenderEmails(options);
};

listSenderEmails (self-hosted)

ListSenderEmailsResponse

ID of the sender email to send the code for.

Sends the verification code to the created sender email's inbox.

> **Note:** If the code wasn't received, check the spam folder. If it's not there, try to send the verification email again.

import { senderEmails } from '@wix/sender-emails';

async function sendVerificationCode(senderEmailId) {
  const response = await senderEmails.sendVerificationCode(senderEmailId);
};

sendVerificationCode

import { senderEmails } from '@wix/sender-emails';
import { auth } from '@wix/essentials';

async function mySendVerificationCodeMethod(senderEmailId) {
  const elevatedSendVerificationCode = auth.elevate(senderEmails.sendVerificationCode);
  const response = await elevatedSendVerificationCode(senderEmailId);
}

sendVerificationCode (with elevated permissions)

import { createClient } from '@wix/sdk';
import { senderEmails } from '@wix/sender-emails';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { senderEmails },
  // Include the auth strategy and host as relevant
});


async function sendVerificationCode(senderEmailId) {
  const response = await myWixClient.senderEmails.sendVerificationCode(senderEmailId);
};

sendVerificationCode (self-hosted)

Verification code that was received in the sender email's inbox.

verificationCode

Verifies a sender email by passing the verification code that was received in the sender email's inbox.

import { senderEmails } from '@wix/sender-emails';

async function verifySenderEmail(senderEmailId, verificationCode) {
  const response = await senderEmails.verifySenderEmail(senderEmailId, verificationCode);
};

verifySenderEmail

import { senderEmails } from '@wix/sender-emails';
import { auth } from '@wix/essentials';

async function myVerifySenderEmailMethod(senderEmailId, verificationCode) {
  const elevatedVerifySenderEmail = auth.elevate(senderEmails.verifySenderEmail);
  const response = await elevatedVerifySenderEmail(senderEmailId, verificationCode);
}

verifySenderEmail (with elevated permissions)

import { createClient } from '@wix/sdk';
import { senderEmails } from '@wix/sender-emails';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { senderEmails },
  // Include the auth strategy and host as relevant
});


async function verifySenderEmail(senderEmailId, verificationCode) {
  const response = await myWixClient.senderEmails.verifySenderEmail(senderEmailId, verificationCode);
};

verifySenderEmail (self-hosted)

---
title: Introduction
---

# About Sender Emails

<div style="background-color: #FEF1D1; padding: 18px 24px; border-radius: 6px; border: 1px solid #FDB10C; box-sizing: border-box; display: inline-block">
    <b>Developer Preview</b>
    <br/>
    <span>APIs in <a href="https://www.wix.com/velo/reference/api-overview/developer-preview">Developer Preview</a> are subject to change and are not intended for use in production.<br/><a href="mailto:velo-preview-feedback@wix.com">Send us</a> your suggestions for improving this API. Your feedback is valuable to us.</span>
</div>

&nbsp;

When sending an [email campaign](https://dev.wix.com/docs/sdk/backend-modules/email-marketing/campaigns/introduction), you are required to confirm your email address to ensure that your letter reaches its destination. With the Sender Email API, you can create and verify "from" and "reply-to" email addresses for your email campaign. Once verified, these emails are used to create and manage different senders using the [Sender Details](https://dev.wix.com/docs/sdk/backend-modules/sender-details/sender-details/introduction) API.

With the Sender Email API you can:

- [Create](https://dev.wix.com/docs/sdk/backend-modules/sender-emails/sender-emails/create-sender-email) and [delete](https://dev.wix.com/docs/sdk/backend-modules/sender-emails/sender-emails/delete-sender-email) sender emails.
- [Get](https://dev.wix.com/docs/sdk/backend-modules/sender-emails/sender-emails/get-sender-email) information about a sender email.
- [Verify](https://dev.wix.com/docs/sdk/backend-modules/sender-emails/sender-emails/verify-sender-email) sender emails.

## Sender email verification flow

The following steps describe the process for verifying an email address using the Sender Email API:

1. Call [Create Sender Email](https://dev.wix.com/docs/sdk/backend-modules/sender-emails/sender-emails/create-sender-email) and specify the email address you'd like to use.
1. Call [Send Verification Code](https://dev.wix.com/docs/sdk/backend-modules/sender-emails/sender-emails/send-verification-code) and check your inbox for the verification code.
1. Use the received verification code to call [Verify Sender Email](https://dev.wix.com/docs/sdk/backend-modules/sender-emails/sender-emails/verify-sender-email) and verify the email address.

## Before you begin

It's important to note the following:

- You'll get the verification code to the email address you specify, so ensure you have access to that inbox.
- If you haven't received your code, check the spam folder. If it's not there, try sending the verification email again.
- Usually, your verified email address will be used as both the "from" and "reply-to" address. However, there are cases where campaigns are sent from an authenticated address owned by Wix:
  - When your verified email uses a publicly available mailbox provider domain, such as @gmail, @yahoo, or @outlook. For example, if your email is `pianosinfo@gmail.com` it will appear as the "reply-to" address, while the "from" address will be something like `pianos@pb01.wixemails.com` or `pianos@wixsiteautomations.com`. This ensures that your email reaches your recipients' inbox rather than their junk folder or being rejected entirely. 
  - When the domain of your verified email is not properly authenticated and has a strict [DMARC](https://dmarc.org/) policy configured.


## Terminology

- **Campaign:** A single, organized effort to send marketing emails to a list of recipients.
- **Sender Email:** The "sent from" email address used in email campaigns.
- **Reply-to Email:** The email address where recipients can send their replies to a marketing campaign.

@package_metadata:@wix/sender-emails

To use the SenderEmails API, install the `@wix/sender-emails` package.

#### Install the package

Follow the installation instructions for your development environment.

| Development environment | Installation method |
|--|--|
| Wix sites (editor or IDE) | Use the [package manager](https://dev.wix.com/docs/develop-websites/articles/coding-with-velo/packages/work-with-npm-packages-in-the-editor). |
| Wix sites (local IDE) | Run `wix install @wix/sender-emails` using the [Wix CLI](https://dev.wix.com/docs/develop-websites/articles/coding-with-velo/packages/work-with-npm-packages-with-the-wix-cli).|
| Blocks apps | Use the same installation method as Wix sites. |
| CLI and self-hosted apps | Run `npm install @wix/sender-emails` or `yarn add @wix/sender-emails`. |
| Headless sites and apps | Run `npm install @wix/sender-emails` or `yarn add @wix/sender-emails`. |

#### Import the package

To import the package in your code:

```js
import { senderEmails } from '@wix/sender-emails'
```
  

sender-emails_sender-emails

CursorPaging

Pointer to the next or previous page in the list of results.
You can get the relevant cursor token from the `pagingMetadata` object in the previous call's response.
Not relevant for the first request.

cursor

limit

number

CursorPagingMetadata

Number of items returned in the response.

count

cursors

Cursors

Indicates if there are more results after the current page.
If `true`, another page of results can be retrieved.
If `false`, this is the last page.

hasNext

boolean

Cursor pointing to next page in the list of results.

ExtendedFields

Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
The value of each key is structured according to the schema defined when the extended fields were configured.

You can only access fields for which you have the appropriate permissions.

Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).

namespaces

Provide a specific email address if you don't want to receive all of a site's sender email addresses.

verifySenderEmail( )