utils/effects/smtp

Classes

SMTPMailer

Defined in: studiocms/packages/studiocms/src/utils/effects/smtp.ts:147^

SMTPMailer service for sending emails.

This service provides methods to send emails using the SMTP protocol. It uses the configuration provided by the SMTPTransportConfig context.

Template

The type of the service.

Extends

• any

Constructors

Constructor

new SMTPMailer(): SMTPMailer;

Returns

SMTPMailer

Inherited from

Effect.Service<SMTPMailer>()(
  'studiocms/lib/effects/smtp/SMTPMailer',
  {
    effect: genLogger('studiocms/lib/effects/smtp/SMTPMailer.effect')(function () {
      const config = yield buildTransporterConfig;

      const { getVersionString, isIdle, sendMail, verifyTransport }: SMTPMailerReturn =
        yield SMTPService.pipe(buildProvide(config));

      return { verifyTransport, sendMail, isIdle, getVersionString };
    }),
  }
).constructor

Type Aliases

SMTPMailerReturn

type SMTPMailerReturn = {
  getVersionString: () => Effect.Effect<string, Error, never>;
  isIdle: () => Effect.Effect<boolean, Error, never>;
  sendMail: (mailOptions: Mail.Options) => Effect.Effect<SMTPTransport.SentMessageInfo, Error, never>;
  verifyTransport: () => Effect.Effect<true, Error, never>;
};

Defined in: studiocms/packages/studiocms/src/utils/effects/smtp.ts:121^

Represents the return type for the SMTPMailer service.

Properties

getVersionString()

getVersionString: () => Effect.Effect<string, Error, never>;

Defined in: studiocms/packages/studiocms/src/utils/effects/smtp.ts:122^

Returns

Effect.Effect<string, Error, never>

isIdle()

isIdle: () => Effect.Effect<boolean, Error, never>;

Defined in: studiocms/packages/studiocms/src/utils/effects/smtp.ts:123^

Returns

Effect.Effect<boolean, Error, never>

sendMail()

sendMail: (mailOptions: Mail.Options) => Effect.Effect<SMTPTransport.SentMessageInfo, Error, never>;

Defined in: studiocms/packages/studiocms/src/utils/effects/smtp.ts:124^

Parameters

mailOptions

Mail.Options

Returns

Effect.Effect<SMTPTransport.SentMessageInfo, Error, never>

verifyTransport()

verifyTransport: () => Effect.Effect<true, Error, never>;

Defined in: studiocms/packages/studiocms/src/utils/effects/smtp.ts:127^

Returns

Effect.Effect<true, Error, never>

---

tsMailer

type tsMailer = typeof tsMailerConfig.$inferSelect;

Defined in: studiocms/packages/studiocms/src/utils/effects/smtp.ts:32^

TypeSafe Table definition for use in StudioCMS Integrations

---

tsMailerInsert

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

Defined in: studiocms/packages/studiocms/src/utils/effects/smtp.ts:37^

TypeSafe Table definition for use in StudioCMS Integrations

References

Mail

Renames and re-exports LibSQLClientError

---

SMTPTransport

Renames and re-exports LibSQLClientError