lib/mailer

Interfaces

MailerConfig

Defined in: studiocms/packages/studiocms/src/lib/mailer/index.ts:84

Configuration interface for the mailer.

Properties

sender

sender: string;

Defined in: studiocms/packages/studiocms/src/lib/mailer/index.ts:93

The email address of the sender.

transporter

transporter: TransporterConfig;

Defined in: studiocms/packages/studiocms/src/lib/mailer/index.ts:88

The configuration object for the mail transporter.

---

MailOptions

Defined in: studiocms/packages/studiocms/src/lib/mailer/index.ts:99

Interface representing the options for sending an email.

Properties

html?

optional html: string;

Defined in: studiocms/packages/studiocms/src/lib/mailer/index.ts:118

The HTML content of the email. Optional.

subject

subject: string;

Defined in: studiocms/packages/studiocms/src/lib/mailer/index.ts:108

The subject of the email.

text?

optional text: string;

Defined in: studiocms/packages/studiocms/src/lib/mailer/index.ts:113

The plain text content of the email. Optional.

to

to: string | string[];

Defined in: studiocms/packages/studiocms/src/lib/mailer/index.ts:103

The recipient(s) of the email. Can be a single email address or an array of email addresses.

---

TransporterConfig

Defined in: studiocms/packages/studiocms/src/lib/mailer/index.ts:29

Configuration options for the mail transporter.

Properties

auth

auth: {
  pass: string;
  user: string;
};

Defined in: studiocms/packages/studiocms/src/lib/mailer/index.ts:53

Authentication details for the SMTP server.

pass?

optional pass: string;

The password for authentication.

user?

optional user: string;

The username for authentication.

host

host: string;

Defined in: studiocms/packages/studiocms/src/lib/mailer/index.ts:33

The hostname or IP address of the SMTP server.

port

port: number;

Defined in: studiocms/packages/studiocms/src/lib/mailer/index.ts:38

The port number to connect to the SMTP server.

proxy?

optional proxy: string;

Defined in: studiocms/packages/studiocms/src/lib/mailer/index.ts:48

The proxy URL to use for the connection (optional).

secure

secure: boolean;

Defined in: studiocms/packages/studiocms/src/lib/mailer/index.ts:43

If true, the connection will use TLS when connecting to the server.

tls?

optional tls: {
  rejectUnauthorized: boolean;
  servername: string;
};

Defined in: studiocms/packages/studiocms/src/lib/mailer/index.ts:68

TLS configuration options (optional).

rejectUnauthorized?

optional rejectUnauthorized: boolean;

If true, the server certificate will not be validated (optional).

servername?

optional servername: string;

The server name for SNI (optional).

Type Aliases

MailerResponse

type MailerResponse = MailerSuccessResponse | MailerErrorResponse;

Defined in: studiocms/packages/studiocms/src/lib/mailer/index.ts:138

Interface representing the response from a mail verification operation.

---

tsMailer

type tsMailer = typeof tsMailerConfig.$inferSelect;

Defined in: studiocms/packages/studiocms/src/lib/mailer/index.ts:19

TypeSafe Table definition for use in StudioCMS Integrations

---

tsMailerInsert

type tsMailerInsert = Omit<typeof tsMailerConfig.$inferInsert, "id">;

Defined in: studiocms/packages/studiocms/src/lib/mailer/index.ts:24

TypeSafe Table definition for use in StudioCMS Integrations

Variables

tsMailerConfig

const tsMailerConfig: Table<"StudioCMSMailerConfig", {
  auth_pass: {
     type: "text";
    };
  auth_user: {
     type: "text";
    };
  default_sender: {
     type: "text";
    };
  host: {
     type: "text";
    };
  id: {
     type: "text";
    };
  port: {
     type: "number";
    };
  proxy: {
     type: "text";
    };
  secure: {
     type: "boolean";
    };
  tls_rejectUnauthorized: {
     type: "boolean";
    };
  tls_servername: {
     type: "text";
    };
}>;

Defined in: studiocms/packages/studiocms/src/lib/mailer/index.ts:14

TypeSafe Table definition for use in StudioCMS Integrations

Functions

createMailerConfigTable()

function createMailerConfigTable(config: tsMailerInsert): Promise<
  | MailerErrorResponse
  | {
  auth_pass: null | string;
  auth_user: null | string;
  default_sender: string;
  host: string;
  id: string;
  port: number;
  proxy: null | string;
  secure: boolean;
  tls_rejectUnauthorized: null | boolean;
  tls_servername: null | string;
}>

Defined in: studiocms/packages/studiocms/src/lib/mailer/index.ts:201

Creates a new mailer configuration in the database.

Parameters

config

tsMailerInsert

The mailer configuration object to create.

Returns

Promise< | MailerErrorResponse | { auth_pass: null | string; auth_user: null | string; default_sender: string; host: string; id: string; port: number; proxy: null | string; secure: boolean; tls_rejectUnauthorized: null | boolean; tls_servername: null | string; }>

A promise that resolves with the new mailer configuration object.

---

getMailerConfigTable()

function getMailerConfigTable(): Promise<
  | undefined
  | {
  auth_pass: null | string;
  auth_user: null | string;
  default_sender: string;
  host: string;
  id: string;
  port: number;
  proxy: null | string;
  secure: boolean;
  tls_rejectUnauthorized: null | boolean;
  tls_servername: null | string;
}>

Defined in: studiocms/packages/studiocms/src/lib/mailer/index.ts:175

Gets the mailer configuration from the database.

Returns

Promise< | undefined | { auth_pass: null | string; auth_user: null | string; default_sender: string; host: string; id: string; port: number; proxy: null | string; secure: boolean; tls_rejectUnauthorized: null | boolean; tls_servername: null | string; }>

A promise that resolves with the mailer configuration object.

---

isMailerEnabled()

function isMailerEnabled(): Promise<boolean>

Defined in: studiocms/packages/studiocms/src/lib/mailer/index.ts:397

Checks if the mailer service is enabled in the StudioCMS configuration.

This function retrieves the configuration from the StudioCMS SDK and returns the value of the enableMailer property. If the configuration is not available, it defaults to false.

Returns

Promise<boolean>

A promise that resolves to true if the mailer service is enabled, otherwise false.

---

sendMail()

function sendMail(mailOptions: MailOptions): Promise<MailerResponse>

Defined in: studiocms/packages/studiocms/src/lib/mailer/index.ts:285

Sends an email using the provided mailer configuration and mail options.

Parameters

mailOptions

MailOptions

The options for the mail, including the subject and other message details.

Returns

Promise<MailerResponse>

A promise that resolves with the result of the mail sending operation.

Throws

Will throw an error if the mail sending operation fails.

Example

const mailOptions = {
  subject: 'Test Email',
  to: '[email protected]',
  text: 'This is a test email.'
};

sendMail(mailerConfig, mailOptions)
  .then(result => console.log('Email sent:', result))
  .catch(error => console.error('Error sending email:', error));

---

updateMailerConfigTable()

function updateMailerConfigTable(config: tsMailerInsert): Promise<MailerResponse>

Defined in: studiocms/packages/studiocms/src/lib/mailer/index.ts:184

Updates the mailer configuration in the database.

Parameters

config

tsMailerInsert

The new mailer configuration object.

Returns

Promise<MailerResponse>

A promise that resolves when the mailer configuration has been updated.

---

verifyMailConnection()

function verifyMailConnection(): Promise<MailerResponse>

Defined in: studiocms/packages/studiocms/src/lib/mailer/index.ts:351

Verifies the mail connection using the provided transporter configuration.

Returns

Promise<MailerResponse>

A promise that resolves to an object containing either a success message or an error message.

Example

const result = await verifyMailConnection();
if ('message' in result) {
  console.log(result.message);
} else {
  console.error(result.error);
}