ライブラリ
-
net
/ imap (20)
キーワード
- authenticate (1)
- expunge (1)
- getquota (1)
- getquotaroot (1)
- greeting (1)
- login (1)
- logout (1)
- lsub (1)
- setacl (1)
- setquota (1)
- status (1)
- subscribe (1)
-
uid
_ copy (1) -
uid
_ fetch (1) -
uid
_ move (1) -
uid
_ search (1) -
uid
_ sort (1) -
uid
_ store (1) -
uid
_ thread (1) - unsubscribe (1)
検索結果
先頭5件
- Net
:: IMAP # getquotaroot(mailbox) -> [Net :: IMAP :: MailboxQuotaRoot | Net :: IMAP :: MailboxQuota] - Net
:: IMAP # authenticate(auth _ type , user , password) -> Net :: IMAP :: TaggedResponse - Net
:: IMAP # getquota(mailbox) -> [Net :: IMAP :: MailboxQuota] - Net
:: IMAP # setquota(mailbox , quota) -> Net :: IMAP :: TaggedResponse - Net
:: IMAP # expunge -> [Integer] | nil
-
Net
:: IMAP # getquotaroot(mailbox) -> [Net :: IMAP :: MailboxQuotaRoot | Net :: IMAP :: MailboxQuota] (18907.0) -
GETQUOTAROOT コマンドを送って 指定したメールボックスの quota root の一覧と、 関連する quota の情報を返します。
...報を返します。
quota root の情報は Net::IMAP::MailboxQuotaRoot のオブジェクトで、
返り値の配列の中に唯一含まれています。
quota の情報はメールボックスに関連付けられた quota root ごとに
Net::IMAP::MailboxQuota オブジェクトで得られ......は 2087 を見てください。
このコマンドは Net::IMAP#capability の返り値を見ることで
利用可能かどうか判断できます。
@param mailbox quota root を得たいメールボックス名(文字列)
@raise Net::IMAP::NoResponseError 指定したメールボックスが... -
Net
:: IMAP # authenticate(auth _ type , user , password) -> Net :: IMAP :: TaggedResponse (18607.0) -
AUTHENTICATE コマンドを送り、クライアントを認証します。
...ticate('LOGIN', user, password)
auth_type としては以下がサポートされています。
* "LOGIN"
* "PLAIN"
* "CRAM-MD5"
* "DIGEST-MD5"
@param auth_type 認証方式を表す文字列
@param user ユーザ名文字列
@param password パスワード文字列
@see Net::IMAP#login... -
Net
:: IMAP # getquota(mailbox) -> [Net :: IMAP :: MailboxQuota] (18607.0) -
GETQUOTA コマンドを送って 指定したメールボックスの quota の情報を返します。
...ールボックスの quota の情報を返します。
quota の情報は Net::IMAP::MailboxQuota オブジェクトの配列で
得られます。
詳しくは 2087 を見てください。
このコマンドは Net::IMAP#capability の返り値を見ることで
利用可能かどうか判断......できます。
@param mailbox quota 情報を得たいメールボックス名
@raise Net::IMAP::NoResponseError 指定したメールボックスが quota root でない場合に発生します... -
Net
:: IMAP # setquota(mailbox , quota) -> Net :: IMAP :: TaggedResponse (18607.0) -
SETQUOTA コマンドを送り、指定したメールボックスに quota を設定します。
...のコマンドは Net::IMAP#capability の返り値を見ることで
利用可能かどうか判断できます。
@param mailbox quota を設定するメールボックス名(文字列)
@param quota quotaの値(ストレージのサイズ、もしくは nil)
@raise Net::IMAP::NoResponseError 指... -
Net
:: IMAP # expunge -> [Integer] | nil (18307.0) -
EXPUNGEコマンドを送り、:Deletedフラグをセットしたメッセージを すべて処理中のメールボックスから削除します。
...ラグをセットしたメッセージを
すべて処理中のメールボックスから削除します。
削除したメッセージの message sequence number を配列で返します。
@raise Net::IMAP::NoResponseError メールボックスが read-only である場合に発生します... -
Net
:: IMAP # logout -> Net :: IMAP :: TaggedResponse (18307.0) -
LOGOUT コマンドを送り、コネクションを切断することを サーバに伝えます。
LOGOUT コマンドを送り、コネクションを切断することを
サーバに伝えます。 -
Net
:: IMAP # lsub(refname , mailbox) -> [Net :: IMAP :: MailboxList] (18307.0) -
LIST コマンドを送り、active/subscribed なメールボックス名の集合から 引数にマッチするものすべてを返します。
...集合から
引数にマッチするものすべてを返します。
詳しくは 2060 の 6.3.8 を参照してください。
返り値は Net::IMAP::MailboxList の配列で返します。
返り値が空集合である場合は空の配列でなく nil を返します。
@param refname 参... -
Net
:: IMAP # status(mailbox , attr) -> {String => Integer} (18307.0) -
STATUS コマンドを送り、mailbox のステータスを得ます。
...m mailbox 問い合わせ対象のメールボックス(文字列)
@param attr 問合せたいアトリビュート名(文字列)の配列
@raise Net::IMAP::NoResponseError メールボックスが存在しない場合や、
アトリビュート名が存在しない場合に発生します... -
Net
:: IMAP # subscribe(mailbox) -> Net :: IMAP :: TaggedResponse (18307.0) -
SUBSCRIBE コマンドを送り、指定したメールボックスを "active" もしくは "subscribe" なメールボックスの集合に 追加します。
..."subscribe" なメールボックスの集合に
追加します。
@param mailbox 追加するメールボックスの名前(文字列)
@raise Net::IMAP::NoResponseError 指定した名前のメールボックスを
追加できなかった場合に発生します。
指定した名... -
Net
:: IMAP # uid _ copy(set , mailbox) -> Net :: IMAP :: TaggedResponse (18307.0) -
UID COPY コマンドを送り、指定したメッセージを 指定したメールボックスの末尾に追加します。
...ルボックスは
Net::IMAP#examine もしくは Net::IMAP#select で
指定したものを用います。
mailbox はコピー先のメールボックスです。
@param set コピーするメッセージの UID
@param mailbox コピー先のメールボックス(文字列)
@see Net::IMAP#copy... -
Net
:: IMAP # uid _ fetch(set , attr) -> [Net :: IMAP :: FetchData] (18307.0) -
UID FETCH コマンドを送り、メールボックス内のメッセージに 関するデータを取得します。
...UID FETCH コマンドを送り、メールボックス内のメッセージに
関するデータを取得します。
Net::IMAP#examine もしくは Net::IMAP#select で
指定したメールボックスを対象とします。
set で対象とするメッセージを指定します。
これ......るアトリビュートを文字列の配列で渡してください。
指定可能なアトリビュートについては Net::IMAP::FetchData#attr
を見てください。
@param set 処理対象のメッセージの UID
@param attr アトリビュート(文字列配列)
@see Net::IMAP#fetch... -
Net
:: IMAP # uid _ move(set , mailbox) -> Net :: IMAP :: TaggedResponse (18307.0) -
MOVEコマンドを送り、set でUIDで指定したメッセージを mailbox の 末尾に移動させます。
...ー元のメールボックスは
Net::IMAP#examine もしくは Net::IMAP#select で
指定したものを用います。
@param set 移動するメッセージのUID(整数、整数の配列、整数の Range)
@param mailbox 移動先のメールボックス(文字列)
@see Net::IMAP#move, 6851... -
Net
:: IMAP # uid _ search(keys , charset = nil) -> [Integer] (18307.0) -
UID SEARCH コマンドを送り、条件に合うメッセージの UID を配列で返します。
...UID SEARCH コマンドを送り、条件に合うメッセージの UID
を配列で返します。
Net::IMAP#examine もしくは Net::IMAP#select で
指定したメールボックスを検索対象とします。
検索の条件は key に文字列の1次元配列もしくは文字列で渡......llo"])
#=> [1, 6, 7, 8]
p imap.uid_search(["SUBJECT", "hello", "FROM", "foo@example.com"])
#=> [6, 7]
p imap.uid_search('SUBJECT "hello"')
#=> [1, 6, 7, 8]
@param key 検索キー(文字列の配列もしくは文字列)
@param charset 検索に用いるcharset
@see Net::IMAP#uid_search... -
Net
:: IMAP # uid _ store(set , attr , flags) -> [Net :: IMAP :: FetchData] | nil (18307.0) -
UID STORE コマンドを送り、メールボックス内のメッセージを 更新します。
...et で更新するメッセージを指定します。
これには UID、UID の配列、もしくは
Range オブジェクトを渡します。
Net::IMAP#select で指定したメールボックスを対象とします。
attr で何をどのように変化させるかを指定します。
以......してください。
返り値は更新された内容を Net::IMAP::FetchData オブジェクトの
配列で返します。
@param set 更新するメッセージの UID
@param attr 更新方式(文字列)
@param flags 更新内容(Symbol の配列)
@see Net::IMAP#store, Net::IMAP#uid_fetch... -
Net
:: IMAP # uid _ thread(algorithm , search _ keys , charset) -> [Net :: IMAP :: ThreadMember] (18307.0) -
THREADコマンドを送り、メールボックスを検索した結果を スレッド形式の木構造で返します。
...り、メールボックスを検索した結果を
スレッド形式の木構造で返します。
ほぼ Net::IMAP#thread と同じですが、返ってくるオブジェクトの
Net::IMAP::ThreadMember#seqno の内容が message sequence number
ではなく UID となります。
@param algor......ithm スレッド構造構築アルゴリズム名(文字列)
@param search_key 検索条件(文字列配列)
@param charset 検索条件の解釈に用いるCHARSET名(文字列)
@see Net::IMAP::ThreadMember, Net::IMAP#thread... -
Net
:: IMAP # unsubscribe(mailbox) -> Net :: IMAP :: TaggedResponse (18307.0) -
UNSUBSCRIBE コマンドを送り、指定したメールボックスを "active" もしくは "subscribe" なメールボックスの集合から 削除します。
...be" なメールボックスの集合から
削除します。
@param mailbox 削除するするメールボックスの名前(文字列)
@raise Net::IMAP::NoResponseError 指定した名前のメールボックスを
削除できなかった場合に発生します。
指定した名... -
Net
:: IMAP # uid _ sort(sort _ keys , search _ keys , charset) -> [Integer] (9307.0) -
SORT コマンド送り、メールボックス内の メッセージをソートした結果を返します。
...します。
SORT コマンドは 5256 で定義されています。
詳しくはそちらを参照してください。
このコマンドは Net::IMAP#capability の返り値を見ることで
利用可能かどうか判断できます。
sort_keys にはソート順を決めるキーを文字......てください。
search_key には検索条件を渡します。Net::IMAP#search と
ほぼ同じです。この条件にマッチするメッセージのみがソートされます。
Net::IMAP#examine もしくは
Net::IMAP#select で指定したメールボックスを対象とします。... -
Net
:: IMAP # greeting -> Net :: IMAP :: UntaggedResponse (307.0) -
サーバから最初に送られてくるメッセージ(greeting message) を返します。
サーバから最初に送られてくるメッセージ(greeting message)
を返します。 -
Net
:: IMAP # login(user , password) -> Net :: IMAP :: TaggedResponse (307.0) -
LOGIN コマンドを送り、平文でパスワードを送りクライアント ユーザを認証します。
...LOGIN コマンドを送り、平文でパスワードを送りクライアント
ユーザを認証します。
Net::IMAP#authenticate で "LOGIN" を使うのとは異なる
ことに注意してください。authenticate では AUTHENTICATE コマンドを
送ります。
認証成功時には......認証成功レスポンスを返り値として返します。
認証失敗時には例外が発生します。
@param user ユーザ名文字列
@param password パスワード文字列
@raise Net::IMAP::NoResponseError 認証に失敗した場合に発生します
@see Net::IMAP#authenticate... -
Net
:: IMAP # setacl(mailbox , user , rights) (307.0) -
SETACL コマンドを送り、指定したメールボックスに 指定したユーザに関する権限を設定します。
SETACL コマンドを送り、指定したメールボックスに
指定したユーザに関する権限を設定します。
rights には設定する権限を表す文字列を指定します。
どのような文字列を指定すべきかは 2086 を参照してください。
rights に nil を渡すと、空文字列を指定したのと同様、つまり
すべての権限を削除します。
@param mailbox 権限を設定するメールボックスの名前(文字列)
@param user 権限を設定するユーザの名前(文字列)
@param rights 権限を表す文字列