QuoteWidget API

QuoteWidget(widget_id=None)

Bases: BaseWidget

创建一个带有引述风格的文本块，用于突出显示引用的内容.

该微件非常适合在邮件中引用名言、客户评价、重要声明或文献摘要. 它通过在左侧添加一条彩色的竖线来与其他文本区分开，使其在视觉上更引人注目.

核心功能

• 内容归属: 支持设置引述的作者和来源.
• 主题化: 引述的左侧边框颜色可以根据状态类型（如 INFO, SUCCESS, WARNING）改变.

Attributes:

Name	Type	Description
content	str	被引用的主要文本内容.
author	Optional[str]	引述的作者.
source	Optional[str]	引述的出处或来源.
quote_type	StatusType	引述的类型，决定了左侧边框的颜色.

Examples:

创建一个经典的名人名言引述：

Python

from email_widget.widgets import QuoteWidget
from email_widget.core.enums import StatusType

quote = (QuoteWidget()                 .set_content("The only way to do great work is to love what you do.")                 .set_author("Steve Jobs")                 .set_quote_type(StatusType.INFO))

# 假设 email 是一个 Email 对象
# email.add_widget(quote)

创建一个用于展示客户好评的引述：

Python

customer_feedback = (QuoteWidget()                             .set_content("This new feature has significantly improved our workflow!")                             .set_author("Satisfied Customer")                             .set_source("Feedback Survey")                             .set_quote_type(StatusType.SUCCESS))

初始化QuoteWidget.

Parameters:

Name	Type	Description	Default
widget_id	Optional[str]	可选的Widget ID.	None

Functions

clear_attribution()

清空作者和来源信息.

Returns:

Name	Type	Description
QuoteWidget	QuoteWidget	返回self以支持链式调用.

Examples:

Python Console Session

>>> quote = QuoteWidget().clear_attribution()

get_template_context()

获取模板渲染所需的上下文数据

set_author(author)

设置引用的作者.

Parameters:

Name	Type	Description	Default
author	str	作者姓名.	required

Returns:

Name	Type	Description
QuoteWidget	QuoteWidget	返回self以支持链式调用.

Examples:

Python Console Session

>>> quote = QuoteWidget().set_author("鲁迅")

set_content(content)

设置引用的主要文本内容.

Parameters:

Name	Type	Description	Default
content	str	被引用的文本内容.	required

Returns:

Name	Type	Description
QuoteWidget	QuoteWidget	返回self以支持链式调用.

Examples:

Python Console Session

>>> quote = QuoteWidget().set_content("知识就是力量.")

set_full_quote(content, author=None, source=None)

一次性设置完整的引用信息.

此方法允许同时设置引用内容、作者和来源，方便快速配置.

Parameters:

Name	Type	Description	Default
content	str	引用内容.	required
author	str	可选的作者姓名.	None
source	str	可选的来源描述.	None

Returns:

Name	Type	Description
QuoteWidget	QuoteWidget	返回self以支持链式调用.

Examples:

Python Console Session

>>> quote = QuoteWidget().set_full_quote("天行健，君子以自强不息.", "《周易》")

set_quote_type(quote_type)

设置引用的类型.

此类型决定了引用块左侧边框的颜色.

Parameters:

Name	Type	Description	Default
quote_type	StatusType	引用类型枚举值.	required

Returns:

Name	Type	Description
QuoteWidget	QuoteWidget	返回self以支持链式调用.

Examples:

Python Console Session

>>> quote = QuoteWidget().set_quote_type(StatusType.WARNING)

set_source(source)

设置引用的来源.

Parameters:

Name	Type	Description	Default
source	str	来源描述（如书籍名称、网站、报告等）.	required

Returns:

Name	Type	Description
QuoteWidget	QuoteWidget	返回self以支持链式调用.

Examples:

Python Console Session

>>> quote = QuoteWidget().set_source("《论语》")