Class ExtractAttachmentTextOptions

Options for extracting text from an attachment. Choose a method and whether fallback is allowed.

Inheritance
object
ExtractAttachmentTextOptions
Implements
Inherited Members
Namespace: mailslurp.Model
Assembly: mailslurp.dll
Syntax
[DataContract(Name = "ExtractAttachmentTextOptions")]
public class ExtractAttachmentTextOptions : IValidatableObject

Constructors

View Source

ExtractAttachmentTextOptions(MethodEnum?, bool, long?)

Initializes a new instance of the ExtractAttachmentTextOptions class.

Declaration
public ExtractAttachmentTextOptions(ExtractAttachmentTextOptions.MethodEnum? method = null, bool allowFallback = true, long? maxBytes = 1048576)
Parameters
Type Name Description
ExtractAttachmentTextOptions.MethodEnum? method

Method for extracting text from attachments. OCR/LLM methods are reserved for advanced extraction..
bool allowFallback

Allow fallback to native extraction when the selected method is unavailable. (default to true).
long? maxBytes

Maximum bytes to read from attachment for native text extraction. (default to 1048576).

Properties

View Source

AllowFallback

Allow fallback to native extraction when the selected method is unavailable.

Declaration
[DataMember(Name = "allowFallback", EmitDefaultValue = true)]
public bool AllowFallback { get; set; }
Property Value
Type Description
bool

Allow fallback to native extraction when the selected method is unavailable.
View Source

MaxBytes

Maximum bytes to read from attachment for native text extraction.

Declaration
[DataMember(Name = "maxBytes", EmitDefaultValue = true)]
public long? MaxBytes { get; set; }
Property Value
Type Description
long?

Maximum bytes to read from attachment for native text extraction.
View Source

Method

Method for extracting text from attachments. OCR/LLM methods are reserved for advanced extraction.

Declaration
[DataMember(Name = "method", EmitDefaultValue = true)]
public ExtractAttachmentTextOptions.MethodEnum? Method { get; set; }
Property Value
Type Description
ExtractAttachmentTextOptions.MethodEnum?

Method for extracting text from attachments. OCR/LLM methods are reserved for advanced extraction.

Methods

View Source

ToJson()

Returns the JSON string presentation of the object

Declaration
public virtual string ToJson()
Returns
Type Description
string

JSON string presentation of the object
View Source

ToString()

Returns the string presentation of the object

Declaration
public override string ToString()
Returns
Type Description
string

String presentation of the object
Overrides

Implements