Struct mailslurp::models::webhook_payload::WebhookPayload

pub struct WebhookPayload {

    pub attachment_meta_datas: Option<Vec<AttachmentMetaData>>,
    pub bcc: Option<Vec<String>>,
    pub cc: Option<Vec<String>>,
    pub created_at: Option<String>,
    pub email_id: Option<String>,
    pub event_name: Option<EventName>,
    pub from: Option<String>,
    pub inbox_id: Option<String>,
    pub message_id: Option<String>,
    pub subject: Option<String>,
    pub to: Option<Vec<String>>,
    pub webhook_id: Option<String>,
    pub webhook_name: Option<String>,
}

WebhookPayload : MailSlurp webhook payload schema is available at https://api.mailslurp.com/schemas/webhook-payload. This schema describes the JSON object that is sent via HTTP POST to webhook urls when an email is received by an inbox that a webhook is attached to. Payloads may be delivered multiple times so use the ID as a key for event uniqueness. The payload contains IDs for the email and inbox affected. Use these to fetch more data related to the event using appropriate inbox and email endpoints. See https://www.mailslurp.com/guides/email-webhooks/ for more information. Your webhook endpoint should accept POST HTTP request and return a 200 in under 30 seconds. Process the webhook asynchronously if you need to.

Fields

attachment_meta_datas: Option<Vec<AttachmentMetaData>>

List of attachment meta data objects if attachments present

bcc: Option<Vec<String>>

List of BCC recipients email was addressed to

cc: Option<Vec<String>>

List of CC recipients email was addressed to

created_at: Option<String>

Date time of event creation

email_id: Option<String>

ID of the email that was received. Use this ID for fetching the email

event_name: Option<EventName>

Name of the event type webhook is being triggered for

from: Option<String>

Who the email was sent from

inbox_id: Option<String>

Id of the inbox that receive an email

message_id: Option<String>

Idempotent message ID. Store this ID locally or in a database to prevent message duplication.

subject: Option<String>

The subject line of the email message

to: Option<Vec<String>>

List of To recipients that email was addressed to

webhook_id: Option<String>

ID of webhook entity being triggered

webhook_name: Option<String>

Name of the webhook being triggered

Implementations

impl WebhookPayload

pub fn new() -> WebhookPayload

MailSlurp webhook payload schema is available at https://api.mailslurp.com/schemas/webhook-payload. This schema describes the JSON object that is sent via HTTP POST to webhook urls when an email is received by an inbox that a webhook is attached to. Payloads may be delivered multiple times so use the ID as a key for event uniqueness. The payload contains IDs for the email and inbox affected. Use these to fetch more data related to the event using appropriate inbox and email endpoints. See https://www.mailslurp.com/guides/email-webhooks/ for more information. Your webhook endpoint should accept POST HTTP request and return a 200 in under 30 seconds. Process the webhook asynchronously if you need to.

Trait Implementations

impl Clone for WebhookPayload

fn clone(&self) -> WebhookPayload

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WebhookPayload

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for WebhookPayload

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

Deserialize this value from the given Serde deserializer.

impl PartialEq<WebhookPayload> for WebhookPayload

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

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

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

This method tests for !=.

impl Serialize for WebhookPayload

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 WebhookPayload