Copy page

Email

Websites Puter Apps Node.js Workers

The Email API lets your app read the user's Puter mailbox and send transactional email.

Every Puter account has an email address, {username}@puter.email. Mail sent to it is stored in the user's own cloud drive, so your app can list the inbox and read messages, attachments included, once the user grants access to their mailbox. Your app can also send transactional email, such as a signup confirmation, a receipt, or an alert, from a Puter address without setting up a mail server.

With the User-Pays Model, the account making the call covers its own usage. Mail is stored in the user's storage, and sends count toward the caller's allowance rather than yours.

Transactional email is available to accounts on a paid plan for now. A call from a free account fails with 402 subscription_required.

Features

List Messages
Read a Message
Send Transactional Email

List the ten newest messages in the inbox 

<html>
<body>
    <script src="https://js.puter.com/v2/"></script>
    <script>
        (async () => {
            const page = await puter.email.list({ limit: 10 });
            for (const message of page.items) {
                puter.print(`${message.date}  ${message.subject}<br>`);
            }
        })();
    </script>
</body>
</html>

Read the newest message 

<html>
<body>
    <script src="https://js.puter.com/v2/"></script>
    <script>
        (async () => {
            const { items } = await puter.email.list({ limit: 1 });
            if (items.length === 0) return puter.print('Inbox is empty');

            const message = await puter.email.get(items[0].id);
            puter.print(`From: ${message.from?.address}<br>`);
            puter.print(`Subject: ${message.subject}<br>`);
            puter.print(`<pre>${message.text}</pre>`);
        })();
    </script>
</body>
</html>

Send a transactional email from a worker 

// In a worker: the worker authorizes the send, the calling user pays for it.
router.post('/notify', async ({ request, user }) => {
    const { to, subject, text } = await request.json();
    return await user.puter.email.sendTransactional({
        to,
        subject,
        text,
        emailAccessToken: me.puter.authToken,
    });
});

Functions

NEXT

list()

PREVIOUS

get()