temp-mail.ru

Node.js wrapper for temp-mail.ru api.

Install

$ npm install temp-mail.ru --save

How to

TypeScript:

import TempMail from "temp-mail.ru";
TempMail.randomFreeEmail().subscribe((mailName) => {
    console.log(mailName);
});

JavaScript:

var TempMail = require("temp-mail.ru").default;
TempMail.randomFreeEmail().subscribe(function(mailName) {
    console.log(mailName);
});

API Reference

• pichuser
  • ~TempMail
    • .domains() ⇒ Observable.<Array.<string>>
    • .mails(mailName) ⇒ Observable.<Array.<MailObject>>
    • .mailsCount(mailName) ⇒ Observable.<number>
    • .randomFreeEmail() ⇒ Observable.<string>
    • .deleteMail(id) ⇒ Observable.<boolean>
    • .waitForMail(mailName, timeout) ⇒ Observable.<MailObject>
  • ~MailObject
    • .mail_unique_id : string
    • .mail_id
    • .mail_address_id
    • .mail_from
    • .mail_subject
    • .mail_preview
    • .mail_text_only
    • .mail_text
    • .mail_html

pichuser~TempMail

Kind: inner class of pichuser

• ~TempMail
  • .domains() ⇒ Observable.<Array.<string>>
  • .mails(mailName) ⇒ Observable.<Array.<MailObject>>
  • .mailsCount(mailName) ⇒ Observable.<number>
  • .randomFreeEmail() ⇒ Observable.<string>
  • .deleteMail(id) ⇒ Observable.<boolean>
  • .waitForMail(mailName, timeout) ⇒ Observable.<MailObject>

TempMail.domains() ⇒ Observable.<Array.<string>>

Get all available domains

Kind: static method of TempMail
Example

     TempMail.domains().subscribe((domains) => {
            console.log(domains);
        });

TempMail.mails(mailName) ⇒ Observable.<Array.<MailObject>>

Get all emails by mail name

Kind: static method of TempMail

| Param | Type | Description | | --- | --- | --- | | mailName | string | email on temp-mail.ru |

Example

     TempMail.mails('[email protected]')
        .subscribe((mails) => {
            console.log(mails);
        });

TempMail.mailsCount(mailName) ⇒ Observable.<number>

Return count of mails in box

Kind: static method of TempMail

| Param | Type | Description | | --- | --- | --- | | mailName | string | email on temp-mail.ru |

Example

     TempMail.mails('[email protected]')
     .subscribe((count) => {
        console.log(count);
    });

TempMail.randomFreeEmail() ⇒ Observable.<string>

Return first random email without inbox letters

Kind: static method of TempMail
Example

     TempMail.randomFreeEmail().subscribe((mailName) => {
        console.log(mailName);
    });

TempMail.deleteMail(id) ⇒ Observable.<boolean>

Delete email by id

Kind: static method of TempMail

| Param | Type | Description | | --- | --- | --- | | id | string | system hash of mail. |

Example

     TempMail.deleteMail('hashid').subscribe((success) => {
        console.log(success ? "deleted" : "can\'t delete");
    });

TempMail.waitForMail(mailName, timeout) ⇒ Observable.<MailObject>

Return first available letter

Kind: static method of TempMail

| Param | Type | Default | Description | | --- | --- | --- | --- | | mailName | string | | email on temp-mail.ru | | timeout | number | | timeout in seconds |

Example

     TempMail.waitForMail('[email protected]', 10)
     .subscribe((mail) => {
        console.log(mail);
    }, (error) => {
        alert("Mailbox still empty")
    });

pichuser~MailObject

Kind: inner class of pichuser

• ~MailObject
  • .mail_unique_id : string
  • .mail_id
  • .mail_address_id
  • .mail_from
  • .mail_subject
  • .mail_preview
  • .mail_text_only
  • .mail_text
  • .mail_html

mailObject.mail_unique_id : string

Unique identifier assigned by the system.

Kind: instance property of MailObject

mailObject.mail_id

Unique identifier of the message in md5 hash assigned by the system.

Kind: instance property of MailObject

mailObject.mail_address_id

md5 email address hash

Kind: instance property of MailObject

mailObject.mail_from

Sender

Kind: instance property of MailObject

mailObject.mail_subject

Subject

Kind: instance property of MailObject

mailObject.mail_preview

Preview

Kind: instance property of MailObject

mailObject.mail_text_only

Message in text or html format (main)

Kind: instance property of MailObject

mailObject.mail_text

Message only in text format

Kind: instance property of MailObject

mailObject.mail_html

Message only in html format

Kind: instance property of MailObject

License

MIT