Struct mailslurp::models::send_email_options::SendEmailOptions

pub struct SendEmailOptions {
    pub attachments: Option<Vec<String>>,
    pub bcc: Option<Vec<String>>,
    pub body: Option<String>,
    pub cc: Option<Vec<String>>,
    pub charset: Option<String>,
    pub from: Option<String>,
    pub is_html: Option<bool>,
    pub reply_to: Option<String>,
    pub send_strategy: Option<SendStrategy>,
    pub subject: Option<String>,
    pub template: Option<String>,
    pub template_variables: Option<Value>,
    pub to: Option<Vec<String>>,
    pub to_contacts: Option<Vec<String>>,
    pub to_group: Option<String>,
}

SendEmailOptions : Options for sending an email message from an inbox. You must provide one of: to, toGroup, or toContacts to send an email. All other parameters are optional.

Fields

attachments: Option<Vec<String>>

Optional list of attachment IDs to send with this email. You must first upload each attachment separately in order to obtain attachment IDs. This way you can reuse attachments with different emails once uploaded.

bcc: Option<Vec<String>>

Optional list of bcc destination email addresses

body: Option<String>

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.

cc: Option<Vec<String>>

Optional list of cc destination email addresses

charset: Option<String>

Optional charset

from: Option<String>

Optional from address. If not set the source inbox address will be used for this field. Beware of potential spam penalties when setting this field to an address not used by the inbox. For custom email addresses use a custom domain.

is_html: Option<bool>

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

reply_to: Option<String>

Optional replyTo header

send_strategy: Option<SendStrategy>

Optional strategy to use when sending the email

subject: Option<String>

Optional email subject line

template: Option<String>

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.

template_variables: Option<Value>

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

to: Option<Vec<String>>

List of destination email addresses. 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).

to_contacts: Option<Vec<String>>

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.

to_group: Option<String>

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

Implementations

impl SendEmailOptions

pub fn new() -> SendEmailOptions

Options for sending an email message from an inbox. You must provide one of: to, toGroup, or toContacts to send an email. All other parameters are optional.

Trait Implementations

impl Clone for SendEmailOptions

pub fn clone(&self) -> SendEmailOptions

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SendEmailOptions

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SendEmailOptions

pub fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<SendEmailOptions> for SendEmailOptions

pub fn eq(&self, other: &SendEmailOptions) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &SendEmailOptions) -> bool

This method tests for !=.

impl Serialize for SendEmailOptions

pub fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SendEmailOptions