Current File : //opt/cpanel/ea-ruby24/root/usr/share/ri/system/Net/SMTP/start-i.ri
U:RDoc::AnyMethod[iI"
start:EFI"Net::SMTP#start;TF: publico:RDoc::Markup::Document: @parts[ o: RDoc::Markup::Paragraph; [I"8Opens a TCP connection and starts the SMTP session.;To: RDoc::Markup::BlankLine S:RDoc::Markup::Heading:
leveli: textI"Parameters;T@o;
; [I"H+helo+ is the _HELO_ _domain_ that you'll dispatch mails from; see ;TI"*the discussion in the overview notes.;T@o;
; [
I"CIf both of +user+ and +secret+ are given, SMTP authentication ;TI"Ewill be attempted using the AUTH command. +authtype+ specifies ;TI">the type of authentication to attempt; it must be one of ;TI"J:login, :plain, and :cram_md5. See the notes on SMTP Authentication ;TI"in the overview.;T@S; ;
i;I"Block Usage;T@o;
; [ I"FWhen this methods is called with a block, the newly-started SMTP ;TI"Dobject is yielded to the block, and automatically closed after ;TI"=the block call finishes. Otherwise, it is the caller's ;TI"7responsibility to close the session when finished.;T@S; ;
i;I" Example;T@o;
; [I"9This is very similar to the class method SMTP.start.;T@o:RDoc::Markup::Verbatim; [
I"require 'net/smtp'
;TI"2smtp = Net::SMTP.new('smtp.mail.server', 25)
;TI"Dsmtp.start(helo_domain, account, password, authtype) do |smtp|
;TI"J smtp.send_message msgstr, 'from@example.com', ['dest@example.com']
;TI" end
;T: @format0o;
; [ I"?The primary use of this method (as opposed to SMTP.start) ;TI"?is probably to set debugging (#set_debug_output) or ESMTP ;TI"9(#esmtp=), which must be done before the session is ;TI"
started.;T@S; ;
i;I" Errors;T@o;
; [I"DIf session has already been started, an IOError will be raised.;T@o;
; [I"This method may raise:;T@o:RDoc::Markup::List:
@type: BULLET: @items[
o:RDoc::Markup::ListItem: @label0; [o;
; [I"!Net::SMTPAuthenticationError;To;;0; [o;
; [I"Net::SMTPServerBusy;To;;0; [o;
; [I"Net::SMTPSyntaxError;To;;0; [o;
; [I"Net::SMTPFatalError;To;;0; [o;
; [I"Net::SMTPUnknownError;To;;0; [o;
; [I"Net::OpenTimeout;To;;0; [o;
; [I"Net::ReadTimeout;To;;0; [o;
; [I" IOError;T:
@fileI"lib/net/smtp.rb;T:0@omit_headings_from_table_of_contents_below00I" smtp;F[ I"C(helo = 'localhost', user = nil, secret = nil, authtype = nil);T@hFI" SMTP;TcRDoc::NormalClass00
Mini Shell