Struct mailslurp::models::send_email_options::SendEmailOptions [−][src]
pub struct SendEmailOptions {}Show fields
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>,
Expand description
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>>
Expand description
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>>
Expand description
Optional list of bcc destination email addresses
body: Option<String>
Expand description
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>>
Expand description
Optional list of cc destination email addresses
charset: Option<String>
Expand description
Optional charset
from: Option<String>
Expand description
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>
Expand description
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>
Expand description
Optional replyTo header
send_strategy: Option<SendStrategy>
Expand description
Optional strategy to use when sending the email
subject: Option<String>
Expand description
Optional email subject line
template: Option<String>
Expand description
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>
Expand description
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>>
Expand description
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>>
Expand description
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>
Expand description
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
[src]
impl SendEmailOptions
[src]pub fn new() -> SendEmailOptions
[src]
pub fn new() -> SendEmailOptions
[src]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
[src]
impl Clone for SendEmailOptions
[src]fn clone(&self) -> SendEmailOptions
[src]
fn clone(&self) -> SendEmailOptions
[src]Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]Performs copy-assignment from source
. Read more
impl Debug for SendEmailOptions
[src]
impl Debug for SendEmailOptions
[src]impl<'de> Deserialize<'de> for SendEmailOptions
[src]
impl<'de> Deserialize<'de> for SendEmailOptions
[src]fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]Deserialize this value from the given Serde deserializer. Read more
impl PartialEq<SendEmailOptions> for SendEmailOptions
[src]
impl PartialEq<SendEmailOptions> for SendEmailOptions
[src]fn eq(&self, other: &SendEmailOptions) -> bool
[src]
fn eq(&self, other: &SendEmailOptions) -> bool
[src]This method tests for self
and other
values to be equal, and is used
by ==
. Read more
fn ne(&self, other: &SendEmailOptions) -> bool
[src]
fn ne(&self, other: &SendEmailOptions) -> bool
[src]This method tests for !=
.
impl Serialize for SendEmailOptions
[src]
impl Serialize for SendEmailOptions
[src]impl StructuralPartialEq for SendEmailOptions
[src]
Auto Trait Implementations
impl RefUnwindSafe for SendEmailOptions
impl Send for SendEmailOptions
impl Sync for SendEmailOptions
impl Unpin for SendEmailOptions
impl UnwindSafe for SendEmailOptions
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> Instrument for T
[src]
impl<T> Instrument for T
[src]fn instrument(self, span: Span) -> Instrumented<Self>
[src]
fn instrument(self, span: Span) -> Instrumented<Self>
[src]Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
fn in_current_span(self) -> Instrumented<Self>
[src]
fn in_current_span(self) -> Instrumented<Self>
[src]impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
[src]
pub fn clone_into(&self, target: &mut T)
[src]🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
T: for<'de> Deserialize<'de>,