APIリファレンス
GD.mail
メールアドレス、日付、ヘッダーを解析し、SMTPサーバーへメールを送ります。STARTTLSは既存接続を暗号化し、失敗時は平文へ戻りません。MIMEの機能はGD.mail.mimeにあります。
プロパティ
mime: GD.mail.mimeMIMEメディアタイプ、encoded-word、quoted-printable、multipartの読書きを扱います。
メソッド
parse_address(text: String) -> Dictionary, Errparse_address_list(text: String) -> Array, Errparse_date(text: String) -> Dictionary, Errread_message(data: PackedByteArray) -> GDMailMessage, Errread_message_async(source: Variant) -> await GDMailMessage, Errplain_auth(user: String, password: String, identity: String = "") -> Dictionarycram_md5_auth(user: String, secret: String) -> Dictionarycram_md5(key: PackedByteArray, challenge: PackedByteArray) -> String, Errdial_smtp(host: String, port: int, opts: Dictionary = { }) -> GDSMTPClient, Errdial_smtp_async(host: String, port: int, opts: Dictionary = { }) -> await GDSMTPClient, Errsend_mail(host: String, port: int, from: String, to: PackedStringArray, message: PackedByteArray, opts: Dictionary = { }) -> Variant, Errsend_mail_async(host: String, port: int, from: String, to: PackedStringArray, message: PackedByteArray, opts: Dictionary = { }) -> await Variant, Err
parse_address
parse_address(text: String) -> Dictionary, Err英語原文Parse one display name and mailbox.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
text | String | 省略不可 | 調査・デコード・変換する文字列。入力自体は書き換えません。 |
戻り値
Dictionary, Err
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
parse_address_list
parse_address_list(text: String) -> Array, Err英語原文Parse comma-separated mailboxes without discarding display names.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
text | String | 省略不可 | 調査・デコード・変換する文字列。入力自体は書き換えません。 |
戻り値
Array, Err
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
parse_date
parse_date(text: String) -> Dictionary, Err英語原文Parse a mail date while retaining its numeric timezone offset.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
text | String | 省略不可 | 調査・デコード・変換する文字列。入力自体は書き換えません。 |
戻り値
Dictionary, Err
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
read_message
read_message(data: PackedByteArray) -> GDMailMessage, Err英語原文Split a mail message into repeated headers and its untouched body bytes.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
data | PackedByteArray | 省略不可 | 処理するデータ。上に示した引数の型に合わせて渡します。 |
戻り値
GDMailMessage, Err
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
read_message_async
read_message_async(source: Variant) -> await GDMailMessage, Err英語原文Parse headers from bytes or a readable stream without collecting the whole body.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
source | Variant | 省略不可 | read_async(max_bytes) を備えたメッセージのバイト入力元。 |
戻り値
await GDMailMessage, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
plain_auth
plain_auth(user: String, password: String, identity: String = "") -> Dictionary英語原文Package PLAIN credentials for a verified SMTP session.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
user | String | 省略不可 | SMTP認証のユーザー名。 |
password | String | 省略不可 | 鍵導出の入力にするパスワードのバイト列。 |
identity | String | "" | PLAIN認証に使う省略可能な認可ID。 |
戻り値
Dictionary
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
cram_md5_auth
cram_md5_auth(user: String, secret: String) -> Dictionary英語原文Package CRAM-MD5 credentials for a verified SMTP session.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
user | String | 省略不可 | SMTP認証のユーザー名。 |
secret | String | 省略不可 | 鍵を生成するための元の秘密データ。 |
戻り値
Dictionary
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
cram_md5
cram_md5(key: PackedByteArray, challenge: PackedByteArray) -> String, Err英語原文Compute the HMAC-MD5 response required by the CRAM-MD5 SMTP mechanism.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
key | PackedByteArray | 省略不可 | 対象値の選択・保存・認証に使うキー。 |
challenge | PackedByteArray | 省略不可 | CRAM-MD5で使う、デコード済みサーバーチャレンジのバイト列。 |
戻り値
String, Err
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
dial_smtp
dial_smtp(host: String, port: int, opts: Dictionary = { }) -> GDSMTPClient, Err英語原文Open a reusable SMTP session without blocking the caller.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
host | String | 省略不可 | 接続または待ち受けに使うホスト名・IPアドレス。 |
port | int | 省略不可 | ネットワークのポート番号。待ち受け時の0はOSがポートを選びます。 |
opts | Dictionary | { } | 処理の設定を名前と値で指定する辞書。省略した項目には、この関数の既定値が使われます。 |
戻り値
GDSMTPClient, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
dial_smtp_async
dial_smtp_async(host: String, port: int, opts: Dictionary = { }) -> await GDSMTPClient, Err英語原文Open a reusable SMTP session without blocking the caller.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
host | String | 省略不可 | 接続または待ち受けに使うホスト名・IPアドレス。 |
port | int | 省略不可 | ネットワークのポート番号。待ち受け時の0はOSがポートを選びます。 |
opts | Dictionary | { } | 処理の設定を名前と値で指定する辞書。省略した項目には、この関数の既定値が使われます。 |
戻り値
await GDSMTPClient, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
send_mail
send_mail(host: String, port: int, from: String, to: PackedStringArray, message: PackedByteArray, opts: Dictionary = { }) -> Variant, Err英語原文Send one complete message through a reusable SMTP session.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
host | String | 省略不可 | 接続または待ち受けに使うホスト名・IPアドレス。 |
port | int | 省略不可 | ネットワークのポート番号。待ち受け時の0はOSがポートを選びます。 |
from | String | 省略不可 | 操作の開始点。 |
to | PackedStringArray | 省略不可 | 操作の対象となる宛先。 |
message | PackedByteArray | 省略不可 | SMTP DATAトランザクションで送るメッセージ全体のバイト列。 |
opts | Dictionary | { } | 処理の設定を名前と値で指定する辞書。省略した項目には、この関数の既定値が使われます。 |
戻り値
Variant, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
send_mail_async
send_mail_async(host: String, port: int, from: String, to: PackedStringArray, message: PackedByteArray, opts: Dictionary = { }) -> await Variant, Err英語原文Send one complete message through a reusable SMTP session.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
host | String | 省略不可 | 接続または待ち受けに使うホスト名・IPアドレス。 |
port | int | 省略不可 | ネットワークのポート番号。待ち受け時の0はOSがポートを選びます。 |
from | String | 省略不可 | 操作の開始点。 |
to | PackedStringArray | 省略不可 | 操作の対象となる宛先。 |
message | PackedByteArray | 省略不可 | SMTP DATAトランザクションで送るメッセージ全体のバイト列。 |
opts | Dictionary | { } | 処理の設定を名前と値で指定する辞書。省略した項目には、この関数の既定値が使われます。 |
戻り値
await Variant, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。