`SMTP` - Email server uptime checking monitor

ChrisThePCGeek commented 1 year ago

⚠️ Please verify that this feature request has NOT been suggested before.

[X] I checked and didn't find similar feature request

🏷️ Feature Request Type

New Monitor

🔖 Feature description

send an email using a specified smtp server
said server either itself or some service perhaps (not sure if one exists) that would then report back "hey i got the email" to verify it is up

✔️ Solution

noted in description

❓ Alternatives

No response

📝 Additional Context

No response

stefanux commented 1 year ago

so you basically want a email-sent and receive loop and have a notification if no mail show up in interval x, right?

ChrisThePCGeek commented 1 year ago

Yeah that's the idea I had, I think it would work to verify an email server was up and working. could even trigger a fail if the send doesn't work since sometimes send works but receive doesn't.

solracsf commented 1 year ago

Something similar to these options would also be great, if email send is a heavy option. https://www.wormly.com/test-smtp-server

In the "No email send" option, if server returns a 530 Authentication required it should be considered OK
If Auth is passed, it should be considered OK if Auth is accepted

flaviomeyer commented 1 year ago

@ChrisThePCGeek Interested to develop together a new monitor for mail server's?

ediazrod commented 1 year ago

I love to have this feature, at least to test if the e-mail works and on the other end if the mail is received... I love to follow up this capability, I not a programmer on node maybe create some doc about how to install with a no-root user, and Patrion the project. :-P

CommanderStorm commented 12 months ago

@ediazrod @erseco Issues are for discussing what needs to be done how by whom. We use 👍🏻 on issues to prioritise work, as always: Pull Requests welcome.

hujiko commented 10 months ago

I think the sending and receiving actual Mail might be quite complex.

I would already be fine with something more simple. A check, that

Connects to a Server/Port
Issues StartTLS if checked in the check options
Validates the SSL-Certificate (either when StartTLS is configured, or as separate switch)
Sends "MAIL FROM: .." with a from-address defined in the check and expects a 250 response
Sends "RCPT TO: ..." with a to-address defined in the check, and expects a 250 response. And then the check can terminate the connection. It does not actually send the mail, but goes far enough to check the SSL config, the (potential) config for sender and receive adresses.

Something like:

const { SMTPClient } = require('smtp-client');

module.exports = function(smtpConfig) {
  return {
    async check() {
      const client = new SMTPClient({
        host: smtpConfig.host,
        port: smtpConfig.port,
        secure: false,
        useSecureTransport: false,
        ignoreTLS: true,
        requireTLS: false,
        timeout: 5000,
      });

      try {
        await client.connect();

        const response = await client.sendCommand('EHLO localhost');
        if (response.code !== 250) {
          throw new Error('EHLO command failed');
        }

        const starttlsResponse = await client.sendCommand('STARTTLS');
        if (starttlsResponse.code !== 220) {
          throw new Error('STARTTLS command failed');
        }

        await client.secure({
          rejectUnauthorized: smtpConfig.rejectUnauthorized,
        });

        const mailFromResponse = await client.sendCommand(`MAIL FROM:<${smtpConfig.from}>`);
        if (mailFromResponse.code !== 250) {
          throw new Error('MAIL FROM command failed');
        }

        const rcptToResponse = await client.sendCommand(`RCPT TO:<${smtpConfig.to}>`);
        if (rcptToResponse.code !== 250) {
          throw new Error('RCPT TO command failed');
        }

        return true; // SMTP server is reachable
      } catch (error) {
        throw new Error(`SMTP server check failed: ${error.message}`);
      } finally {
        client.close();
      }
    },
  };
};

Whats missing there is the ability to make StartTLS optional and to actually validate the Certificate.

CommanderStorm commented 10 months ago

Note that our contribution guide is here https://github.com/louislam/uptime-kuma/blob/1550a5f79270f39007086d8d23c180ba9f63096b/CONTRIBUTING.md ^^