common_reports.schemas.emails.requests
Validated inputs for provider-neutral mailbox operations.
Classes
DraftRequest
Bases: BaseModel
A draft message, optionally attached to an existing thread.
Fields and properties declared here; inherited members belong to the bases above.
in_reply_to
in_reply_to: Optional[str] = Nonemessage
message: EmailMessagereferences
references: tuple[str, ...] = ()thread_id
thread_id: Optional[str] = NoneHistoryQuery
Bases: BaseModel
Continue mailbox reconciliation from an earlier history cursor.
Fields and properties declared here; inherited members belong to the bases above.
history_types
history_types: list[Literal['messageAdded', 'messageDeleted', 'labelAdded', 'labelRemoved']] = Field(default_factory=list)label_id
label_id: Optional[str] = Nonemax_results
max_results: int = Field(default=100, ge=1, le=500)page_token
page_token: Optional[str] = Nonestart_history_id
start_history_id: str = Field(min_length=1)LabelCreateRequest
Bases: BaseModel
Create a provider label with optional visibility preferences.
Fields and properties declared here; inherited members belong to the bases above.
label_list_visibility
label_list_visibility: Literal['labelShow', 'labelShowIfUnread', 'labelHide'] = 'labelShow'message_list_visibility
message_list_visibility: Literal['show', 'hide'] = 'show'name
name: str = Field(min_length=1)LabelUpdate
Bases: BaseModel
Add/remove labels on exact messages or threads.
Fields and properties declared here; inherited members belong to the bases above.
add_label_ids
add_label_ids: list[str] = Field(default_factory=list)remove_label_ids
remove_label_ids: list[str] = Field(default_factory=list)target_ids
target_ids: list[str] = Field(min_length=1)target_kind
target_kind: Literal['message', 'thread'] = 'message'MessageQuery
Bases: BaseModel
Provider-neutral message search with provider-native query escape hatch.
Fields and properties declared here; inherited members belong to the bases above.
folder
folder: Optional[str] = Field(default=None, description='Mailbox folder such as INBOX')include_spam_trash
include_spam_trash: bool = Falselabel_ids
label_ids: list[str] = Field(default_factory=list)max_results
max_results: int = Field(default=100, ge=1, le=500)page_token
page_token: Optional[str] = Nonetext
text: Optional[str] = Field(default=None, description='Free-text/provider search expression')unseen_only
unseen_only: bool = FalseReplyRequest
Bases: BaseModel
A reply anchored to an exact provider message.
Fields and properties declared here; inherited members belong to the bases above.
message
message: EmailMessagemessage_id
message_id: str = Field(min_length=1)reply_all
reply_all: bool = Falsethread_id
thread_id: Optional[str] = NoneWatchRequest
Bases: BaseModel
Configure Gmail push publication for a mailbox.
Fields and properties declared here; inherited members belong to the bases above.
label_filter_behavior
label_filter_behavior: Literal['include', 'exclude'] = 'include'label_ids
label_ids: list[str] = Field(default_factory=list)topic_name
topic_name: str = Field(min_length=1)