APIリファレンス
GDSMTPClient
SMTP接続を再利用し、挨拶、認証、宛先指定、DATA送信、接続終了を順に行います。
メソッド
hello(name: String = "localhost") -> Dictionary, Errhello_async(name: String = "localhost") -> await Dictionary, Errstart_tls(opts: Dictionary = { }) -> Dictionary, Errstart_tls_async(opts: Dictionary = { }) -> await Dictionary, Errauth(config: Dictionary) -> Dictionary, Errauth_async(config: Dictionary) -> await Dictionary, Errmail(from: String) -> Dictionary, Errmail_async(from: String) -> await Dictionary, Errrcpt(to: String) -> Dictionary, Errrcpt_async(to: String) -> await Dictionary, Errdata() -> GDSMTPDataWriter, Errdata_async() -> await GDSMTPDataWriter, Errreset() -> Dictionary, Errreset_async() -> await Dictionary, Errnoop() -> Dictionary, Errnoop_async() -> await Dictionary, Errverify(address: String) -> Dictionary, Errverify_async(address: String) -> await Dictionary, Errquit() -> Dictionary, Errquit_async() -> await Dictionary, Errclose() -> voidextension(name: String) -> Dictionarytls_state() -> Dictionary
hello
hello(name: String = "localhost") -> Dictionary, Err英語原文Introduce the session with EHLO or HELO.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
name | String | "localhost" | 対象を登録・参照するための名前。 |
戻り値
Dictionary, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
hello_async
hello_async(name: String = "localhost") -> await Dictionary, Err英語原文Introduce the session with EHLO or HELO.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
name | String | "localhost" | 対象を登録・参照するための名前。 |
戻り値
await Dictionary, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
start_tls
start_tls(opts: Dictionary = { }) -> Dictionary, Err英語原文Upgrade the existing SMTP connection to verified TLS.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
opts | Dictionary | { } | 処理の設定を名前と値で指定する辞書。省略した項目には、この関数の既定値が使われます。 |
戻り値
Dictionary, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
start_tls_async
start_tls_async(opts: Dictionary = { }) -> await Dictionary, Err英語原文Upgrade the existing SMTP connection to verified TLS.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
opts | Dictionary | { } | 処理の設定を名前と値で指定する辞書。省略した項目には、この関数の既定値が使われます。 |
戻り値
await Dictionary, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
auth
auth(config: Dictionary) -> Dictionary, Err英語原文Authenticate after transport policy is checked.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
config | Dictionary | 省略不可 | kind、user、secret、および省略可能なidentityを含む認証設定。 |
戻り値
Dictionary, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
auth_async
auth_async(config: Dictionary) -> await Dictionary, Err英語原文Authenticate after transport policy is checked.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
config | Dictionary | 省略不可 | kind、user、secret、および省略可能なidentityを含む認証設定。 |
戻り値
await Dictionary, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
mail(from: String) -> Dictionary, Err英語原文Start one SMTP envelope.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
from | String | 省略不可 | 操作の開始点。 |
戻り値
Dictionary, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
mail_async
mail_async(from: String) -> await Dictionary, Err英語原文Start one SMTP envelope.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
from | String | 省略不可 | 操作の開始点。 |
戻り値
await Dictionary, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
rcpt
rcpt(to: String) -> Dictionary, Err英語原文Add one recipient to the envelope.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
to | String | 省略不可 | 操作の対象となる宛先。 |
戻り値
Dictionary, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
rcpt_async
rcpt_async(to: String) -> await Dictionary, Err英語原文Add one recipient to the envelope.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
to | String | 省略不可 | 操作の対象となる宛先。 |
戻り値
await Dictionary, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
data
data() -> GDSMTPDataWriter, Err英語原文Enter DATA mode and return a typed writer.
引数
引数はありません。
戻り値
GDSMTPDataWriter, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
data_async
data_async() -> await GDSMTPDataWriter, Err英語原文Enter DATA mode and return a typed writer.
引数
引数はありません。
戻り値
await GDSMTPDataWriter, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
reset
reset() -> Dictionary, Err英語原文Reset the active envelope.
引数
引数はありません。
戻り値
Dictionary, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
reset_async
reset_async() -> await Dictionary, Err英語原文Reset the active envelope.
引数
引数はありません。
戻り値
await Dictionary, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
noop
noop() -> Dictionary, Err英語原文Check whether the SMTP peer responds.
引数
引数はありません。
戻り値
Dictionary, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
noop_async
noop_async() -> await Dictionary, Err英語原文Check whether the SMTP peer responds.
引数
引数はありません。
戻り値
await Dictionary, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
verify
verify(address: String) -> Dictionary, Err英語原文Ask the peer about one address.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
address | String | 省略不可 | SMTPのVRFYコマンドに渡すメールボックスのアドレス。 |
戻り値
Dictionary, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
verify_async
verify_async(address: String) -> await Dictionary, Err英語原文Ask the peer about one address.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
address | String | 省略不可 | SMTPのVRFYコマンドに渡すメールボックスのアドレス。 |
戻り値
await Dictionary, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
quit
quit() -> Dictionary, Err英語原文End the SMTP session and close its transport.
引数
引数はありません。
戻り値
Dictionary, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
quit_async
quit_async() -> await Dictionary, Err英語原文End the SMTP session and close its transport.
引数
引数はありません。
戻り値
await Dictionary, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
close
close() -> void英語原文Release the SMTP transport immediately.
引数
引数はありません。
戻り値
void
値を返しません。
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
extension
extension(name: String) -> Dictionary英語原文Read one advertised SMTP extension.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
name | String | 省略不可 | 対象を登録・参照するための名前。 |
戻り値
Dictionary
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
tls_state
tls_state() -> Dictionary英語原文Read the connection's TLS negotiation state.
引数
引数はありません。
戻り値
Dictionary
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。