Skip to main content

Email Clients

A shared package that exports queries, mutations, types, and utility functions for email clients.

Usage​

The module has been imported into our root npm package. All you have to do is import it into your module.

import { useCreateGmailEmailClient } from '@shared/email-clients'

Exported Mutations​

useCreateAzureEmailClient​

Calls the email_clients/azure public-api endpoint for a given email address. Requires an email address to be passed.

  const createEmailClient = useCreateAzureEmailClient()

  const handleCreateEmailClient = async () => {
    await createEmailClient.mutateAsync({ email_address: 'example@salesloft.com' })
    ...
  }

useCreateCerebroEmailClient​

Calls the email_clients/cerebro public-api endpoint for a given email address. Requires an email address to be passed.

  const createEmailClient = useCreateCerebroEmailClient()

  const handleCreateEmailClient = async () => {
    await createEmailClient.mutateAsync({ email_address: 'example@salesloft.com' })
    ...
  }

useCreateGmailEmailClient​

Calls the email_clients/gmail public-api endpoint for a given email address. Requires an email address to be passed.

  const createEmailClient = useCreateGmailEmailClient()

  const handleCreateEmailClient = async () => {
    await createEmailClient.mutateAsync({ email_address: 'example@salesloft.com' })
    ...
  }

useCreateLinkedInAzureEmailClient​

Calls the email_clients/linkedin_azure public-api endpoint for a given email address. Requires an email address to be passed.

  const createEmailClient = useCreateLinkedInAzureEmailClient()

  const handleCreateEmailClient = async () => {
    await createEmailClient.mutateAsync({ email_address: 'example@salesloft.com' })
    ...
  }

Exported Types​

TypeDescription
ConnectEmailClientParamsShared params for the create email client mutations