Struct mailslurp::models::create_inbox_dto::CreateInboxDto [−][src]
pub struct CreateInboxDto { pub allow_team_access: Option<bool>, pub description: Option<String>, pub email_address: Option<String>, pub expires_at: Option<String>, pub expires_in: Option<i64>, pub favourite: Option<bool>, pub inbox_type: Option<InboxType>, pub name: Option<String>, pub tags: Option<Vec<String>>, pub use_domain_pool: Option<bool>, }
Expand description
CreateInboxDto : Options for creating an inbox. An inbox has a real email address that can send and receive emails. Inboxes can be permanent or expire at a given time. They can use a custom email address (by verifying your own domain) or a randomly assigned email ending in either mailslurp.com
or if useDomainPool
is enabled then ending in a similar domains such as mailslurp.xyz
(selected at random).
Fields
allow_team_access: Option<bool>
Expand description
Grant team access to this inbox and the emails that belong to it for team members of your organization.
description: Option<String>
Expand description
Optional description of the inbox for labelling purposes. Is shown in the dashboard and can be used with
email_address: Option<String>
Expand description
A custom email address to use with the inbox. Defaults to null. When null MailSlurp will assign a random email address to the inbox such as 123@mailslurp.com
. If you use the useDomainPool
option when the email address is null it will generate an email address with a more varied domain ending such as 123@mailslurp.info
or 123@mailslurp.biz
. When a custom email address is provided the address is split into a domain and the domain is queried against your user. If you have created the domain in the MailSlurp dashboard and verified it you can use any email address that ends with the domain. Send an email to this address and the inbox will receive and store it for you. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID.
expires_at: Option<String>
Expand description
Optional inbox expiration date. If null then this inbox is permanent and the emails in it won’t be deleted. If an expiration date is provided or is required by your plan the inbox will be closed when the expiration time is reached. Expired inboxes still contain their emails but can no longer send or receive emails. An ExpiredInboxRecord is created when an inbox and the email address and inbox ID are recorded. The expiresAt property is a timestamp string in ISO DateTime Format yyyy-MM-dd’T’HH:mm:ss.SSSXXX.
expires_in: Option<i64>
Expand description
Number of milliseconds that inbox should exist for
favourite: Option<bool>
Expand description
Is the inbox favorited. Favouriting inboxes is typically done in the dashboard for quick access or filtering
inbox_type: Option<InboxType>
Expand description
HTTP or SMTP inbox
name: Option<String>
Expand description
Optional name of the inbox. Displayed in the dashboard for easier search
Expand description
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.
use_domain_pool: Option<bool>
Expand description
Use the MailSlurp domain name pool with this inbox when creating the email address. Defaults to null. If enabled the inbox will be an email address with a domain randomly chosen from a list of the MailSlurp domains. This is useful when the default @mailslurp.com
email addresses used with inboxes are blocked or considered spam by a provider or receiving service. When domain pool is enabled an email address will be generated ending in @mailslurp.{world,info,xyz,...}
. This means a TLD is randomly selecting from a list of .biz
, .info
, .xyz
etc to add variance to the generated email addresses. When null or false MailSlurp uses the default behavior of @mailslurp.com
or custom email address provided by the emailAddress field.
Implementations
impl CreateInboxDto
[src]
impl CreateInboxDto
[src]pub fn new() -> CreateInboxDto
[src]
pub fn new() -> CreateInboxDto
[src]Options for creating an inbox. An inbox has a real email address that can send and receive emails. Inboxes can be permanent or expire at a given time. They can use a custom email address (by verifying your own domain) or a randomly assigned email ending in either mailslurp.com
or if useDomainPool
is enabled then ending in a similar domains such as mailslurp.xyz
(selected at random).
Trait Implementations
impl Clone for CreateInboxDto
[src]
impl Clone for CreateInboxDto
[src]fn clone(&self) -> CreateInboxDto
[src]
fn clone(&self) -> CreateInboxDto
[src]Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]Performs copy-assignment from source
. Read more
impl Debug for CreateInboxDto
[src]
impl Debug for CreateInboxDto
[src]impl<'de> Deserialize<'de> for CreateInboxDto
[src]
impl<'de> Deserialize<'de> for CreateInboxDto
[src]fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]Deserialize this value from the given Serde deserializer. Read more
impl PartialEq<CreateInboxDto> for CreateInboxDto
[src]
impl PartialEq<CreateInboxDto> for CreateInboxDto
[src]fn eq(&self, other: &CreateInboxDto) -> bool
[src]
fn eq(&self, other: &CreateInboxDto) -> bool
[src]This method tests for self
and other
values to be equal, and is used
by ==
. Read more
fn ne(&self, other: &CreateInboxDto) -> bool
[src]
fn ne(&self, other: &CreateInboxDto) -> bool
[src]This method tests for !=
.
impl Serialize for CreateInboxDto
[src]
impl Serialize for CreateInboxDto
[src]impl StructuralPartialEq for CreateInboxDto
[src]
Auto Trait Implementations
impl RefUnwindSafe for CreateInboxDto
impl Send for CreateInboxDto
impl Sync for CreateInboxDto
impl Unpin for CreateInboxDto
impl UnwindSafe for CreateInboxDto
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> Instrument for T
[src]
impl<T> Instrument for T
[src]fn instrument(self, span: Span) -> Instrumented<Self>
[src]
fn instrument(self, span: Span) -> Instrumented<Self>
[src]Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
fn in_current_span(self) -> Instrumented<Self>
[src]
fn in_current_span(self) -> Instrumented<Self>
[src]impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
[src]
pub fn clone_into(&self, target: &mut T)
[src]🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
T: for<'de> Deserialize<'de>,