It allows you to get the header, sender, field, html, date information of all incoming mails belonging to that mail with a mail information.
It searches for a link that meets the conditions you want in incoming mails for a mail information. If it finds the link, it returns the full link to you.
Searches for a confirmation code that meets the conditions you want in incoming mails for an incoming mail information

Usage

npm i imap-reader

Receive all incoming mails

const imapReader = require("imap-reader");

imapReader.read({
    user: 'rolikrinau@hotmail.com',
    password: 'all7Do61',
    host: 'imap-mail.outlook.com',
    port: 993,
    tls: true,
    type: 'INBOX' // default INBOX if you want to read the spam folder you should type Junk
})
.then(response=>{
    console.log(response)
})
.catch(err=>{
    console.log(err)
})

Sample Successful Response

{
    "status": true,
    "data": {
        "inbox_length": 3,
        "inbox_data": [
            {
                "html": "<html data>",
                "subject": "Yeni Outlook.com hesabınıza hoş geldiniz",
                "from": [
                    {
                        "address": "no-reply@microsoft.com",
                        "name": "Outlook Ekibi"
                    }
                ],
                "to": [
                    {
                        "address": "rolikrinau@hotmail.com",
                        "name": "roli krina"
                    }
                ],
                "date": "2023-09-23T16:28:53.000Z"
            },
            {
                "html": "<html data>",
                "subject": "OpenAI - Verify your email",
                "from": [
                    {
                        "address": "noreply@tm.openai.com",
                        "name": "OpenAI"
                    }
                ],
                "to": [
                    {
                        "address": "rolikrinau@hotmail.com",
                        "name": ""
                    }
                ],
                "date": "2023-09-23T16:29:00.000Z"
            },
            {
                "html": "<html data>",
                "subject": "Test Mail",
                "from": [
                    {
                        "address": "help@wmaster.net",
                        "name": "WM AI"
                    }
                ],
                "to": [
                    {
                        "address": "rolikrinau@hotmail.com",
                        "name": ""
                    }
                ],
                "date": "2023-09-23T17:11:59.000Z"
            }
        ]
    }
}

Sample Failed Response

{
    status: false,
    data: 'LOGIN failed.'
}

Search for a link in incoming mails and get the link

const imapReader = require("imap-reader");

imapReader.waitForLink({
    searchLinkString: 'https://mandrillapp.com/track/click/',
    imap: {
        user: 'alawocolynsm@hotmail.com',
        password: 'LKhHSrA80',
        host: 'imap-mail.outlook.com',
        port: 993,
        tls: true
    },
    timeOut: 0,
    type: 'INBOX' // default INBOX if you want to read the spam folder you should type Junk
})
    .then(resp => {
        console.log(resp)
    })
    .catch(err => {
        console.log(err);
    })

searchLinkString: It scans all the links in the incoming mail html data and if the string you send with this variable is in the link, it returns that link to you in an array.

timeOut: (Optional) Specifies how many milliseconds to wait for a link containing a string you send. If not sent, it is set to 2 minutes. 0 If sent, it waits until it arrives. 1 Second = 1000 Milliseconds

Sample Successful Response


{
    status: true,
    data: [
        'https://mandrillapp.com/track/click/31165340/auth0.openai.com?p=eyjzijoilvh4vc1xt2nocmyyvkn1ckturuz4zffwv05jiiwidii6mswicci6intcinvcijozmte2ntm0mcxcinzcijoxlfwidxjsxci6xcjodhrwczpcxfwvxfxcl2f1dggwlm9wzw5has5jb21cxfwvdvxcxc9lbwfpbc12zxjpzmljyxrpb24_dglja2v0ptlobdvzrnzyowjzb0x1au5juktuqjfks0nmbfe3ahf3i1wilfwiawrcijpcimfhnjcwmmrlyjgxodrlmde4ndrlodnmogy1odjlnzuwxcisxcj1cmxfawrzxci6w1wimwm3otuymjnimmq0ymuwmjbmzdjhntbmmmm5yzqxzjewmthlndu0y1wixx0ifq'
        ]
}

Sample Failed Response


{
    status: false,
    data: 'No mail with the link was received within the specified time'
}

Search for a code that meets the conditions you set in incoming mails


const imapReader = require("imap-reader");

imapReader.waitForCode({
 imap: {
        user: 'lassalnimishr@hotmail.com',
        password: '91XTVPu69',
        host: 'imap-mail.outlook.com',
        port: 993,
        tls: true
    },
    timeOut: 0,
    codeType: 'number',
    codeLength: 9,
    querySelector: 'a',
    type: 'INBOX' // default INBOX if you want to read the spam folder you should type Junk
})
    .then(resp => {
        console.log(resp)
    })
    .catch(err => {
        console.log(err);
    })

codeType: (Optional) Searches only for codes of the type you provide. Species it can take: number, lowerLetter, upperLetter, allLetter, nonAlfanumeric

codeLength: (Optional) Filters strings with the number of characters you give from all html elements.

querySelector: (Optional) It allows you to limit your html content and filter the codes within the html element you select. For example, if it is sent as 'a', it scans the content of the first a tag in the html content.

Sample Successful Response


{
    status: true,
    data: ['542569865']
}

Sample Failed Response


{
    status: false,
    data: 'No mail with the code was received within the specified time'
}

Contact

By email only. zfcsoftware@gmail.com

License

⚖️ Its protected by Creative Commons (CC BY-NC-SA 4.0)

Keywords

FAQs

What is imap-reader?

Is imap-reader well maintained?

Last updated on 13 Dec 2023

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install