Spec-Zone.ru › Ruby 2.5

класс Net::POPMail

Родитель:
Объект

Этот класс представляет сообщение, которое существует на сервере POP. Экземпляры этого класса создаются классом POP3; их не следует создавать пользователю напрямую.

Атрибуты

length[R]

Длина сообщения в октетах.

number[R]

Последовательный номер сообщения на сервере.

size[R]

Длина сообщения в октетах.

Открытые методы экземпляров

all( dest = +'' )
Псевдоним для: pop
delete() Показать исходный код
# File lib/net/pop.rb, line 857
def delete
  @command.dele @number
  @deleted = true
end

Помечает сообщение для удаления на сервере. Удаление фактически не происходит до конца сеанса; удаление можно отменить для всех помеченных сообщений, вызвав Net::POP3#reset.

Этот метод вызывает исключение POPError, если произошла ошибка.

Пример

POP3.start('pop.example.com', 110,
           'YourAccount', 'YourPassword') do |pop|
  n = 1
  pop.mails.each do |popmail|
    File.open("inbox/#{n}", 'w') do |f|
      f.write popmail.pop
    end
    popmail.delete         ####
    n += 1
  end
end
Также алиас: delete!
delete!()
Псевдоним для: delete
deleted?() Показать исходный код
# File lib/net/pop.rb, line 865
def deleted?
  @deleted
end

Истина, если почта была удалена.

header(dest = +'') Показать исходный код
# File lib/net/pop.rb, line 833
def header(dest = +'')
  top(0, dest)
end

Извлекает заголовок сообщения.

Необязательный dest аргумент устарел.

Этот метод вызывает исключение POPError, если произошла ошибка.

inspect() Показать исходный код
# File lib/net/pop.rb, line 759
def inspect
  +"#<#{self.class} #{@number}#{@deleted ? ' deleted' : ''}>"
end

Предоставляет удобочитаемое строковое представление состояния класса.

mail( dest = +'' )
Псевдоним для: pop
pop( dest = +'' ) { |message_chunk| ... } Показать исходный код
# File lib/net/pop.rb, line 801
def pop( dest = +'', &block ) # :yield: message_chunk
  if block_given?
    @command.retr(@number, &block)
    nil
  else
    @command.retr(@number) do |chunk|
      dest << chunk
    end
    dest
  end
end

Этот метод извлекает сообщение. Если вызван с блоком, сообщение передается в блок по частям. Если вызван без блока, сообщение возвращается в виде строки. Необязательный dest аргумент будет добавлен к возвращаемой строке; этот аргумент по существу устарел.

Пример без блока

POP3.start('pop.example.com', 110,
           'YourAccount', 'YourPassword') do |pop|
  n = 1
  pop.mails.each do |popmail|
    File.open("inbox/#{n}", 'w') do |f|
      f.write popmail.pop
    end
    popmail.delete
    n += 1
  end
end

Пример с блоком

POP3.start('pop.example.com', 110,
           'YourAccount', 'YourPassword') do |pop|
  n = 1
  pop.mails.each do |popmail|
    File.open("inbox/#{n}", 'w') do |f|
      popmail.pop do |chunk|            ####
        f.write chunk
      end
    end
    n += 1
  end
end

Этот метод вызывает исключение POPError, если произошла ошибка.

Также алиасы: all, mail
top(lines, dest = +'') Показать исходный код
# File lib/net/pop.rb, line 821
def top(lines, dest = +'')
  @command.top(@number, lines) do |chunk|
    dest << chunk
  end
  dest
end

Извлекает заголовок сообщения и lines строк тела.

Необязательный dest аргумент устарел.

Этот метод вызывает исключение POPError, если произошла ошибка.

uidl()
Псевдоним для: unique_id
unique_id() Показать исходный код
# File lib/net/pop.rb, line 873
def unique_id
  return @uid if @uid
  @pop.set_all_uids
  @uid
end

Возвращает уникальный идентификатор сообщения. Обычно уникальный идентификатор — это строка-хеш сообщения.

Этот метод вызывает исключение POPError, если произошла ошибка.

Также алиас: uidl

Ruby Core © 1993–2017 Yukihiro Matsumoto
Licensed under the Ruby License.
Ruby Standard Library © contributors
Licensed under their own licenses.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API