Go Headless

Build Apps

Client

API Preview

Develop Websites

REST

Velo

GraphQL (Alpha)

Retrieves sender details.

The sender details include the information displayed as the email sender's name and email address.

+ If you send an email campaign with a public email domain (e.g. @gmail.com or @yahoo.com), the email address will not be displayed in the 'from' header. Instead, the email address is replaced with @wixemails.com (or @wixsitemail.com for free users), and the sender's email is placed in the 'reply-to' header.

+ If you send an email campaign with an email from a Wix managed domain, that email will be displayed in the 'from' header.

+ If you send an email from a custom domain that is not managed by Wix, a line will be inserted that states that the email was sent via wixemails.com.

import { senderDetails } from 'wix-email-marketing.v2';

export async function getSenderDetails() {
    try {
      const result = await senderDetails.getSenderDetails();

      console.log(`Success! Your sender details have been retrieved.`)
      return result;
    } catch (error) {
      console.error(error);
    }
}

/* Promise returns:
 * {
 *   "senderDetails": {
 *     "fromName": "User Name",
 *     "fromEmail": "username@wix.com",
 *     "dateVerified": "2023-08-10T09:24:14.729Z"
 *   }
 * }
 */

Retrieves the details of the sender (dashboard page code)

import { Permissions, webMethod } from 'wix-web-module';
import { senderDetails } from 'wix-email-marketing.v2';

export const getSenderDetails = webMethod(Permissions.Anyone, async () => {
    try {
      const result = await senderDetails.getSenderDetails();

      console.log(`Success! Your sender details have been retrieved.`)
      return result;
    } catch (error) {
      console.error(error);
    }
});

/* Promise returns:
 * {
 *   "senderDetails": {
 *     "fromName": "User Name",
 *     "fromEmail": "username@wix.com",
 *     "dateVerified": "2023-08-10T09:24:14.729Z"
 *   }
 * }
 */


Retrieves the details of the sender (export from backend code)

getSenderDetails

GetSenderDetailsResponse

User's provided address from which to send email marketing campaign.

fromAddress

string

Checks if the sender's email address will be used as from-address or replaced (not related to current sender details).

import { senderDetails } from 'wix-email-marketing.v2';

export async function myResolveActualFromAddressFunction(fromAddress) {
  try {
    const result = await senderDetails.resolveActualFromAddress(fromAddress);

    console.log('Success! From address has been resolved.')
    return result;
  } catch (error) {
    console.error(error);
  }
}

/* Promise returns:
 * {
 *   "actualFromAddress": "myaddress@wix.com"
 * }
 */

Compares the sender address against a replacement address (dashboard page code)

import { Permissions, webMethod } from 'wix-web-module';
import { senderDetails } from 'wix-email-marketing.v2';

export const myResolveActualFromAddressFunction = webMethod(Permissions.Anyone, async (fromAddress) => {
  try {
    const result = await senderDetails.resolveActualFromAddress(fromAddress);

    console.log('Success! From address has been resolved.')
    return result;
  } catch (error) {
    console.error(error);
  }
});

/* Promise returns:
 * {
 *   "actualFromAddress": "myaddress@wix.com"
 * }
 */


Compares the sender address against a replacement address (export from backend code)

resolveActualFromAddress

ResolveActualFromAddressResponse

senderDetails

SenderDetails

Updates sender details.

If the `fromEmail` is changed, a verification code will be sent to the new email address.

If verification is needed, a verification email will be sent to the user, and the returned `verificationNeeded` value will be `true`.

import { senderDetails } from 'wix-email-marketing.v2';

// Sample object: 
// {
//   "senderDetails": {
//       "fromName": "User",
//       "fromEmail": "newemail@address.com"
//   }
// }

export async function myUpdateSenderDetailsFunction(senderDetails) {
    try {
      const result = await senderDetails.updateSenderDetails;

      console.log(`Success! SenderDetails updated.`)
      return result;
    } catch (error) {
      console.error(error);
    }
}

/* Promise returns:
 * {
 *   verificationNeeded: true
 * }
 */

Updates sender details (dashboard page code)

import { Permissions, webMethod } from 'wix-web-module';
import { senderDetails } from 'wix-email-marketing.v2';

// Sample object: 
// {
//   "senderDetails": {
//       "fromName": "User",
//       "fromEmail": "newemail@address.com"
//   }
// }

export const myUpdateSenderDetailsFunction = webMethod(Permissions.Anyone, async (senderDetails) => {
    try {
      const result = await senderDetails.updateSenderDetails;

      console.log(`Success! SenderDetails updated.`)
      return result;
    } catch (error) {
      console.error(error);
    }
});

/* Promise returns:
 * {
 *   verificationNeeded: true
 * }
 */


Updates sender details (export from backend code)

updateSenderDetails

UpdateSenderDetailsResponse

verificationCode

Verifies the sender's email using a verification code sent to the user's email address upon update.

import { senderDetails } from 'wix-email-marketing.v2';

// Sample verificationCode: "Sw4e7"

export async function myVerifyEmailFunction(verificationCode) {
  try {
    const result = await senderDetails.verifyEmail(verificationCode);
    
    console.log('Success! Your email address has been verified')
    return result;
  } catch (error) {
    console.error(error);
  }
}

/* Promise returns void */

Verifies an updated sender address with a verification code (dashboard page code)

import { Permissions, webMethod } from 'wix-web-module';
import { senderDetails } from 'wix-email-marketing.v2';

// Sample verificationCode: "Sw4e7"

export const myVerifyEmailFunction = webMethod(Permissions.Anyone, async (verificationCode) => {
  try {
    const result = await senderDetails.verifyEmail(verificationCode);
    
    console.log('Success! Your email address has been verified')
    return result;
  } catch (error) {
    console.error(error);
  }
});

/* Promise returns void */


Verifies an updated sender address with a verification code (export from backend code)

verifyEmail

void

---
title: Introduction
---

# Introduction

<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;
> **Note:** This module is [universal](/api-overview/api-versions#universal-modules). Functions in this module can run on both the backend and frontend, unless specified otherwise. 


The Sender Details API contains the information that is displayed as the sender’s name and email address when sending an email from your Wix site. 

With the Sender Details API you can: 
- [Get](/sender-details/get-sender-details) your email sender details.
- [Update](/sender-details/update-sender-details) your email sender details.
- [Verify](/sender-details/verify-email) your sender email address.

## Before you begin

Before you begin, it is important to note the following information. 

If you send an email campaign with a public email domain (e.g. @gmail.com or @yahoo.com), the email address isn't displayed in the 'from' header. Instead, the email address is replaced with @wixemails.com (or @wixsitemail.com for free users), and the sender's email is placed in the 'reply-to' header.

If you send an email campaign with an email from a Wix managed domain, that email will be displayed in the 'from' header. If you send an email from a custom domain that is not managed by Wix, a line will be inserted that states that the email was sent via wixemails.com.

To use the Sender Details API, import `{ senderDetails }` from the `wix-email-marketing.v2` module:

```js
import { senderDetails } from `wix-email-marketing.v2`; 
```


getSenderDetails( )

Permission Scopes