Smtp.SMTPMessage

Class: SMTPMessage

smtp.SMTPMessage

SMTPMessage is a message to be sent over SMTP

Example

const smtp = require('nuclei/smtp');
const message = new smtp.SMTPMessage();
message.From('[e-mail]');

Table of contents

Constructors

• constructor

Methods

• Auth
• Body
• From
• String
• Subject
• To

Constructors

constructor

• new SMTPMessage(): SMTPMessage

Returns

SMTPMessage

Defined in

smtp.ts:89

Methods

Auth

▸ Auth(username): SMTPMessage

Auth when called authenticates using username and password before sending the message

Parameters

Name	Type
username	string

Returns

SMTPMessage

Example

const smtp = require('nuclei/smtp');
const message = new smtp.SMTPMessage();
message.Auth('username', 'password');

Defined in

smtp.ts:155

---

Body

▸ Body(msg): SMTPMessage

Body adds the message body to the message

Parameters

Name	Type
msg	Uint8Array

Returns

SMTPMessage

Example

const smtp = require('nuclei/smtp');
const message = new smtp.SMTPMessage();
message.Body('hello');

Defined in

smtp.ts:141

---

From

▸ From(email): SMTPMessage

From adds the from field to the message

Parameters

Name	Type
email	string

Returns

SMTPMessage

Example

const smtp = require('nuclei/smtp');
const message = new smtp.SMTPMessage();
message.From('[e-mail]');

Defined in

smtp.ts:99

---

String

▸ String(): string

String returns the string representation of the message

Returns

string

Example

const smtp = require('nuclei/smtp');
const message = new smtp.SMTPMessage();
message.From('[e-mail]');
message.To('[e-mail]');
message.Subject('hello');
message.Body('hello');
log(message.String());

Defined in

smtp.ts:173

---

Subject

▸ Subject(sub): SMTPMessage

Subject adds the subject field to the message

Parameters

Name	Type
sub	string

Returns

SMTPMessage

Example

const smtp = require('nuclei/smtp');
const message = new smtp.SMTPMessage();
message.Subject('hello');

Defined in

smtp.ts:127

---

To

▸ To(email): SMTPMessage

To adds the to field to the message

Parameters

Name	Type
email	string

Returns

SMTPMessage

Example

const smtp = require('nuclei/smtp');
const message = new smtp.SMTPMessage();
message.To('[e-mail]');

Defined in

smtp.ts:113