Struct mailchimp::types::CampaignType

pub struct CampaignType {
    pub id: Option<String>,
    pub web_id: Option<u64>,
    pub parent_campaign_id: Option<String>,
    pub campaign_type: Option<String>,
    pub create_time: Option<String>,
    pub archive_url: Option<String>,
    pub long_archive_url: Option<String>,
    pub status: Option<String>,
    pub emails_sent: Option<u64>,
    pub send_time: Option<String>,
    pub content_type: Option<String>,
    pub needs_block_refresh: Option<bool>,
    pub has_logo_merge_tag: Option<bool>,
    pub resendable: Option<bool>,
    pub recipients: Option<RecipientType>,
    pub settings: Option<CampaignSettingsType>,
    pub variate_settings: Option<VariateSettingsType>,
    pub tracking: Option<CampaignTrackingOptionsType>,
    pub rss_opts: Option<RSSOptionsType>,
    pub ab_split_opts: Option<ABTestingOptionsType>,
    pub social_card: Option<SocialCardType>,
    pub report_summary: Option<CampaignReportSummaryType>,
    pub delivery_status: Option<CampaignDeliveryStatusType>,
    pub _links: Option<Vec<LinkType>>,
    // some fields omitted
}

Fields

id: Option<String>

A string that uniquely identifies this campaign.

web_id: Option<u64>

The ID used in the Mailchimp web application. View this campaign in your Mailchimp account at https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}.

parent_campaign_id: Option<String>

If this campaign is the child of another campaign, this identifies the parent campaign. For Example, for RSS or Automation children.

campaign_type: Option<String>

There are four types of campaigns you can create in Mailchimp. A/B Split campaigns have been deprecated and variate campaigns should be used instead.

create_time: Option<String>

The date and time the campaign was created in ISO 8601 format.

archive_url: Option<String>

The link to the campaign’s archive version in ISO 8601 format.

long_archive_url: Option<String>

The original link to the campaign’s archive version.

status: Option<String>

The current status of the campaign.

emails_sent: Option<u64>

The total number of emails sent for this campaign.

send_time: Option<String>

The date and time a campaign was sent.

content_type: Option<String>

How the campaign’s content is put together (‘template’, ‘drag_and_drop’, ‘html’, ‘url’).

needs_block_refresh: Option<bool>

Determines if the campaign needs its blocks refreshed by opening the web-based campaign editor.

has_logo_merge_tag: Option<bool>

Determines if the campaign contains the |BRAND:LOGO| merge tag.

resendable: Option<bool>

Determines if the campaign qualifies to be resent to non-openers.

recipients: Option<RecipientType>

List settings for the campaign.

settings: Option<CampaignSettingsType>

The settings for your campaign, including subject, from name, reply-to address, and more.

variate_settings: Option<VariateSettingsType>

The settings specific to A/B test campaigns.

tracking: Option<CampaignTrackingOptionsType>

The tracking options for a campaign.

rss_opts: Option<RSSOptionsType>

RSS options for a campaign.

ab_split_opts: Option<ABTestingOptionsType>

A/B Testing options for a campaign.

social_card: Option<SocialCardType>

The preview for the campaign, rendered by social networks like Facebook and Twitter. Learn more.

report_summary: Option<CampaignReportSummaryType>

For sent campaigns, a summary of opens, clicks, and e-commerce data.

delivery_status: Option<CampaignDeliveryStatusType>

Updates on campaigns in the process of sending.

_links: Option<Vec<LinkType>>

Desc: A list of link types and descriptions for the API schema documents.

Methods

impl CampaignType

pub fn cancel_campaign(&self) -> Result<EmptyType, MailchimpErrorType>

Cancel a campaign

pub fn resend_campaign(&self) -> Result<CampaignType, MailchimpErrorType>

Resend a campaign

pub fn pause_rss_driven_campaign(&self) -> Result<EmptyType, MailchimpErrorType>

Pause an RSS-Driven campaign

pub fn replicate_campaign(&self) -> Result<CampaignType, MailchimpErrorType>

Replicate a campaign in saved or send status.

pub fn resume_rss_driven_campaign(
    &self
) -> Result<EmptyType, MailchimpErrorType>

Resume an RSS-Driven campaign.

pub fn schedule_campaign(
    &self,
    param: ScheduleParam
) -> Result<EmptyType, MailchimpErrorType>

Schedule a campaign for delivery. If you’re using Multivariate Campaigns to test send times or sending RSS Campaigns, use the send action instead.

pub fn send_campaign(&self) -> Result<EmptyType, MailchimpErrorType>

Send a Mailchimp campaign. For RSS Campaigns, the campaign will send according to its schedule. All other campaigns will send immediately.

pub fn send_test_email(
    &self,
    param: EmailParam
) -> Result<EmptyType, MailchimpErrorType>

Send a test email.

pub fn unschedule_campaign(&self) -> Result<EmptyType, MailchimpErrorType>

Unschedule a scheduled campaign that hasn’t started sending.

pub fn delete(&self) -> Result<bool, MailchimpErrorType>

Remove a campaign from your Mailchimp account.

pub fn update(
    &self,
    param: UpdateCampaignParam
) -> Result<CampaignType, MailchimpErrorType>

Remove a campaign from your Mailchimp account.

pub fn get_content(
    &self,
    fields: Option<String>,
    exclude_fields: Option<String>
) -> Result<CampaignContentType, MailchimpErrorType>

Get the the HTML and plain-text content for a campaign.

Arguments: fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

pub fn update_content(
    &self,
    param: CampaignContentParam
) -> Result<CampaignContentType, MailchimpErrorType>

Set the content for a campaign.

pub fn send_checklist(
    &self,
    fields: Option<String>,
    exclude_fields: Option<String>
) -> Result<SendChecklistType, MailchimpErrorType>

Review the send checklist for a campaign, and resolve any issues before sending.

Arguments: fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Important traits for MalchimpIter<B>

impl<B> Iterator for MalchimpIter<B> where
    B: BuildIter,
    B::FilterItem: ResourceFilter,
    B::Collection: MailchimpCollection<B::Item> + DeserializeOwned + Default,  type Item = B::Item;

pub fn get_feedbacks(
    &self,
    fields: Option<String>,
    exclude_fields: Option<String>
) -> MalchimpIter<CampaignFeedbackBuilder>

Get team feedback while you’re working together on a Mailchimp campaign.

Arguments: fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

pub fn get_feedback_info<'a>(
    &self,
    feedback_id: &'a str,
    fields: Option<String>,
    exclude_fields: Option<String>
) -> Result<CampaignFeedbackType, MailchimpErrorType>

Trait Implementations

impl MailchimpCollection<CampaignType> for CampaignsType

fn get_total_items(&self) -> u64

Total Items

fn get_values(&self) -> Vec<CampaignType>

Data

impl Clone for CampaignType

fn clone(&self) -> CampaignType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CampaignType

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Serialize for CampaignType

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

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for CampaignType

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

Deserialize this value from the given Serde deserializer.