InboxController

Send Email

Send an email from an inbox's email address. The request body should contain the SendEmailOptions that include recipients, attachments, body etc. See SendEmailOptions for all available properties. Note the inboxId refers to the inbox's id not the inbox's email address. See https://www.mailslurp.com/guides/ for more information on how to send emails. This method does not return a sent email entity due to legacy reasons. To send and get a sent email as returned response use the sister method sendEmailAndConfirm.

post/inboxes/{inboxId}

Request

  • Base URL: https://api.mailslurp.com
  • URL: https://api.mailslurp.com/inboxes/{inboxId}
  • Auth: API key in header x-api-key

Path parameters

inboxIdstring uuid required

ID of the inbox you want to send the email from

Request body

toContactsstring[] nullable

Optional list of contact IDs to send email to. Manage your contacts via the API or dashboard. When contacts are used the email is sent to each contact separately so they will not see other recipients.

toGroupstring uuid nullable

Optional contact group ID to send email to. You can create contacts and contact groups in the API or dashboard and use them for email campaigns. When contact groups are used the email is sent to each contact separately so they will not see other recipients

tostring[] nullable

List of destination email addresses. Each email address must be RFC 5322 format. Even single recipients must be in array form. Maximum recipients per email depends on your plan. If you need to send many emails try using contacts or contact groups or use a non standard sendStrategy to ensure that spam filters are not triggered (many recipients in one email can affect your spam rating). Be cautious when sending emails that your recipients exist. High bounce rates (meaning a high percentage of emails cannot be delivered because an address does not exist) can result in account freezing.

fromstring nullable

Optional from address. Email address is RFC 5322 format and may include a display name and email in angle brackets (my@address.com or My inbox <my@address.com>). If no sender is set the source inbox address will be used for this field. If you set useInboxName to true the from field will include the inbox name as a display name: inbox_name <inbox@address.com>. For this to work use the name field when creating an inbox. Beware of potential spam penalties when setting the from field to an address not used by the inbox. Your emails may get blocked by services if you impersonate another address. To use a custom email addresses use a custom domain. You can create domains with the DomainController. The domain must be verified in the dashboard before it can be used.

fromNamestring nullable

Optional from name if not passed with address. If you set useInboxName to true the from field will include the inbox name as a display name

ccstring[] nullable

Optional list of cc destination email addresses

bccstring[] nullable

Optional list of bcc destination email addresses

subjectstring nullable

Optional email subject line

replyTostring nullable

Optional replyTo header

customHeadersobject nullable

Optional custom headers

bodystring nullable

Optional contents of email. If body contains HTML then set isHTML to true to ensure that email clients render it correctly. You can use moustache template syntax in the email body in conjunction with toGroup contact variables or templateVariables data. If you need more templating control consider creating a template and using the template property instead of the body.

htmlboolean nullable

Optional HTML flag to indicate that contents is HTML. Set's a content-type: text/html for email. (Deprecated: use isHTML instead.)

isHTMLboolean nullable

Optional HTML flag. If true the content-type of the email will be text/html. Set to true when sending HTML to ensure proper rending on email clients

charsetstring nullable

Optional charset

attachmentsstring[] nullable

Optional list of attachment IDs to send with this email. You must first upload each attachment separately via method call or dashboard in order to obtain attachment IDs. This way you can reuse attachments with different emails once uploaded. There are several ways to upload that support multi-part form, base64 file encoding, and octet stream binary uploads. See the UploadController for available methods.

templateVariablesobject nullable

Optional map of template variables. Will replace moustache syntax variables in subject and body or template with the associated values if found.

templatestring uuid nullable

Optional template ID to use for body. Will override body if provided. When using a template make sure you pass the corresponding map of templateVariables. You can find which variables are needed by fetching the template itself or viewing it in the dashboard.

sendStrategy'SINGLE_MESSAGE' nullable

How an email should be sent based on its recipients

useInboxNameboolean nullable

Use name of inbox as sender email address name. Will construct RFC 5322 email address with Inbox name <inbox@address.com> if the inbox has a name.

addTrackingPixelboolean nullable

Add tracking pixel to email

filterBouncedRecipientsboolean nullable

Filter recipients to remove any bounced recipients from to, bcc, and cc before sending

validateEmailAddresses'VALIDATE_FILTER_REMOVE_INVALID' | 'VALIDATE_ERROR_IF_INVALID' | 'NO_VALIDATION' nullable

Validate recipient email addresses before sending

ignoreEmptyRecipientsboolean nullable

Ignore empty recipients after validation removes all recipients as invalid and fail silently

isXAmpHtmlboolean nullable

Is content AMP4EMAIL compatible. If set will send as x-amp-html part.

inboxIdstring uuid nullable

Optional inbox ID to send from. If omitted, source inbox selection is controlled by the endpoint path or query parameters.

Response

Created

Changes

No recorded changes to this operation across all 1 revision of this API.