Struct mailslurp::models::send_email_options::SendEmailOptions [−][src]
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
[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]
fn clone(&self) -> SendEmailOptions
[src]
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Debug for SendEmailOptions
[src]
impl<'de> Deserialize<'de> for SendEmailOptions
[src]
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
__D: Deserializer<'de>,
impl PartialEq<SendEmailOptions> for SendEmailOptions
[src]
fn eq(&self, other: &SendEmailOptions) -> bool
[src]
fn ne(&self, other: &SendEmailOptions) -> bool
[src]
impl Serialize for SendEmailOptions
[src]
fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
__S: Serializer,
[src]
__S: Serializer,
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> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
T: for<'de> Deserialize<'de>,
impl<T> From<T> for T
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,