#[non_exhaustive]pub struct StartEmailContactInputBuilder { /* private fields */ }
Expand description
A builder for StartEmailContactInput
.
Implementations§
Source§impl StartEmailContactInputBuilder
impl StartEmailContactInputBuilder
Sourcepub fn instance_id(self, input: impl Into<String>) -> Self
pub fn instance_id(self, input: impl Into<String>) -> Self
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
This field is required.Sourcepub fn set_instance_id(self, input: Option<String>) -> Self
pub fn set_instance_id(self, input: Option<String>) -> Self
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Sourcepub fn get_instance_id(&self) -> &Option<String>
pub fn get_instance_id(&self) -> &Option<String>
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Sourcepub fn from_email_address(self, input: EmailAddressInfo) -> Self
pub fn from_email_address(self, input: EmailAddressInfo) -> Self
The email address of the customer.
This field is required.Sourcepub fn set_from_email_address(self, input: Option<EmailAddressInfo>) -> Self
pub fn set_from_email_address(self, input: Option<EmailAddressInfo>) -> Self
The email address of the customer.
Sourcepub fn get_from_email_address(&self) -> &Option<EmailAddressInfo>
pub fn get_from_email_address(&self) -> &Option<EmailAddressInfo>
The email address of the customer.
Sourcepub fn destination_email_address(self, input: impl Into<String>) -> Self
pub fn destination_email_address(self, input: impl Into<String>) -> Self
The email address associated with the instance.
This field is required.Sourcepub fn set_destination_email_address(self, input: Option<String>) -> Self
pub fn set_destination_email_address(self, input: Option<String>) -> Self
The email address associated with the instance.
Sourcepub fn get_destination_email_address(&self) -> &Option<String>
pub fn get_destination_email_address(&self) -> &Option<String>
The email address associated with the instance.
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
A description of the email contact.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
A description of the email contact.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
A description of the email contact.
Sourcepub fn references(self, k: impl Into<String>, v: Reference) -> Self
pub fn references(self, k: impl Into<String>, v: Reference) -> Self
Adds a key-value pair to references
.
To override the contents of this collection use set_references
.
A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Emails can have the following reference types at the time of creation: URL
| NUMBER
| STRING
| DATE
. EMAIL
| EMAIL_MESSAGE
|ATTACHMENT
are not a supported reference type during email creation.
Sourcepub fn set_references(self, input: Option<HashMap<String, Reference>>) -> Self
pub fn set_references(self, input: Option<HashMap<String, Reference>>) -> Self
A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Emails can have the following reference types at the time of creation: URL
| NUMBER
| STRING
| DATE
. EMAIL
| EMAIL_MESSAGE
|ATTACHMENT
are not a supported reference type during email creation.
Sourcepub fn get_references(&self) -> &Option<HashMap<String, Reference>>
pub fn get_references(&self) -> &Option<HashMap<String, Reference>>
A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Emails can have the following reference types at the time of creation: URL
| NUMBER
| STRING
| DATE
. EMAIL
| EMAIL_MESSAGE
|ATTACHMENT
are not a supported reference type during email creation.
Sourcepub fn name(self, input: impl Into<String>) -> Self
pub fn name(self, input: impl Into<String>) -> Self
The name of a email that is shown to an agent in the Contact Control Panel (CCP).
Sourcepub fn set_name(self, input: Option<String>) -> Self
pub fn set_name(self, input: Option<String>) -> Self
The name of a email that is shown to an agent in the Contact Control Panel (CCP).
Sourcepub fn get_name(&self) -> &Option<String>
pub fn get_name(&self) -> &Option<String>
The name of a email that is shown to an agent in the Contact Control Panel (CCP).
Sourcepub fn email_message(self, input: InboundEmailContent) -> Self
pub fn email_message(self, input: InboundEmailContent) -> Self
The email message body to be sent to the newly created email.
This field is required.Sourcepub fn set_email_message(self, input: Option<InboundEmailContent>) -> Self
pub fn set_email_message(self, input: Option<InboundEmailContent>) -> Self
The email message body to be sent to the newly created email.
Sourcepub fn get_email_message(&self) -> &Option<InboundEmailContent>
pub fn get_email_message(&self) -> &Option<InboundEmailContent>
The email message body to be sent to the newly created email.
Sourcepub fn additional_recipients(self, input: InboundAdditionalRecipients) -> Self
pub fn additional_recipients(self, input: InboundAdditionalRecipients) -> Self
The addtional recipients address of the email.
Sourcepub fn set_additional_recipients(
self,
input: Option<InboundAdditionalRecipients>,
) -> Self
pub fn set_additional_recipients( self, input: Option<InboundAdditionalRecipients>, ) -> Self
The addtional recipients address of the email.
Sourcepub fn get_additional_recipients(&self) -> &Option<InboundAdditionalRecipients>
pub fn get_additional_recipients(&self) -> &Option<InboundAdditionalRecipients>
The addtional recipients address of the email.
Sourcepub fn attachments(self, input: EmailAttachment) -> Self
pub fn attachments(self, input: EmailAttachment) -> Self
Appends an item to attachments
.
To override the contents of this collection use set_attachments
.
List of S3 presigned URLs of email attachments and their file name.
Sourcepub fn set_attachments(self, input: Option<Vec<EmailAttachment>>) -> Self
pub fn set_attachments(self, input: Option<Vec<EmailAttachment>>) -> Self
List of S3 presigned URLs of email attachments and their file name.
Sourcepub fn get_attachments(&self) -> &Option<Vec<EmailAttachment>>
pub fn get_attachments(&self) -> &Option<Vec<EmailAttachment>>
List of S3 presigned URLs of email attachments and their file name.
Sourcepub fn contact_flow_id(self, input: impl Into<String>) -> Self
pub fn contact_flow_id(self, input: impl Into<String>) -> Self
The identifier of the flow for initiating the emails. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to Routing, Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:
arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx
Sourcepub fn set_contact_flow_id(self, input: Option<String>) -> Self
pub fn set_contact_flow_id(self, input: Option<String>) -> Self
The identifier of the flow for initiating the emails. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to Routing, Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:
arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx
Sourcepub fn get_contact_flow_id(&self) -> &Option<String>
pub fn get_contact_flow_id(&self) -> &Option<String>
The identifier of the flow for initiating the emails. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to Routing, Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:
arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx
The contactId that is related to this contact. Linking emails together by using RelatedContactID
copies over contact attributes from the related email contact to the new email contact. All updates to user-defined attributes in the new email contact are limited to the individual contact ID. There are no limits to the number of contacts that can be linked by using RelatedContactId
.
The contactId that is related to this contact. Linking emails together by using RelatedContactID
copies over contact attributes from the related email contact to the new email contact. All updates to user-defined attributes in the new email contact are limited to the individual contact ID. There are no limits to the number of contacts that can be linked by using RelatedContactId
.
The contactId that is related to this contact. Linking emails together by using RelatedContactID
copies over contact attributes from the related email contact to the new email contact. All updates to user-defined attributes in the new email contact are limited to the individual contact ID. There are no limits to the number of contacts that can be linked by using RelatedContactId
.
Sourcepub fn attributes(self, k: impl Into<String>, v: impl Into<String>) -> Self
pub fn attributes(self, k: impl Into<String>, v: impl Into<String>) -> Self
Adds a key-value pair to attributes
.
To override the contents of this collection use set_attributes
.
A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.
There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.
Sourcepub fn set_attributes(self, input: Option<HashMap<String, String>>) -> Self
pub fn set_attributes(self, input: Option<HashMap<String, String>>) -> Self
A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.
There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.
Sourcepub fn get_attributes(&self) -> &Option<HashMap<String, String>>
pub fn get_attributes(&self) -> &Option<HashMap<String, String>>
A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.
There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.
Sourcepub fn segment_attributes(
self,
k: impl Into<String>,
v: SegmentAttributeValue,
) -> Self
pub fn segment_attributes( self, k: impl Into<String>, v: SegmentAttributeValue, ) -> Self
Adds a key-value pair to segment_attributes
.
To override the contents of this collection use set_segment_attributes
.
A set of system defined key-value pairs stored on individual contact segments using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows.
Attribute keys can include only alphanumeric, -, and _.
This field can be used to show channel subtype, such as connect:Guide
.
To set contact expiry, a ValueMap
must be specified containing the integer number of minutes the contact will be active for before expiring, with SegmentAttributes
like { "connect:ContactExpiry": {"ValueMap" : { "ExpiryDuration": { "ValueInteger":135}}}}
.
Sourcepub fn set_segment_attributes(
self,
input: Option<HashMap<String, SegmentAttributeValue>>,
) -> Self
pub fn set_segment_attributes( self, input: Option<HashMap<String, SegmentAttributeValue>>, ) -> Self
A set of system defined key-value pairs stored on individual contact segments using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows.
Attribute keys can include only alphanumeric, -, and _.
This field can be used to show channel subtype, such as connect:Guide
.
To set contact expiry, a ValueMap
must be specified containing the integer number of minutes the contact will be active for before expiring, with SegmentAttributes
like { "connect:ContactExpiry": {"ValueMap" : { "ExpiryDuration": { "ValueInteger":135}}}}
.
Sourcepub fn get_segment_attributes(
&self,
) -> &Option<HashMap<String, SegmentAttributeValue>>
pub fn get_segment_attributes( &self, ) -> &Option<HashMap<String, SegmentAttributeValue>>
A set of system defined key-value pairs stored on individual contact segments using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows.
Attribute keys can include only alphanumeric, -, and _.
This field can be used to show channel subtype, such as connect:Guide
.
To set contact expiry, a ValueMap
must be specified containing the integer number of minutes the contact will be active for before expiring, with SegmentAttributes
like { "connect:ContactExpiry": {"ValueMap" : { "ExpiryDuration": { "ValueInteger":135}}}}
.
Sourcepub fn client_token(self, input: impl Into<String>) -> Self
pub fn client_token(self, input: impl Into<String>) -> Self
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
Sourcepub fn set_client_token(self, input: Option<String>) -> Self
pub fn set_client_token(self, input: Option<String>) -> Self
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
Sourcepub fn get_client_token(&self) -> &Option<String>
pub fn get_client_token(&self) -> &Option<String>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
Sourcepub fn build(self) -> Result<StartEmailContactInput, BuildError>
pub fn build(self) -> Result<StartEmailContactInput, BuildError>
Consumes the builder and constructs a StartEmailContactInput
.
Source§impl StartEmailContactInputBuilder
impl StartEmailContactInputBuilder
Sourcepub async fn send_with(
self,
client: &Client,
) -> Result<StartEmailContactOutput, SdkError<StartEmailContactError, HttpResponse>>
pub async fn send_with( self, client: &Client, ) -> Result<StartEmailContactOutput, SdkError<StartEmailContactError, HttpResponse>>
Sends a request with this input using the given client.
Trait Implementations§
Source§impl Clone for StartEmailContactInputBuilder
impl Clone for StartEmailContactInputBuilder
Source§fn clone(&self) -> StartEmailContactInputBuilder
fn clone(&self) -> StartEmailContactInputBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Default for StartEmailContactInputBuilder
impl Default for StartEmailContactInputBuilder
Source§fn default() -> StartEmailContactInputBuilder
fn default() -> StartEmailContactInputBuilder
Source§impl PartialEq for StartEmailContactInputBuilder
impl PartialEq for StartEmailContactInputBuilder
Source§fn eq(&self, other: &StartEmailContactInputBuilder) -> bool
fn eq(&self, other: &StartEmailContactInputBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for StartEmailContactInputBuilder
Auto Trait Implementations§
impl Freeze for StartEmailContactInputBuilder
impl RefUnwindSafe for StartEmailContactInputBuilder
impl Send for StartEmailContactInputBuilder
impl Sync for StartEmailContactInputBuilder
impl Unpin for StartEmailContactInputBuilder
impl UnwindSafe for StartEmailContactInputBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.bright_black());
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.bright_green());
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.bright_yellow());
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.bright_magenta());
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.bright_white());
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.on_bright_black());
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.on_bright_green());
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.on_bright_yellow());
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlue
.
§Example
println!("{}", value.on_bright_blue());
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.on_bright_magenta());
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightCyan
.
§Example
println!("{}", value.on_bright_cyan());
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.on_bright_white());
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::Underline
.
§Example
println!("{}", value.underline());
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::RapidBlink
.
§Example
println!("{}", value.rapid_blink());
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);