Email Management

The Phosphor platform supports sending an NFT to an email address. In this way, the recipient of the NFT is not required to have a wallet ahead of time, and can create one as part of the claim flow.

Configure your email provider

You can select your email provider from Mailgun, AmazonSES, or a custom SMTP server provider if you already have an established domain.

From the dashboard, navigate to Settings and set up the provider of your choice.

caution

Only one email provider configuration is allowed per organization.

You can also configure it via our APIs:

POST https://admin-api.phosphor.xyz/v1/email-integrations

The payload has the following format:

{
  "provider": "MAILGUN" | "AMAZON_SES" | "CUSTOM_SMTP",
  "config": {}
}

The information needed in the config object differs by the email provider.

Mailgun

{
  "config": {
    "email_from": "Your Org <hello@your-org.com>",
    "email_reply_to": "help@your-org.com",
    "domain": "your-org.com",
    "api_key": "api-key",
    "region": "US" | "EU",
  },
  "provider": "MAILGUN",
}

Amazon SES

{
  "config": {
    "email_from": "Your Org <hello@your-org.com>",
    "email_reply_to": "help@your-org.com",
    "smtp_username": "smtp-username",
    "smtp_password": "smtp-password",
    "region": "us-west-1",
    "port": 587 | null
  },
  "provider": "AMAZON_SES",
}

Custom SMTP servers

{
  "config": {
    "email_from": "Your Org <hello@gmail.com>",
    "email_reply_to": "help@gmail.com",
    "username": "username",
    "password": "password",
    "host": "smtp.gmail.com",
    "port": 587 | null
  },
  "provider": "CUSTOM_SMTP",
}

Edit a configuration

Edit an existing configuration by issuing a PATCH request to the email-integrations endpoint.

PATCH https://admin-api.phosphor.xyz/v1/email-integrations/{integration_id}

You can pass any parameters that were originally specified in your integration config, such as:

{
  "email_from": "New Org <hello@new-org.com>"
}

Delete a configuration

Delete an existing configuration by issuing a DELETE request to the email-integrations endpoint.

DELETE https://admin-api.phosphor.xyz/v1/email-integrations/{integration_id}

Contact support to activate your custom email provider configuration.

Customize your email templates

Customize your email template to design the emails sent to your customers.

You can use either API or dashboard to manage email templates in your organization.

From the dashboard, navigate to Email Campaigns and customize the email templates.

Learn more about email templates here