gdドキュメント0.8.0

APIリファレンス

GD.mail.mime

MIMEメディアタイプ、encoded-word、quoted-printable、multipartの読書きを扱います。

メソッド

parse_media_type

parse_media_type(text: String) -> Dictionary, Err
英語原文

Parse a MIME media type and its parameters.

引数

名前型省略時の値説明
textString省略不可調査・デコード・変換する文字列。入力自体は書き換えません。

戻り値

Dictionary, Err

エラー

処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。

format_media_type

format_media_type(type: String, params: Dictionary) -> String, Err
英語原文

Format a MIME media type after checking parameter syntax.

引数

名前型省略時の値説明
typeString省略不可レスポンス本文のメディア型。
paramsDictionary省略不可事前に解析したSQL文のプレースホルダーに渡す値。

戻り値

String, Err

エラー

処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。

encode_word

encode_word(text: String, mode: String = "b") -> String, Err
英語原文

Encode one unstructured header word.

引数

名前型省略時の値説明
textString省略不可調査・デコード・変換する文字列。入力自体は書き換えません。
modeString"b"ファイルのアクセスモード。read・write・append・read_write。

戻り値

String, Err

エラー

処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。

decode_word

decode_word(text: String) -> String, Err
英語原文

Decode one encoded header word.

引数

名前型省略時の値説明
textString省略不可調査・デコード・変換する文字列。入力自体は書き換えません。

戻り値

String, Err

エラー

処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。

decode_header

decode_header(text: String) -> String, Err
英語原文

Decode an unstructured header containing adjacent encoded words.

引数

名前型省略時の値説明
textString省略不可調査・デコード・変換する文字列。入力自体は書き換えません。

戻り値

String, Err

エラー

処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。

quoted_printable_encode

quoted_printable_encode(data: PackedByteArray) -> PackedByteArray, Err
英語原文

Encode body bytes with quoted-printable transfer syntax.

引数

名前型省略時の値説明
dataPackedByteArray省略不可処理するデータ。上に示した引数の型に合わせて渡します。

戻り値

PackedByteArray, Err

エラー

処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。

quoted_printable_decode

quoted_printable_decode(data: PackedByteArray) -> PackedByteArray, Err
英語原文

Decode quoted-printable body bytes.

引数

名前型省略時の値説明
dataPackedByteArray省略不可処理するデータ。上に示した引数の型に合わせて渡します。

戻り値

PackedByteArray, Err

エラー

処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。

quoted_printable_reader

quoted_printable_reader(source: Variant) -> Variant, Err
英語原文

Read quoted-printable escapes from a stream only as the caller requests bytes.

引数

名前型省略時の値説明
sourceVariant省略不可read_async(max_bytes) を備えたバイト入力元。

戻り値

Variant, Err

エラー

処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。

quoted_printable_writer

quoted_printable_writer(sink: Variant) -> Variant, Err
英語原文

Write quoted-printable bytes through an asynchronous sink.

引数

名前型省略時の値説明
sinkVariant省略不可write_async(data) を備えたバイト出力先。

戻り値

Variant, Err

エラー

処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。

multipart_reader

multipart_reader(data: PackedByteArray, boundary: String) -> Variant, Err
英語原文

Traverse MIME parts from a boundary-delimited byte sequence.

引数

名前型省略時の値説明
dataPackedByteArray省略不可処理するデータ。上に示した引数の型に合わせて渡します。
boundaryString省略不可マルチパートの本文を区切るMIME境界文字列。

戻り値

Variant, Err

エラー

処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。

multipart_writer

multipart_writer(boundary: String = "") -> Variant, Err
英語原文

Build a multipart body with an optional caller-selected boundary.

引数

名前型省略時の値説明
boundaryString""マルチパートの本文を区切るMIME境界文字列。

戻り値

Variant, Err

エラー

処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。

multipart_reader_stream

multipart_reader_stream(source: Variant, boundary: String) -> Variant, Err
英語原文

Traverse MIME parts without holding the complete source body.

引数

名前型省略時の値説明
sourceVariant省略不可read_async(max_bytes) を備えたバイト入力元。
boundaryString省略不可マルチパートの本文を区切るMIME境界文字列。

戻り値

Variant, Err

エラー

処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。

multipart_writer_to

multipart_writer_to(sink: Variant, boundary: String = "") -> Variant, Err
英語原文

Write MIME parts directly to an asynchronous byte sink.

引数

名前型省略時の値説明
sinkVariant省略不可write_async(data) を備えたバイト出力先。
boundaryString""マルチパートの本文を区切るMIME境界文字列。

戻り値

Variant, Err

エラー

処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。