This endpoint will add an SMTP and IMAP mailbox directly to Mailstand.

Endpoint

POST api.mailstand.com/mailboxes/smtp_imap

Payload Fields

FieldRequiredDescription
emailtrueThe email address that will be sending out the emails.
auth[smtp.username]trueThe unique identifier associated with the specific user account to authenticate and gain access to the SMTP server.
auth[smtp.password]trueThe raw password for the SMTP
auth[smtp.host]trueThe domain where we should connect to the SMTP. Example: smtp.gmail.com
auth[smtp.port]trueThe domain name or IP address of the server where your SMTP service is hosted. Generally, it's 25, 465, or 587.
auth[smtp.tls]trueA boolean option on if we should connect via TLS or not.
auth[imap.username]trueThe unique identifier associated with the specific user account to authenticate and gain access to the IMAP server.
auth[imap.password]trueThe raw password for the IMAP
auth[imap.host]trueThe domain where we should connect to the SMTP. Example: imap.gmail.com
auth[imap.port]trueThe domain name or IP address of the server where your SMTP service is hosted. Generally, it's 993.
auth[imap.tls]trueA boolean option on if we should connect via TLS or not.
workspacetrueThe workspace that we should add this mailbox to.
sender_firsttrueThe first name of the email sender.
sender_lasttrueThe last name of the email sender.
daily_limittrueThe number of max emails we should send daily.
send_spacingtrueThe number of minutes you want us to space out the emails. Put 0 if you want it to be set to autospacing.
signaturetrueThe signature of the email address.
custom_htmltrueAlways have this value be false

Payload Example

{
	"email": "[email protected]",
	"auth": {
        "smtp": {
            "username": "[email protected]",
            "password": "aRawPassword",
            "host": "smtp.gmail.com",
            "port": 587,
            "tls": false
        },
        "imap": {
            "username": "[email protected]",
            "password": "aRawPassword",
            "host": "imap.gmail.com",
            "port": 993,
            "tls": false
        }
    },
		"workspace": "space_abc123",
		"sender_first": "Mike",
		"sender_last": "Benson",
		"daily_limit": 100,
		"send_spacing": 1,
		"signature": "<p>My Signature</p>",
		"custom_html": false
}

201 Response

{
    "id": "inbox_ZBHAw8lht6VsdfdmbaCRRGjKv1"
}