Skip to content

emails

Scans the whole document — mailto: links and plain text — and returns every address found as a bare string, with any mailto: prefix stripped:
const emails = await microlink.emails('https://microlink.io')

console.log(emails)
// => ['[email protected]']

Options

Override the default rule of selector: 'html', attr: 'html', and type: 'email' with selectorAll, selector, attr, or type. The 'email' type is what turns the swept HTML into addresses, so keep it when changing the scope.

Examples

Only the addresses in the footer:
const emails = await microlink.emails('https://example.com', {
  selector: 'footer'
})
Addresses on a contact page rendered on the client:
const emails = await microlink.emails('https://example.com/contact', {
  prerender: true,
  waitForSelector: 'main'
})
Obfuscated addresses — name [at] domain [dot] com, images, or JavaScript-assembled links — are not detected. For those, run your own logic against the rendered page with function.