WarmyInstall

Summary

Create a new mailbox in the Warmy platform with specified provider, email, and tariff plan, including provider-specific authentication details and optional configuration fields.

Inputs

• Provider (required) — Email provider to create the mailbox for, such as Gmail, Outlook, or SMTP.
• Email (required) — Email address of the new mailbox.
• Tariff Plan Type Name or ID (required) — Tariff plan to assign to the mailbox upon creation; choose from the provided list or specify an ID via expression.
• Password — App password for the mailbox, required for providers like AOL, Gmail, Outlook, Yahoo, Zoho, and Zohopro.
• SMTP Address — SMTP server address, required for Mailgun, SendGrid, and SMTP providers.
• SMTP Port — SMTP server port, required for Mailgun, SendGrid, and SMTP providers.
• SMTP SSL — Whether to use SSL for SMTP connections, applicable for Mailgun, SendGrid, and SMTP providers.
• SMTP User Name — SMTP username, required for Mailgun, SendGrid, and SMTP providers.
• SMTP Password — SMTP password, required for Mailgun, SendGrid, and SMTP providers.
• Additional Key (API Key) — API key needed specifically for Mailgun and SendGrid providers.
• Access Token (OAuth Google) — OAuth access token for Google provider.
• Refresh Token (OAuth Google) — OAuth refresh token for Google provider.
• Expires At (OAuth Google) — OAuth token expiration timestamp in Unix seconds for Google.
• Client ID (OAuth Google) — OAuth client ID for Google.
• Redirect URI (OAuth Google) — OAuth redirect URI for Google.
• Token Credential URI (OAuth Google) — OAuth token credential URI for Google, defaults to https://oauth2.googleapis.com/token.
• Access Token (OAuth Outlook) — OAuth access token for Outlook provider.
• Refresh Token (OAuth Outlook) — OAuth refresh token for Outlook provider.
• Client ID (OAuth Outlook) — OAuth client ID for Outlook.
• Client Secret (OAuth Outlook) — OAuth client secret for Outlook.
• Additional Fields — Optional additional settings including sender display name, group ID, IMAP configuration, reply rates, speed mode, user limits, and IMAP usage settings.

Output shape

a single record representing the created mailbox with its details.

The operation returns the newly created mailbox object as JSON. Required authentication credentials and specific provider parameters must be provided to successfully create the mailbox. Optional additional fields allow configuration of IMAP settings and mail sending behavior.

Examples

Example 1: Create a Gmail mailbox with app password and assign a tariff plan

Specify provider as Gmail, email address, app password, and select tariff plan from list.

Links

• n8n community nodes installation guide