Sign in to the webmail with mailbox credentials
/api/v1/mailbox-auth/loginExchanges a mailbox's own email and password for a webmail session. The password is verified by IMAP LOGIN against Dovecot, never against a stored copy, so this can never disagree with what a mail client would accept. Unauthenticated by design, rate-limited by IP and by address. Send X-Client-Platform: ios|android|macos|windows|linux from a native app to receive the native session lifetimes (default 30 days idle / 180 days absolute) instead of the browser's 8 hours / 7 days. If the account carries a temporary password the session is still issued, data.must_change_password is true, and every /api/v1/mailbox/* route except POST /security/password and logout answers 403 password_change_required until a new password is set.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
X-Forwarded-For | header | string |
Request body
Request
/api/v1/mailbox-auth/logincurl -X POST 'https://app.mailyte.com/api/v1/mailbox-auth/login' \
-H 'Authorization: Bearer MAILBOX_TOKEN'const response = await fetch('https://app.mailyte.com/api/v1/mailbox-auth/login', {
method: 'POST',
headers: {
Authorization: 'Bearer MAILBOX_TOKEN',
},
});
const { data } = await response.json();import requests
response = requests.post(
"https://app.mailyte.com/api/v1/mailbox-auth/login",
headers={"Authorization": "Bearer MAILBOX_TOKEN"},
)
data = response.json()["data"]<?php
$response = Http::withToken('MAILBOX_TOKEN')
->post('https://app.mailyte.com/api/v1/mailbox-auth/login');
$data = $response->json('data');require "net/http"
require "json"
uri = URI("https://app.mailyte.com/api/v1/mailbox-auth/login")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer MAILBOX_TOKEN"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }Response
Successful Response
Returned inside the standard envelope.
Errors
| Status | When |
|---|---|
422 | Validation Error |
Every status, with what causes it and what to do, is on the error reference.