Struct mailslurp::models::inbox::Inbox

pub struct Inbox {
    pub created_at: Option<String>,
    pub description: Option<String>,
    pub email_address: Option<String>,
    pub expires_at: Option<String>,
    pub favourite: Option<bool>,
    pub id: Option<String>,
    pub inbox_type: Option<InboxType>,
    pub name: Option<String>,
    pub read_only: Option<bool>,
    pub tags: Option<Vec<String>>,
    pub team_access: Option<bool>,
    pub user_id: Option<String>,
}

Inbox : Representation of a MailSlurp inbox. An inbox has an ID and a real email address. Emails can be sent to or from this email address. Inboxes are either SMTP or HTTP mailboxes. The default, HTTP inboxes, use AWS SES to process emails and are best suited as test email accounts. SMTP inboxes use a custom mail server at mx.mailslurp.com and are best used for public facing email addresses. Use the EmailController or the InboxController methods to send and receive emails and attachments. Inboxes may have a description, name, and tags for display purposes. You can also favourite an inbox for easier searching. Inboxes can be private or allow team access. Team access enabled inboxes can be seen by other members of an organization.

Fields

created_at: Option<String>

When the inbox was created. Time stamps are in ISO DateTime Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX e.g. 2000-10-31T01:30:00.000-05:00.

description: Option<String>

Description of an inbox for labelling and searching purposes

email_address: Option<String>

The inbox’s email address. Inbox projections and previews may not include the email address. To view the email address fetch the inbox entity directly. Send an email to this address and the inbox will receive and store it for you. Note the email address in MailSlurp match characters exactly and are case sensitive so +123 additions are considered different addresses. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID.

expires_at: Option<String>

Inbox expiration time. When, if ever, the inbox should expire and be deleted. If null then this inbox is permanent and the emails in it won’t be deleted. This is the default behavior unless expiration date is set. If an expiration date is set and the time is reached MailSlurp will expire the inbox and move it to an expired inbox entity. You can still access the emails belonging to it but it can no longer send or receive email.

favourite: Option<bool>

Is the inbox a favorite inbox. Make an inbox a favorite is typically done in the dashboard for quick access or filtering

id: Option<String>

ID of the inbox. The ID is a UUID-V4 format string. Use the inboxId for calls to Inbox and Email Controller endpoints. See the emailAddress property for the email address or the inbox. To get emails in an inbox use the WaitFor and Inbox Controller methods waitForLatestEmail and getEmails methods respectively. Inboxes can be used with aliases to forward emails automatically.

inbox_type: Option<InboxType>

Type of inbox - either HTTP (default) or SMTP. HTTP inboxes are great for testing. SMTP inboxes are processed by a custom SMTP mail server and are better for public facing inboxes that receive emails from Gmail and other large providers. If using a custom domain the domain type must match the inbox type. Use an SMTP domain for SMTP inboxes that includes an MX record pointing to 10 mx.mailslurp.com for inbound messages.

name: Option<String>

Name of the inbox and used as the sender name when sending emails .Displayed in the dashboard for easier search

read_only: Option<bool>

Is the inbox readOnly for the caller. Read only means can not be deleted or modified. This flag is present when using team accounts and shared inboxes.

tags: Option<Vec<String>>

Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI.

team_access: Option<bool>

Does inbox permit team access for organization team members. If so team users can use inbox and emails associated with it. See the team access guide at https://www.mailslurp.com/guides/team-email-account-sharing/

user_id: Option<String>

ID of user that inbox belongs to

Implementations

impl Inbox

pub fn new() -> Inbox

Representation of a MailSlurp inbox. An inbox has an ID and a real email address. Emails can be sent to or from this email address. Inboxes are either SMTP or HTTP mailboxes. The default, HTTP inboxes, use AWS SES to process emails and are best suited as test email accounts. SMTP inboxes use a custom mail server at mx.mailslurp.com and are best used for public facing email addresses. Use the EmailController or the InboxController methods to send and receive emails and attachments. Inboxes may have a description, name, and tags for display purposes. You can also favourite an inbox for easier searching. Inboxes can be private or allow team access. Team access enabled inboxes can be seen by other members of an organization.

Trait Implementations

impl Clone for Inbox

fn clone(&self) -> Inbox

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Inbox

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Inbox

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

Deserialize this value from the given Serde deserializer.

impl PartialEq<Inbox> for Inbox

fn eq(&self, other: &Inbox) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Inbox) -> bool

This method tests for !=.

impl Serialize for Inbox

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Inbox