Skip to content

Latest commit

 

History

History
163 lines (134 loc) · 5.34 KB

README.md

File metadata and controls

163 lines (134 loc) · 5.34 KB

Logo

ioBroker email

Number of Installations Number of Installations NPM version

Test and Release Translation status Downloads

Send emails from ioBroker. You cannot check emails with this adapter, only send them.

The adapter uses nodemailer to provide the functionality.

This adapter uses Sentry libraries to automatically report exceptions and code errors to the developers. For more details and for information how to disable the error reporting see Sentry-Plugin Documentation! Sentry reporting is used starting with js-controller 3.0.

To use Gmail, you may need to configure "Allow Less Secure Apps" in your Gmail account unless you are using 2FA, in which case you would have to create an application-specific password. You also may need to unlock your account with "Allow access to your Google account" to use SMTP.

Usage

To send email from ScriptEngine just write:

// send email to all instances of email adapter
sendTo('email', 'Email body');

// send email to specific instance of email adapter
sendTo("email.1", 'Email body');

// To specify subject or other options
sendTo('email', {
    from:    'iobroker@mydomain.com',
    to:      'aabbcc@gmail.com, xxyyzz@gmail.com', // comma separated multiple recipients.
    subject: 'Message from ioBroker',
    text:    'This is test email to you!',
});

// To send attachments
sendTo('email', {
    attachments: [
        {
            path: '/pathToImage/picture1.jpg', // use file on disk as attachment
        },
        {
            filename: 'license.txt',
            path: 'https://raw.github.com/andris9/Nodemailer/master/LICENSE', // use URL as an attachment
        },
    ]
});

// To send in html format
sendTo('email', {
    html: '<p>Embedded image: <img src='cid:image1'/></p>',
    attachments:[
        {
            path: 'path/to/file/image1.jpg',
            cid: 'image1',
        },
    ]
});

To send email from another adapter, use adapter.sendTo function.

Supported services

  • 1und1 / ionos
  • AOL
  • DebugMail.io
  • DynectEmail
  • FastMail
  • GandiMail
  • Gmail
  • Godaddy
  • GodaddyAsia
  • GodaddyEurope
  • hot.ee
  • Hotmail
  • iCloud
  • ith
  • mail.ee
  • Mail.ru
  • Mailgun
  • Mailjet
  • Mandrill
  • Naver
  • Office365
  • OpenMailBox
  • Postmark
  • QQ
  • QQex
  • SendCloud
  • SendGrid
  • SES
  • SES-US-EAST-1
  • SES-US-WEST-2
  • SES-EU-WEST-1
  • t-online.de
  • Sparkpost
  • Yahoo
  • Yandex
  • Zoho
  • User specific (Server, port and security defined manually)

For other services see documentation of Nodemailer: [https://github.com/nodemailer/nodemailer](https://github.com/nodemailer/nodemailer)

Changelog

2.0.3 (2025-03-24)

  • (@GermanBluefox) Added t-online.de to the list of supported services

2.0.2 (2025-03-14)

  • (@GermanBluefox) Renamed dist folder to build
  • (@GermanBluefox) Fixing pass decoding

2.0.0 (2025-03-11)

  • (@GermanBluefox) Breaking change: Structure of configuration was corrected, and it could be they needed to be reconfigured
  • (@GermanBluefox) Made Outlook work again. Requires now to be authenticated via OAuth2
  • (mcm1957) Adapter requires js-controller 5.0.19 and admin 6.17.14 now
  • (mcm1957) EsLint uses @iobroker/linter-config now
  • (mcm1957) Dependencies have been updated
  • (@GermanBluefox) Migrated to TypeScript
  • (@GermanBluefox) Added "Ignore SSL errors" option

1.4.0 (2024-11-17)

  • (simatec) Responsive Design added
  • (Jey-Cee) Admin-UI has been migrated to jsonConfig

1.3.1 (2024-06-09)

  • (klein0r) Updated Blockly definitions

1.3.0 (2024-04-29)

  • (mcm1957) Adapter requires node.js >= 18 and js-controller >= 5 now
  • (mcm1957) Dependencies have been updated

License

The MIT License (MIT)

Copyright (c) 2014-2025 bluefox

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.