#[non_exhaustive]pub struct DomainDeliverabilityCampaign {Show 14 fields
pub campaign_id: Option<String>,
pub image_url: Option<String>,
pub subject: Option<String>,
pub from_address: Option<String>,
pub sending_ips: Option<Vec<String>>,
pub first_seen_date_time: Option<DateTime>,
pub last_seen_date_time: Option<DateTime>,
pub inbox_count: Option<i64>,
pub spam_count: Option<i64>,
pub read_rate: Option<f64>,
pub delete_rate: Option<f64>,
pub read_delete_rate: Option<f64>,
pub projected_volume: Option<i64>,
pub esps: Option<Vec<String>>,
}
Expand description
An object that contains the deliverability data for a specific campaign. This data is available for a campaign only if the campaign sent email by using a domain that the Deliverability dashboard is enabled for (PutDeliverabilityDashboardOption
operation).
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.campaign_id: Option<String>
The unique identifier for the campaign. The Deliverability dashboard automatically generates and assigns this identifier to a campaign.
image_url: Option<String>
The URL of an image that contains a snapshot of the email message that was sent.
subject: Option<String>
The subject line, or title, of the email message.
from_address: Option<String>
The verified email address that the email message was sent from.
sending_ips: Option<Vec<String>>
The IP addresses that were used to send the email message.
first_seen_date_time: Option<DateTime>
The first time when the email message was delivered to any recipient's inbox. This value can help you determine how long it took for a campaign to deliver an email message.
last_seen_date_time: Option<DateTime>
The last time when the email message was delivered to any recipient's inbox. This value can help you determine how long it took for a campaign to deliver an email message.
inbox_count: Option<i64>
The number of email messages that were delivered to recipients’ inboxes.
spam_count: Option<i64>
The number of email messages that were delivered to recipients' spam or junk mail folders.
read_rate: Option<f64>
The percentage of email messages that were opened by recipients. Due to technical limitations, this value only includes recipients who opened the message by using an email client that supports images.
delete_rate: Option<f64>
The percentage of email messages that were deleted by recipients, without being opened first. Due to technical limitations, this value only includes recipients who opened the message by using an email client that supports images.
read_delete_rate: Option<f64>
The percentage of email messages that were opened and then deleted by recipients. Due to technical limitations, this value only includes recipients who opened the message by using an email client that supports images.
projected_volume: Option<i64>
The projected number of recipients that the email message was sent to.
esps: Option<Vec<String>>
The major email providers who handled the email message.
Implementations§
Source§impl DomainDeliverabilityCampaign
impl DomainDeliverabilityCampaign
Sourcepub fn campaign_id(&self) -> Option<&str>
pub fn campaign_id(&self) -> Option<&str>
The unique identifier for the campaign. The Deliverability dashboard automatically generates and assigns this identifier to a campaign.
Sourcepub fn image_url(&self) -> Option<&str>
pub fn image_url(&self) -> Option<&str>
The URL of an image that contains a snapshot of the email message that was sent.
Sourcepub fn from_address(&self) -> Option<&str>
pub fn from_address(&self) -> Option<&str>
The verified email address that the email message was sent from.
Sourcepub fn sending_ips(&self) -> &[String]
pub fn sending_ips(&self) -> &[String]
The IP addresses that were used to send the email message.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .sending_ips.is_none()
.
Sourcepub fn first_seen_date_time(&self) -> Option<&DateTime>
pub fn first_seen_date_time(&self) -> Option<&DateTime>
The first time when the email message was delivered to any recipient's inbox. This value can help you determine how long it took for a campaign to deliver an email message.
Sourcepub fn last_seen_date_time(&self) -> Option<&DateTime>
pub fn last_seen_date_time(&self) -> Option<&DateTime>
The last time when the email message was delivered to any recipient's inbox. This value can help you determine how long it took for a campaign to deliver an email message.
Sourcepub fn inbox_count(&self) -> Option<i64>
pub fn inbox_count(&self) -> Option<i64>
The number of email messages that were delivered to recipients’ inboxes.
Sourcepub fn spam_count(&self) -> Option<i64>
pub fn spam_count(&self) -> Option<i64>
The number of email messages that were delivered to recipients' spam or junk mail folders.
Sourcepub fn read_rate(&self) -> Option<f64>
pub fn read_rate(&self) -> Option<f64>
The percentage of email messages that were opened by recipients. Due to technical limitations, this value only includes recipients who opened the message by using an email client that supports images.
Sourcepub fn delete_rate(&self) -> Option<f64>
pub fn delete_rate(&self) -> Option<f64>
The percentage of email messages that were deleted by recipients, without being opened first. Due to technical limitations, this value only includes recipients who opened the message by using an email client that supports images.
Sourcepub fn read_delete_rate(&self) -> Option<f64>
pub fn read_delete_rate(&self) -> Option<f64>
The percentage of email messages that were opened and then deleted by recipients. Due to technical limitations, this value only includes recipients who opened the message by using an email client that supports images.
Sourcepub fn projected_volume(&self) -> Option<i64>
pub fn projected_volume(&self) -> Option<i64>
The projected number of recipients that the email message was sent to.
Source§impl DomainDeliverabilityCampaign
impl DomainDeliverabilityCampaign
Sourcepub fn builder() -> DomainDeliverabilityCampaignBuilder
pub fn builder() -> DomainDeliverabilityCampaignBuilder
Creates a new builder-style object to manufacture DomainDeliverabilityCampaign
.
Trait Implementations§
Source§impl Clone for DomainDeliverabilityCampaign
impl Clone for DomainDeliverabilityCampaign
Source§fn clone(&self) -> DomainDeliverabilityCampaign
fn clone(&self) -> DomainDeliverabilityCampaign
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for DomainDeliverabilityCampaign
impl Debug for DomainDeliverabilityCampaign
Source§impl PartialEq for DomainDeliverabilityCampaign
impl PartialEq for DomainDeliverabilityCampaign
Source§fn eq(&self, other: &DomainDeliverabilityCampaign) -> bool
fn eq(&self, other: &DomainDeliverabilityCampaign) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for DomainDeliverabilityCampaign
Auto Trait Implementations§
impl Freeze for DomainDeliverabilityCampaign
impl RefUnwindSafe for DomainDeliverabilityCampaign
impl Send for DomainDeliverabilityCampaign
impl Sync for DomainDeliverabilityCampaign
impl Unpin for DomainDeliverabilityCampaign
impl UnwindSafe for DomainDeliverabilityCampaign
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>
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>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
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>
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>
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>
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>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
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 rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
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);