This endpoint will add an SMTP and IMAP mailbox directly to Mailstand.
Endpoint
POST api.mailstand.com/mailboxes/smtp_imap
Payload Fields
Field | Required | Description |
---|---|---|
true | The email address that will be sending out the emails. | |
auth[smtp.username] | true | The unique identifier associated with the specific user account to authenticate and gain access to the SMTP server. |
auth[smtp.password] | true | The raw password for the SMTP |
auth[smtp.host] | true | The domain where we should connect to the SMTP. Example: smtp.gmail.com |
auth[smtp.port] | true | The domain name or IP address of the server where your SMTP service is hosted. Generally, it's 25, 465, or 587. |
auth[smtp.tls] | true | A boolean option on if we should connect via TLS or not. |
auth[imap.username] | true | The unique identifier associated with the specific user account to authenticate and gain access to the IMAP server. |
auth[imap.password] | true | The raw password for the IMAP |
auth[imap.host] | true | The domain where we should connect to the SMTP. Example: imap.gmail.com |
auth[imap.port] | true | The domain name or IP address of the server where your SMTP service is hosted. Generally, it's 993. |
auth[imap.tls] | true | A boolean option on if we should connect via TLS or not. |
workspace | true | The workspace that we should add this mailbox to. |
sender_first | true | The first name of the email sender. |
sender_last | true | The last name of the email sender. |
daily_limit | true | The number of max emails we should send daily. |
send_spacing | true | The number of minutes you want us to space out the emails. Put 0 if you want it to be set to autospacing. |
signature | true | The signature of the email address. |
custom_html | true | Always 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"
}