Class ExtractAttachmentTextResult
Extracted text result for an attachment
Implements
Inherited Members
Namespace: mailslurp.Model
Assembly: mailslurp.dll
Syntax
[DataContract(Name = "ExtractAttachmentTextResult")]
public class ExtractAttachmentTextResult : IValidatableObject
Constructors
View SourceExtractAttachmentTextResult()
Initializes a new instance of the ExtractAttachmentTextResult class.
Declaration
[JsonConstructor]
protected ExtractAttachmentTextResult()
ExtractAttachmentTextResult(bool, string, MethodUsedEnum?, string, List<string>)
Initializes a new instance of the ExtractAttachmentTextResult class.
Declaration
public ExtractAttachmentTextResult(bool present = false, string text = null, ExtractAttachmentTextResult.MethodUsedEnum? methodUsed = null, string contentType = null, List<string> warnings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| bool | present | True if extracted text is present (required). |
| string | text | Extracted text when present. |
| ExtractAttachmentTextResult.MethodUsedEnum? | methodUsed | Method for extracting text from attachments. OCR/LLM methods are reserved for advanced extraction.. |
| string | contentType | Detected attachment content type. |
| List<string> | warnings | Warnings or fallback notes (required). |
Properties
View SourceContentType
Detected attachment content type
Declaration
[DataMember(Name = "contentType", EmitDefaultValue = true)]
public string ContentType { get; set; }
Property Value
| Type | Description |
|---|---|
| string | Detected attachment content type |
MethodUsed
Method for extracting text from attachments. OCR/LLM methods are reserved for advanced extraction.
Declaration
[DataMember(Name = "methodUsed", EmitDefaultValue = true)]
public ExtractAttachmentTextResult.MethodUsedEnum? MethodUsed { get; set; }
Property Value
| Type | Description |
|---|---|
| ExtractAttachmentTextResult.MethodUsedEnum? | Method for extracting text from attachments. OCR/LLM methods are reserved for advanced extraction. |
Present
True if extracted text is present
Declaration
[DataMember(Name = "present", IsRequired = true, EmitDefaultValue = true)]
public bool Present { get; set; }
Property Value
| Type | Description |
|---|---|
| bool | True if extracted text is present |
Text
Extracted text when present
Declaration
[DataMember(Name = "text", EmitDefaultValue = true)]
public string Text { get; set; }
Property Value
| Type | Description |
|---|---|
| string | Extracted text when present |
Warnings
Warnings or fallback notes
Declaration
[DataMember(Name = "warnings", IsRequired = true, EmitDefaultValue = true)]
public List<string> Warnings { get; set; }
Property Value
| Type | Description |
|---|---|
| List<string> | Warnings or fallback notes |
Methods
View SourceToJson()
Returns the JSON string presentation of the object
Declaration
public virtual string ToJson()
Returns
| Type | Description |
|---|---|
| string | JSON string presentation of the object |
ToString()
Returns the string presentation of the object
Declaration
public override string ToString()
Returns
| Type | Description |
|---|---|
| string | String presentation of the object |