class Net::SMTP (Ruby 3.3 リファレンスマニュアル)

aliases: Net::SMTPSession

要約

SMTP のセッションを表現したクラスです。

特異メソッド

default_port -> Integer[permalink][rdoc][edit]

SMTPのデフォルトのポート番号(25)を返します。

default_ssl_context -> OpenSSL::SSL::SSLContext[permalink][rdoc][edit]

SSL 通信に使われる SSL のコンテキストのデフォルト値を返します。

default_tls_port -> Integer[permalink][rdoc][edit]

default_ssl_port -> Integer

デフォルトのSMTPSのポート番号(465)を返します。

default_submission_port -> Integer[permalink][rdoc][edit]

デフォルトのサブミッションポート番号(587)を返します。

new(address, port = Net::SMTP.default_port) -> Net::SMTP[permalink][rdoc][edit]

新しい SMTP オブジェクトを生成します。 address はSMTPサーバーのFQDNで、 port は接続するポート番号です。ただし、このメソッドではまだTCPの接続はしません。 Net::SMTP#start で接続します。

オブジェクトの生成と接続を同時にしたい場合には Net::SMTP.start を代わりに使ってください。

[PARAM] address:: 接続先のSMTPサーバの文字列
[PARAM] port:: 接続ポート番号

[SEE_ALSO] Net::SMTP.start, Net::SMTP#start

start(address, port = Net::SMTP.default_port, tls_verify: true, tls_hostname: nil, helo: 'localhost', user: nil, password: nil, authtype: DEFAULT_AUTH_TYPE) -> Net::SMTP[permalink][rdoc][edit]

start(address, port = Net::SMTP.default_port, tls_verify: true, tls_hostname: nil, helo: 'localhost', user: nil, password: nil, authtype: DEFAULT_AUTH_TYPE) {|smtp| ... } -> object

start(address, port = Net::SMTP.default_port, helo = 'localhost', user = nil, password = nil, authtype = DEFAULT_AUTH_TYPE) -> Net::SMTP

start(address, port = Net::SMTP.default_port, helo = 'localhost', user = nil, password = nil, authtype = DEFAULT_AUTH_TYPE) {|smtp| .... } -> object

新しい SMTP オブジェクトを生成し、サーバに接続し、セッションを開始します。

以下と同じです。

require 'net/smtp'
Net::SMTP.new(address, port).start(helo: helo, user: user, password: password, authtype: authtype)

このメソッドにブロックを与えた場合には、新しく作られた Net::SMTP オブジェクトを引数としてそのブロックを呼び、ブロック終了時に自動的に接続を閉じます。ブロックを与えなかった場合には新しく作られた Net::SMTP オブジェクトが返されます。この場合終了時に Net::SMTP#finish を呼ぶのは利用者の責任となります。

user と password の両方が与えられた場合、 SMTP AUTH コマンドによって認証を行います。 authtype は使用する認証のタイプで、シンボルで :plain, :login, :cram_md5 を指定します。

Example:

require 'net/smtp'

Net::SMTP.start('smtp.example.com') {|smtp|
  smtp.send_message mail_string, 'from@example.jp', 'to@example.jp'
}

[PARAM] address:: 接続するサーバをホスト名もしくはIPアドレスで指定します
[PARAM] port:: ポート番号、デフォルトは 25 です
[PARAM] tls_verify:: サーバー証明書を検証するか否か
[PARAM] tls_hostname:: サーバー証明書のホスト名
[PARAM] helo:: HELO で名乗るドメイン名です
[PARAM] user:: 認証で使うアカウント名
[PARAM] password:: 認証で使うパスワード
[PARAM] authtype:: 認証の種類(:plain, :login, :cram_md5 のいずれか)
[EXCEPTION] TimeoutError:: 接続時にタイムアウトした場合に発生します
[EXCEPTION] Net::SMTPUnsupportedCommand:: TLSをサポートしていないサーバでTLSを使おうとした場合に発生します
[EXCEPTION] Net::SMTPServerBusy:: SMTPエラーコード420,450の場合に発生します
[EXCEPTION] Net::SMTPSyntaxError:: SMTPエラーコード500の場合に発生します
[EXCEPTION] Net::SMTPFatalError:: SMTPエラーコード5xxの場合に発生します

[SEE_ALSO] Net::SMTP#start, Net::SMTP.new

インスタンスメソッド

address -> String[permalink][rdoc][edit]

接続先のアドレスを返します。

auth_cram_md5(user, secret) -> ()[permalink][rdoc][edit]

CRAM-MD5 認証を行います。

このメソッドはセッション開始(Net::SMTP#start)後、メールを送る前に呼びだしてください。

通常は Net::SMTP.start や Net::SMTP#start で認証を行うためこれを利用する必要はないはずです。

[PARAM] user:: 認証で使うアカウント名
[PARAM] secret:: 認証で使うパスワード

auth_login(user, secret) -> ()[permalink][rdoc][edit]

このメソッドはセッション開始(Net::SMTP#start)後、メールを送る前に呼びだしてください。

通常は Net::SMTP.start や Net::SMTP#start で認証を行うためこれを利用する必要はないはずです。

[PARAM] user:: 認証で使うアカウント名
[PARAM] secret:: 認証で使うパスワード

auth_plain(user, secret) -> ()[permalink][rdoc][edit]

PLAIN 認証を行います。

このメソッドはセッション開始(Net::SMTP#start)後、メールを送る前に呼びだしてください。

通常は Net::SMTP.start や Net::SMTP#start で認証を行うためこれを利用する必要はないはずです。

[PARAM] user:: 認証で使うアカウント名
[PARAM] secret:: 認証で使うパスワード

authenticate(user, secret, authtype) -> ()[permalink][rdoc][edit]

認証を行います。

このメソッドはセッション開始(Net::SMTP#start)後、メールを送る前に呼びだしてください。

通常は Net::SMTP.start や Net::SMTP#start で認証を行うためこれを利用する必要はないはずです。

[PARAM] user:: 認証で使うアカウント名
[PARAM] secret:: 認証で使うパスワード
[PARAM] authtype:: 認証の種類(:plain, :login, :cram_md5 のいずれか)

[SEE_ALSO] Net::SMTP.start, Net::SMTP#start, Net::SMTP#auth_plain, Net::SMTP#auth_login, Net::SMTP#auth_cram_md5

capable_auth_types -> [String][permalink][rdoc][edit]

接続したサーバで利用可能な認証を配列で返します。

返り値の配列の要素は、 'PLAIN', 'LOGIN', 'CRAM-MD5' です。